Skip to content

Bulk Data

Jonathan Percival edited this page Mar 1, 2022 · 4 revisions

The Bulk Data Export API provides a way to asynchronously request large caches of data from a FHIR server.

Usage

The bulk data export API has the following steps:

  1. Kick-off Request initiates an asynchronous process to generate the requested set of data.

  2. Status Request provides a mechanism for the user to poll the server's status.

  3. File Request is handled by selecting the links provided in the Complete Status response body, which will download the exported data.

To export data for all patients: {base}/Patient/$export

To export data for a group of patients: {base}/Group/{id}/$export

TODO: Link to test in test suite repo once finished

Clone this wiki locally