Jump to

• Request
• Response

Get the status of the export job

get

/bulk-export/jobs/{Job_ID}

Use the URL returned in the Content-Location header from the kick-off request to retrieve the status of a bulk data export. See the example response for the group export operation.

Note:

• Follow an exponential backoff approach when polling for the status as outlined in the bulk data export specification.
• Scopes are not checked in this request. The authorization token must be valid, and the client in the token must match the client that requested the export.

Request

Path Parameters

• Job_ID(required): string
  The logical resource ID associated with the resource.

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.

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/bulk-export/jobs/<Job_ID>

Example Response:

Status: 202 Accepted
X-Progress: in-progress
Retry-After: 600

Headers

• Retry-After: integer
  A number representing the number of seconds the client should wait before polling this endpoint again.
• X-Progress: string
  Indicates the status of the export. Possible values are in-progress and completed.
• 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.

x-complete Response

This operation supports the System authorization type.
Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<Job_ID>

Example Response:

Status: 200 OK
Expires: Mon, 22 Jul 2025 23:59:59 GMT
Content-Type: application/json

{
  "transactionTime": "2022-01-04T17:42:25.000Z",
  "request": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/252a42c0-5844-11ec-bf63-0242ac130002/$export?_type=Patient,Observation",
  "requiresAccessToken": true,
  "output": [
    {
      "type": "Patient",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130002"
    },
    {
      "type": "Patient",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130003"
    },
    {
      "type": "Observation",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130004"
    }
  ],
  "error": [
    {
      "type": "OperationOutcome",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130005"
    }
  ]
}

Headers

• Content-Type: string
  Indicates the media type of the response body.
• Expires: string
  Specifies when the exported files will become expired.
• 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