Get a list of output files
get
/Export/FileRequest
As mentioned in previous sections, the status response for a completed request includes a list of output file URLs and if applicable, a list of OperationOutcome URLs. The client application may now download these files using these URLs.
Request
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
Response
Supported Media Types
- application/fhir+json
Default Response
Example
Request
GET https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/bulk-api/request/173a39fc-a2c3-4df2-ae41-5445240f3612
Where the URLs point to the download location.Note that a valid access token must be supplied with the download request. The most recently obtained access token can be used if it is unexpired. Otherwise, a new access token must be obtained using the refresh token. See Authorization for details.
Response
{
"transactionTime": "2022-05-10T03:17:51Z",
"request": "https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/bulk-api/request/Group/All_Patients/$export?_type=Goal,Patient,Procedure",
"requiresAccessToken": "true",
"output": [
{
"type": "Patient",
"url": "https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/bulk-api/download/173a39fc-a2c3-4df2-ae41-5445240f3612/2A168AB6-7F5E-4BDC-BD53-F5911FF82D68_Patient.ndjson"
},
{
"type": "Goal",
"url": "https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/bulk-api/download/173a39fc-a2c3-4df2-ae41-5445240f3612/FCCC3692-4A03-4DA1-8BB3-8BD62E20C75C_Goal.ndjson"
}
],
"error": [
]
}
Errors
The following common errors and OperationOutcomes may be returned from the file request:HTTP Status | Cause | Severity | Code |
---|---|---|---|
403 | The expected scope does not match the URL. | error | Security |
404 | The Population Application is not defined or not active. | error | not-found |
404 | The Request ID was not found. | error | not-found |
404 | This request was previously canceled or has expired. | error | deleted |
404 | The file was not found. | error | not-found |
406 | The Bulk Data Server rejected this Status Request operation due to an invalid Accept header. | error | structure |
Headers
-
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.