1. FHIR R4 APIs with Bulk Data Access
  2. Tasks
  3. Bulk Export

Kick off a bulk export request for a group of patients

get

/Group/{Group_ID}/$export

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

The operation is defined at:

GET https://<Service Root URL>/r4/OperationDefinition/group-export?_format=json

Note:

  • Bulk data export requests do not currently recognize the Accept-Language header; en-US is used instead.
  • The authorization token must contain system read scopes for all resources requested in the _type parameter.
  • The following experimental parameters are not supported: _elements, _typeFilter, and patient.
  • When both the includeAssociatedData parameter and the _type parameter are provided, the _type parameter must include Provenance.

Provenance Behavior

  • Provenances for the Location, Organization, and Practitioner resources cannot be exported.
  • When the _type parameter is not provided and the authorization token includes the Provenance read scope, all relevant Provenance resources associated with each of the non-Provenance resources are exported by default. You may use the includeAssociatedData parameter to export only the latest provenance.
  • When the _type parameter is provided with specific resources and includes Provenance, all relevant Provenance resources associated with each of the non-Provenance resources are exported by default.

Optional Header

When the Prefer: handling=lenient header is provided, any unknown or unsupported parameters are ignored as specified in the Bulk Data Export query parameters.

Request

Path Parameters
Query Parameters
  • The format for the requested bulk data files to be generated. Valid parameters are application/fhir+ndjson, application/ndjson, and ndjson. Defaults to application/fhir+ndjson when not provided.
    Example: _outputFormat=application/ndjson
  • Resources updated after this time are included in the response.
    Example: 2021-03-18T19:19:42.000Z
  • A string of comma-delimited FHIR resource types.
    • The following values are valid:
      • AllergyIntolerance
      • CarePlan
      • CareTeam
      • Condition
      • Coverage
      • Device
      • DiagnosticReport
      • DocumentReference
      • Encounter
      • Goal
      • Immunization
      • Location
      • MedicationDispense
      • MedicationRequest
      • Patient
      • Procedure
      • Observation
      • Organization
      • Practitioner
      • Provenance
      • RelatedPerson
      • ServiceRequest
      • Specimen
    • When the _type parameter contains a reference resource (Location, Organization, Practitioner, RelatedPerson, or Specimen) or an associated resource (Provenance), at least one of the following resources must also be provided:
      • AllergyIntolerance
      • CarePlan
      • CareTeam
      • Condition
      • Coverage
      • Device
      • DiagnosticReport
      • DocumentReference
      • Encounter
      • Goal
      • Immunization
      • MedicationDispense
      • MedicationRequest
      • Observation
      • Patient
      • Procedure
      • ServiceRequest
    • When the _type parameter is not provided, the resources to be exported are determined by the scopes provided in the authorization token.
    Example: _type=Patient,Encounter,Location
Header Parameters

  • The media type to be requested. Refer to what the resource's operation produces for what is supported.

    Example: application/fhir+json

  • Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
  • Specifies whether the response is immediate or asynchronous. respond-async is supported. A client must provide this header.

There's no request body for this operation.

Back to Top

Response

Default Response

Example Request: 
GET https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/11ec-d16a-c763b73e-98e8-a31715e6a2bf/$export
Example Response: 
Status: 202 Accepted
Content-Location: https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<Job_ID>
Headers
  • Indicates the url to access the status of the export request.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-request-id, if present.
Back to Top