Check bulk export status
Poll the status URL returned by a system, Patient, or Group export request. This endpoint reports export completion and, when complete, returns the manifest with download links.
| Method | Path |
|---|---|
GET | /fhir/R4/bulkdata/export/:id |
Request
Use the ID from the export operation's Content-Location URL.
curl --include \
--url "https://api.sandbox.ovok.com/fhir/R4/bulkdata/export/${EXPORT_ID}" \
--header "Authorization: Bearer ${OVOK_TOKEN}"
| Path value | Description |
|---|---|
:id | ID from the returned bulk export status URL. |
While the export is running
The server returns 202 Accepted with an empty body. Poll the same URL again after a short delay.
Completed manifest
When the export completes, the server returns 200 OK with a JSON manifest.
| Manifest field | Example | Description |
|---|---|---|
transactionTime | <ISO-8601 timestamp> | Time associated with the export snapshot. |
request | https://api.sandbox.ovok.com/fhir/R4/Patient/$export | Original export request URL. |
requiresAccessToken | false | Whether file downloads require authorization. Ovok returns presigned download URLs and sets this to false. |
output[] | type: Patient, url: <download-url> | Generated files, each with a FHIR resource type and download URL. |
error[] | Empty when successful | Export errors reported in the manifest. |
deleted[] | Empty when none | Deleted-resource records, when present. |
The returned file URLs are presigned; download each file directly and consume it as newline-delimited FHIR JSON (application/fhir+ndjson). A cancelled export returns 404 Not Found.