Bulk Data Access

Oracle Health FHIR APIs with Bulk Data Access enable system applications to retrieve large amounts of core clinical data for groups of individuals in alignment with the standards referenced in the 21st Century Cures Act regulations.

FHIR Bulk Data export requests run asynchronously against an organization’s database. When integrating an Oracle Health AI Application Platform domain with a bulk data application, ensure that bulk export queries retrieve only the data required for the intended use case.

Export completion time varies based on factors such as the following examples:

  • Requested population size
  • Number of resource types requested
  • Requested time range
  • Network latency and the impact of concurrent system requests

Example Use Cases

  • Creation of an internal clinical data warehouse for study purposes
  • Machine learning applications that obtain training data from the electronic health record (EHR)
  • Integration of a population health system with an EHR system
  • Data transfer to a payer database for care quality assessment
  • Submission to reportable disease (or other) registries

Implemented Exports

Oracle Health currently supports the Group Export operation.

Note:

For the Group Export operation, Oracle Health supports v2.0.0 of the FHIR Bulk Data Access (Flat FHIR) Implementation Guide.

Service Root URL

The FHIR Bulk Data server uses the FHIR base URL as the service root URL.

Media Types

For file retrievals, application/fhir+ndjson is supported. All other requests support application/fhir+json.

Authorization

Bulk Data endpoints are secured using OAuth 2.0 and support SMART on FHIR applications. See the server metadata for security extensions on the Conformance.rest.security element.

For authorization procedures, see the Authorization Framework documentation.

Registering Client Applications

To access the Bulk Data Access API, register your SMART application and obtain authorization from the Oracle Health authorization server using the Authorization Framework and SMART developer documentation.

For Group Export, client application developers must coordinate with the healthcare organization to identify exportable groups. Organizations manage groups using FHIR Management Tooling.

Note:

  • Authentication is required. Unauthenticated (open) endpoints do not support Bulk Data Export workflows (for example, $export).
  • Consider performance and operational impact. Bulk Data operations run against an organization’s database and use the same underlying services that support other applications and user workloads. Because Bulk Data Export retrieves large amounts of data across large patient cohorts, export duration and resource consumption typically increase as dataset size and patient population grow.

Sandbox

Testing can be done in sandbox for applications that have authorization (for more information, see the Registering Client Applications section).