Get bulk data for patients
/Export/KickoffRequest
Soarian Clinical supports two endpoints for bulk data requests: one for all patients and another for a specific group of patients. To retrieve information related to all patients in the Electronic Health Record (EHR), access the following endpoint:
GET [fhir base]/Patient/$export?:parameters
To retrieve information related to a specific group of patients in the EHR, access the following endpoint:
GET [fhir base]/Group/[id]/$export?:parameters
This operation supports the System authorization type.
NotesBe aware that a request for all patients??? data has the potential to consume a significant amount of system resources for a long time. Cerner strongly recommends that implementers retrieve information for specific groups of patients, rather than all patients. If you access the All Patients endpoint, consider using parameters to limit the amount of data returned. Depending upon the hospital???s policies and configuration, the ability to return data on all patients may be limited or disallowed. The availability of system resources (for example, file space) may also limit responses to requests for all patients (or any query that is too broad).
Request
-
_outputFormat: string
The format for the requested bulk data files to be generated as per FHIR Asynchronous Request Pattern. Defaults to application/fhir+ndjson. Soarian Clinicals accepts application/fhir+ndjson as well as the abbreviated representations application/ndjson and ndjson.
Type: string._outputFormat
valid parameters areapplication/fhir+ndjson
,application/ndjson
, andndjson
._outputFormat
defaults toapplication/fhir+ndjson
. -
_since: string
The response includes resources if their state changed after the supplied time (for example, if Resource.meta.lastUpdated is later than the supplied_since time).
Type: FHIR instant. -
_type: string
Only resources of the specified resource types are included in the response. If this parameter is omitted, Soarian Clinicals returns all supported resources in the scope of the client application authorization.
Type: String of comma-delimited FHIR resource types._type
valid parameters areAllergyIntolerance
,CarePlan
,CareTeam
,Condition
,Device
,DiagnosticReport
,DocumentReference
,Encounter
,Goal
,Immunization
,Location
,MedicationRequest
,Patient
,Procedure
,Observation
,Organization
,Practitioner
, andProvenance
.
When the_type
parameter contains a reference resource (Location
,Organization
,Practitioner
, orProvenance
), at least one of the following clinical resources must also be provided:AllergyIntolerance
,CarePlan
,CareTeam
,Condition
,Device
,DiagnosticReport
,DocumentReference
,Encounter
,Goal
,Immunization
,MedicationRequest
,Observation
,Patient
, orProcedure
._type
parameter defaults to the scopes provided in the provided authorization token when not provided.
-
Accept(required): string
The media type to be requested. Refer to 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
Valued as
respond-async
Response
- application/fhir+json
Default Response
Example Request
GET https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Group/All_Patients/$export?_outputFormat=ndjson&_since=2020-05-10T07:12:33.058Z&_type=Patient
Example Response:
A successful response includes the following items:- HTTP Status Code 202 Accepted.
- Content-Location header with the absolute URL of an endpoint for subsequent status requests (polling location).
- FHIR OperationOutcome resource in the body.
{
"resourceType": "OperationOutcome",
"id": "3f6bd10f-8fa4-4606-aa4e-a408844fa965",
"issue": [
{
"severity": "information",
"code": "STRUCTURE",
"details": {
"text": "Request accepted, but resource(s) {Binary} in _type parameter is\n\t\t\t\t\tsupported as contained and will not generate resource specific output file(s)"
}
}
]
}
Errors
The following common errors and OperationOutcomes may be returned in response to the export request:HTTP Status | Cause | Severity | Code |
---|---|---|---|
400 | Badly formed URL. | error | structure |
400 | The _outputFormat parameter or _since parameter contains an Invalid or unsupported value. | error | invalid |
400 | The resources in _type parameter are not supported standalone. | error | not-supported |
403 | The expected scope does not match the URL. | error | Security |
404 | The Population Application or Population Group is not defined or not active. | error | not-found |
404 | The Population Group is not assigned to a Population Application. | error | not-found |
404 | The Stored Procedure assigned to the Population Group with group ID was not found. | error | not-found |
404 | The resources in the _type parameter are not supported. | error | not-supported |
404 | The Population Application is not configured to use the Bulk Data Patient Export. | error | not-found |
406 | The Bulk Data Server rejected an export operation with an invalid Accept or Prefer header. | error | Structure |
409 | The Population Application sent a duplicate request that uses the same values in the _since and in _type parameters. | error | duplicate |
501 | The FHIR operation for Patient Export is not currently enabled in this server environment due to volume and traffic considerations. Contact the institution with inquiries or modify your request to perform a Group Export. | error | not-found |
-
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.