Export system data
Start a project-wide bulk export. The server creates newline-delimited FHIR JSON files asynchronously and returns a status URL. In this API, “system” means the resources available to the authenticated project, not data across all Ovok tenants.
| Method | Path |
|---|---|
GET | /fhir/R4/$export |
Request
Use _type to limit the exported resource types and _since to request resources updated from a point in time. The current implementation produces FHIR NDJSON files.
curl --get --include 'https://api.sandbox.ovok.com/fhir/R4/$export' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Accept: application/fhir+json' \
--header 'Prefer: respond-async' \
--data-urlencode '_type=Patient,Observation' \
--data-urlencode '_since=2026-01-01T00:00:00Z'
| Parameter or header | Required | Description |
|---|---|---|
_type | No | Comma-separated resource types to include. Omit to request all exportable types available to the caller. |
_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. Use the Content-Location header to check export status.
| Header | Description |
|---|---|
Content-Location | URL for the export status manifest, usually /fhir/R4/bulkdata/export/:id. |
Retry-After | The server may provide a suggested polling interval. |
Follow the status URL until it returns 200 OK; while work is running it returns 202 Accepted. See Check bulk export status.
The current sandbox CapabilityStatement advertises Group-level $export; check /fhir/R4/metadata for the operations advertised by your environment. The FHIR Bulk Data Export specification defines the standard export workflow.