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

Get the status of the export job

get

/bulk-export/jobs/{Job_ID}

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.

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:

Request

Path Parameters
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.

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/bulk-export/jobs/<Job_ID>
Example Response: 
Status: 202 Accepted
X-Progress: in-progress
Retry-After: 600
Headers
  • A number representing the number of seconds the client should wait before polling this endpoint again.
  • Indicates the status of the export. Possible values are in-progress and completed.
  • 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

Example Request: 
GET https://<Service Root URL>/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://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/252a42c0-5844-11ec-bf63-0242ac130002/$export?_type=Patient,Observation",
  "requiresAccessToken": true,
  "output": [
    {
      "type": "Patient",
      "url": "https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130002"
    },
    {
      "type": "Patient",
      "url": "https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130003"
    },
    {
      "type": "Observation",
      "url": "https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130004"
    }
  ],
  "error": [
    {
      "type": "OperationOutcome",
      "url": "https://<Service Root URL>/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130005"
    }
  ]
}
Headers
Back to Top