Initiate bulk request
GET /bulk/Group/{id}/$export
Initiate the group export of patients defined by group {id}
Parameters:
Name Type Description
id string Group id
Example:
/bulk/Group/20/$export
Initiate the bulk export of the group with id 20
Responses:
200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Check status of bulk request
/bulk/$export-status/{bulk-export-id}
Read the status of the bulk export by the id {bulk-export-id}
Parameters:
Name Type Description
id string Bulk id
Example:
/bulk/$export-status/abc20
Read the export status of the bulk export by id abc20
Responses:
Incomplete Status: HTTP Status Code of 202 Accepted
Headers:
X-Progress: "50% complete"
Retry-After: 120
Receive bulk request completion response
/bulk/$export-status/{bulk-export-id}
Recceive the completion status of the bulk export by the id {bulk-export-id}
Parameters:
Name Type Description
id string Bulk id
Example:
/bulk/$export-status/abc20
Read the export status of the bulk export by id abc20
Responses:
Complete Status: HTTP status of 200 OK and Content-Type header of application/json
The JSON object of Complete Status is according to the FHIR specification: https://www.hl7.org/fhir/
Delete bulk request
DELETE [polling content location]
Delete the bulk request represented by the url [polling content location]
Parameters (via HTTP header):
Name Type Description
[polling content location] string The location representing the bulk request to be deleted
Example:
DELETE /bulk/$export-status/abc20
Delete the bulk request for the export by id abc20
Responses:
Status HTTP 202 Accepted