Export Patient data
Start a bulk export for Patient data. The export includes Patient-compartment resource types supported by the server and can be restricted by resource type or last-updated time.
| Method | Path |
|---|---|
GET | /fhir/R4/Patient/$export |
Request
curl --get --include 'https://api.sandbox.ovok.com/fhir/R4/Patient/$export' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Accept: application/fhir+json' \
--header 'Prefer: respond-async' \
--data-urlencode '_type=Patient,Observation,Encounter' \
--data-urlencode '_since=2026-01-01T00:00:00Z'
| Parameter or header | Required | Description |
|---|---|---|
_type | No | Comma-separated resource types to include from the supported Patient export set. |
_since | No | ISO 8601 instant; include resources updated at or after this time. |
Accept | Recommended | Request FHIR JSON for an error outcome. |
Prefer | Recommended | Use respond-async for the asynchronous workflow. |
Accepted response
The server responds with 202 Accepted. The Content-Location header points to the export status manifest. Poll that URL until it returns 200 OK, then download the files listed in its output array.
| Response header or field | Description |
|---|---|
Content-Location | Bulk export status URL. |
output[].type | FHIR resource type stored in the corresponding file. |
output[].url | Download URL for the generated NDJSON file. |
See Check bulk export status for the manifest fields and polling behavior. Refer to the FHIR Bulk Data Export specification for the Patient-level export pattern.