Get a document as authenticated user
GET
/document/{id}dev
https://api.sandbox.ovok.comFile download
Information such as id, contentType, fileName can be fetched by querying /fhir/DocumentReference.
Parameters
| Parameter | In | Description | Example |
|---|---|---|---|
id | params | The DocumentReference id of the file resource | c3499c27-2973-0a7f-807e-fb8676a92dcb |
width | query | The width of the image to resize the image to (optional) | 100 |
height | query | The height of the image to resize the image to (optional) | 100 |
fit | query | The fit of the image to resize the image to (optional) See | cover |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | FHIR DocumentReference id of the file to download. The response is a 307 redirect to a short-lived signed URL. |
ETag | header | string | no | The ETag of the file for GET requests. If provided, the server will check the value of the ETag against the value of the ETag in the request headers. If the values match, the server will return a 304 Not Modified response. If the values do not match, the server will return a 200 OK response and the file content, if the file exists. |
width | query | string | no | The width of the binary resource if the resource is an image. |
height | query | string | no | The height of the binary resource if the resource is an image. |
fit | query | string | no | The fit of the image. See https://sharp.pixelplumbing.com/api-resize#fit for more information. |
Responses
| Code | Description |
|---|---|
200 | Success. |
400 | The request could not be operated by the server. |
401 | The resource owner or authorization server denied the request. |
404 | The requested resource could not be found. |
422 | The request could not be validated by the server. |
500 | The server encountered an unexpected condition. Please try again later. |
200 → RedirectResponseDto (application/json)
No JSON body — endpoint replies with HTTP 307 redirect to a short-lived signed object-storage URL. Body is empty; follow the Location header. The redirect target expires (typical TTL: a few minutes).
Additional properties allowed.