Jump to

• Request
• Response

Kick off a bulk export request for a group of patients

get

/Group/{Group_ID}/$export

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.

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: _typeFilter, _elements, includeAssociatedData, and patient.

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.
• 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.

Request

Path Parameters

• Group_ID(required):
  The logical resource ID.

Query Parameters

• _outputFormat:
• _since:
• _type:

Header Parameters

• Accept(required):

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

  Example: application/fhir+json

• Authorization(required):
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
• Prefer(required):
  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

• Content-Location: string
  Indicates the url to access the status of the export request.
• opc-request-id: string
  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