Jump to

• Request
• Response

Kick off a bulk export request for a group of patients

get

/Group/{Group_ID}/$export

The operation is defined at:

GET https://fhir-ehr.cerner.com/r4/OperationDefinition/group-export?_format=json

Note:

• Bulk data export requests do not currently recognize the Accept-Language header; en-US is used instead.
• Only one bulk export request for a client application and tenant combination may be in-progress at a single time.
• The authorization token does not require the Group.read scope.
• The authorization token must contain system read scopes for all resources requested in the _type parameter.
• The following experimental parameters are not supported: _elements 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. 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.
• When both the includeAssociatedData parameter and the _type parameter are provided, the _type parameter must include Provenance.

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

• Group_ID(required): string
  The logical resource ID.

Query Parameters

• _outputFormat: string
  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
• _since: string
  Resources updated after this time are included in the response.
  Example: 2021-03-18T19:19:42.000Z
• _type: string
  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
• _typeFilter: string
  A string of comma-delimited FHIR REST queries provided in combination with _type.

  • When the _typeFilter parameter is provided, the _type parameter must be provided and must only have queries for the resources provided in _type.
  • _typeFilter does not support queries for the following resources:
    • Location
    • Organization
    • Patient
    • Practitioner
    • Provenance
    • RelatedPerson
    • Specimen
  • _typeFilter supports queries with the search parameters supported for the R4 resources with the exception of the following search parameters:
    • _count
    • _contained
    • _containedType
    • _elements
    • _id
    • _include
    • _lastUpdated
    • _revinclude
    • _sort
    • _summary
    • _total
    • encounter
    • identifier
    • patient
    • subject
    • date
  • Supplying _typeFilter with the same resource multiple times is not supported.

  Example: _typeFilter=Condition?clinical-status=active,Encounter?status=planned
• includeAssociatedData: string
  When provided, the group export returns or omits a predefined set of FHIR resources associated with the request. A string of comma-delimited values. Valid parameters are LatestProvenanceResources and RelevantProvenanceResources.
  Example: includeAssociatedData=LatestProvenanceResources

Header Parameters

• Accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.
• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
• Prefer(required): string
  Specifies whether the response is immediate or asynchronous. respond-async is supported. A client must provide this header.

Back to Top

Response

Supported Media Types

• application/fhir+json

Default Response

This operation supports the System authorization type.
Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/11ec-d16a-c763b73e-98e8-a31715e6a2bf/$export

Example Response:

Status: 202 Accepted
Content-Location: https://fhir-ehr.cerner.com/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.
• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• 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