Bulk Export REST Endpoints

Sort by

Task Path Method

Description

Bulk Export

The following topic describes the Group Export operation.

Group Export

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Bulk Data Export functionality focuses on the Group Export operation. Use the Group Export operation to obtain FHIR resources for all members of a specified group of patients.

The Group Export operation exports resources required for United States Core Data for Interoperability V1 (USCDI) for all members of a specified group of patients. For a full list of resources, see the US Core Profiles.

When you use the _type parameter, the API returns only the FHIR resources specified. Use the _type parameter to filter the resources required for a specific use case. Oracle recommends limiting the number of requested resources in the _type parameter to decrease response times.

The Group Export process uses the FHIR Asynchronous Request Pattern to kick off the export job for a group of patients. Once the export job is kicked off, you can check the status of the job using the URL returned in the Content-Location header from the kick-off response. Once the job is complete, the status request returns a list of file URLs that may be requested to download the content of the file. After the appropriate ndjson files are downloaded, use the delete request to clean up the files that are no longer needed.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Recommendations

• Use the _type parameter whenever possible to improve response times and minimize storage requirements.
• Use the _since parameter to limit the export to only the relevant date range.
• Customers should follow an Exponential Backoff approach when polling for status as outlined in the FHIR Bulk Data Access Implementation Guide.
• Retrieve files promptly because the exported content expires after 30 days.
• Once the files are retrieved, use the delete request to clean up the data from your request.

Example

GET https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/11ec-d16a-c763b73e-98e8-a31715e6a2bf/$export?_type=Patient

Bulk Export

The operations from the Bulk Export category.

Delete a bulk data export job

Method: delete

Path: /bulk-export/jobs/{Job_ID}

Get file URLs to download the exported resources

Method: get

Path: /bulk-export/files/{File_ID}

Get the status of the export job

Method: get

Path: /bulk-export/jobs/{Job_ID}

Kick off a bulk export request for a group of patients

Method: get

Path: /Group/{Group_ID}/$export