Export Group data
Start an asynchronous export for the members of a stored FHIR Group. Patient members contribute supported Patient-compartment resources; other readable member resources can also be included.
| Method | Path |
|---|---|
GET | /fhir/R4/Group/:id/$export |
Request
curl --get --include "https://api.sandbox.ovok.com/fhir/R4/Group/${GROUP_ID}/\$export" \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Accept: application/fhir+json' \
--header 'Prefer: respond-async' \
--data-urlencode '_type=Patient,Observation,Condition' \
--data-urlencode '_since=2026-01-01T00:00:00Z'
| Parameter or header | Required | Description |
|---|---|---|
:id | Yes | ID of the FHIR Group whose members define the export scope. |
_type | No | Comma-separated resource types to include. |
_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 and a Content-Location status URL. Poll the URL until it returns 200 OK; the completed manifest lists NDJSON files by resource type.
| Response part | Description |
|---|---|
Content-Location | URL to poll for completion. |
output[].type | Resource type in the output file. |
output[].url | Download URL for the output file. |
An unknown or inaccessible Group is rejected before export begins. See Check bulk export status for the manifest format. The FHIR Bulk Data Group export definition describes the standard operation.