Group Export
Overview
The Group Export operation is used to obtain FHIR resources for all members of a specified group of patients.
An export process uses the FHIR Asynchronous Request Pattern to kick off the export job for a group of patients. Once the export job is kicked off, the status of the job may be checked using the URL returned in the Content-Location
header from the kick off response. Once the job is complete, the status request returns a list of file URLs which may be called to download the content of the file. After the appropriate ndjson files are downloaded, the delete request should be called to clean up the no longer needed files.
The Group Export operation exports resources required for United States Core Data for Interoperability V1 (USCDI). For a full list of resources see the US Core Profiles. When the _type
parameter is used it returns only the FHIR resources specified. The _type
parameter should be used to filter the resources required for a specific use case. Limiting the number of requested resources in the _type
parameter is recommended as it can decrease response times.
Recommendations
- Use the
_type
parameter whenever possible to improve response time and minimize storage requirements._typeFilter
may also be used to further refine the results to be returned. - Use the
_since
parameter to limit the export to only the relevant date range. - Clients should follow an Exponential Backoff approach when polling for status as outlined in the FHIR Bulk Data Access IG.
- Files should be retrieved promptly as the exported content will expire after 30 days.
- Once the files have been retrieved, use the delete request to clean up the data from your request.
- Healthcare organizations may create groups containing up to 20,000 patients. However, the recommended group size for optimal performance is 10,000 patients or less.
Kick Off Request
Kicks off a bulk export request for a group of patients:
GET <FHIR Base>/Group/<group_id>/$export
Operation is defined at:
GET https://fhir-ehr-code.cerner.com/r4/OperationDefinition/group-export?_format=json
Implementation Notes
- Bulk data export requests do not currently honor the Accept-Language header; ‘en-US’ will be used.
- Only one bulk export request for a client application and tenant combination may be in-progress at a single time.
Authorization Types
Notes
- 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.
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_type |
No | string |
A string of comma-delimited FHIR resource types. Example: _type=Patient,Encounter,Location
|
_typeFilter |
No | string |
A string of comma-delimited FHIR Rest queries provided in combination with _type . Example: _typeFilter=Condition?clinical-status=active,Encounter?status=planned
|
_since |
No | instant |
Resources updated after this time will be included in the response. Example: 2021-03-18T19:19:42.000Z
|
includeAssociatedData |
No | string |
When provided, the group export will return or omit a pre-defined set of FHIR resources associated with the request. A string of comma-delimited values. Example: includeAssociatedData=LatestProvenanceResources
|
_outputFormat |
No | string |
The format for the requested bulk data files to be generated. Example: _outputFormat=application/ndjson
|
Notes
-
_type
valid values areAllergyIntolerance
,CarePlan
,CareTeam
,Condition
,Device
,DiagnosticReport
,DocumentReference
,Encounter
,Goal
,Immunization
,Location
,MedicationRequest
,Patient
,Procedure
,Observation
,Organization
,Practitioner
,Provenance
. - When the
_type
parameter contains a reference resource (Location
,Organization
,Practitioner
) or associated resource (Provenance
), at least one of the following resources must also be provided:AllergyIntolerance
,CarePlan
,CareTeam
,Condition
,Device
,DiagnosticReport
,DocumentReference
,Encounter
,Goal
,Immunization
,MedicationRequest
,Observation
,Patient
,Procedure
. - When the
_type
parameter is not provided, the resources to be exported will be determined by the scopes provided in the authorization token. - When the
_typeFilter
parameter is provided, the_type
parameter MUST be provided as well 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
. -
_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
. - Supplying
_typeFilter
with the same resource multiple times is not supported. -
includeAssociatedData
valid parameters areLatestProvenanceResources
andRelevantProvenanceResources
. -
_outputFormat
valid parameters areapplication/fhir+ndjson
,application/ndjson
,ndjson
. -
_outputFormat
defaults toapplication/fhir+ndjson
when not provided. - The following experimental parameters are not supported:
_elements
,patient
.
Provenance Behavior
- Provenances for
Location
,Organization
, andPractitioner
will not 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 will be exported by default. You MAY use theincludeAssociatedData
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 will be exported by default. - When both the
includeAssociatedData
parameter and the_type
parameter are provided, the_type
parameter MUST includeProvenance
.
Headers
Accept: application/fhir+json
Prefer: respond-async
Authorization: <OAuth2 Bearer Token>
Optional Header
Prefer: handling=lenient
When the Prefer: handling=lenient header is provided any unknown or unsupported parameters will be ignored as specified here.
Example
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/11ec-d16a-c763b73e-98e8-a31715e6a2bf/$export
Response
Status: 202 Accepted
Content-Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<job_id>
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned. Below are additional errors that may be returned:
HTTP Status | Cause | Severity | Code |
---|---|---|---|
400 |
includeAssociatedData , _outputFormat , _since , and _type contain invalid or unsupported values |
error | invalid |
400 | The resources provided in _typeFilter do not match the resources supplied in _type
|
error | invalid |
400 |
_typeFilter contains multiple queries for the same resource |
error | invalid |
400 | Unsupported parameters are passed to the export request | error | invalid |
422 |
_typeFilter is provided with an invalid or unsupported value |
error | invalid |
429 | There is already an export job in-progress for the client and tenant combination | error | throttled |
Status Request
Checks the status of the export job.
Use the URL returned in the Content-Location
header from the kick off request to retrieve the status of a bulk data export:
GET <URL from Content-Location header>
Notes
- Clients should follow an Exponential Backoff approach when polling for status as outlined in the bulk data export specification.
Authorization Types
Notes
- 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.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
In-Progress Response
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<job_id>
Response
Status: 202 Accepted
X-Progress: in-progress
Retry-After: 600
Complete Response
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<job_id>
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-code.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-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130002"
},
{
"type": "Patient",
"url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130003"
},
{
"type": "Observation",
"url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130004"
}
],
"error": [
{
"type": "OperationOutcome",
"url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/96295b8c-584e-11ec-bf63-0242ac130005"
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
File Retrieval Request
Once an export is complete, the status request will return file URLs which may be used to download the exported resources.
GET <File URL from status response>
Implementation Notes
- The file retrieval request returns a ‘307 Temporary Redirect’ with a ‘Location’ header, the Location header must be followed in order to download the file
- An exported ndjson file contains only a single resource type and there can be multiple files for the same resource type. There is no limit number of resources per file. An exported file has a max size of 50 MB when gzip compressed.
- Files should be retrieved promptly, as they will expire after 30 days.
- The initial file retrieval request requires the Authorization header to be sent; when following the re-direct, it is no longer appropriate. Ensure the Authorization header is not perpetuated.
Retrieval of Attachments
- Binary resources are not returned by bulk data operations.
- Attachment references must be retrieved separately using the Binary resource URL from the DocumentReference.content.attachment and DiagnosticReport.presentedForm fields from the export files.
Authorization Types
Notes
- The authorization token must contain the system read scope for the resource that the export file contains, and the client in the token must match the client that requested the export.
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+ndjson
Example
Request
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/files/<file_id>
Response
Status: 307 Temporary Redirect
Location: https://cerner-opensvc-bulkfhir-processed.s3.us-west-2.amazonaws.com
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example: Following the 307 Redirect
Request
GET https://cerner-opensvc-bulkfhir-processed.s3.us-west-2.amazonaws.com
Notes
- When following the re-direct link from the
Location
header, an Authorization header should NOT be set as the url is pre-signed. - Re-direct links are short-lived.
- Files are deleted 30 days after creation.
Response
Status: 200 OK
Content-Type: application/fhir+ndjson
{
"resourceType": "Patient",
"id": "12783127",
"meta": {
"versionId": "7",
"lastUpdated": "2022-07-01T20:12:56.000Z"
},
"text": {
"status": "extensions",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: FHIRONE, BULKDATAONE</p><p><b>Status</b>: Active</p><p><b>DOB</b>: Apr 18, 1988</p><p><b>Birth Sex</b>: Female</p><p><b>Administrative Gender</b>: Female</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"valueCode": "F",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"id": "CI-490689587-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2",
"display": "Community Medical Record Number",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "Community Medical Record Number"
},
"system": "urn:oid:2.16.840.1.113883.3.787.0.0",
"value": "490689587",
"_value": {
"extension": [
{
"valueString": "490689587",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689586-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "490689586",
"_value": {
"extension": [
{
"valueString": "00490689586",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689589-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"system": "urn:oid:2.16.840.1.113883.3.13.8",
"value": "FED810ECAD834ABC88E88F3223B3133D",
"_value": {
"extension": [
{
"valueString": "FED810ECAD834ABC88E88F3223B3133D",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:16.000Z"
}
},
{
"id": "CI-490689585-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"_value": {
"extension": [
{
"valueString": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:15.000Z"
}
},
{
"id": "CI-490689588-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236785",
"display": "MIllennium Person Identifier",
"userSelected": true
}
],
"text": "MIllennium Person Identifier"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "50946",
"_value": {
"extension": [
{
"valueString": "50946",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:07.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12783127-0",
"use": "official",
"text": "FHIRONE, BULKDATAONE",
"family": "FHIRONE",
"given": [
"BULKDATAONE"
],
"period": {
"start": "2022-03-08T17:07:03.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29913336-0",
"extension": [
{
"valueUrl": "(816)204-1030",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "8162041030",
"use": "work",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913334-1",
"extension": [
{
"valueUrl": "(913)224-2321",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132242321",
"use": "home",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913337-2",
"extension": [
{
"valueUrl": "(913)268-4302",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132684302",
"use": "mobile",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
}
],
"gender": "female",
"birthDate": "1988-04-18",
"address": [
{
"id": "CI-24415338-0",
"use": "home",
"text": "2804 S Elm Street\\nOverland Park, KS 66216\\nUS",
"line": [
"2804 S Elm Street"
],
"city": "Overland Park",
"district": "Johnson",
"state": "KS",
"postalCode": "66216",
"country": "US",
"period": {
"start": "2022-03-08T16:55:27.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351",
"code": "1153",
"display": "Family Member",
"userSelected": true
}
],
"text": "Family Member"
}
],
"name": {
"id": "CI-12800368-0",
"use": "official",
"text": "FHIRELEVEN, BULKDATAPEDIATRIC",
"family": "FHIRELEVEN",
"given": [
"BULKDATAPEDIATRIC"
],
"period": {
"start": "2022-07-01T20:12:56.000Z"
}
},
"telecom": [
{
"extension": [
{
"valueUrl": "(913)524-1874",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9135241874",
"use": "home",
"rank": 1,
"period": {
"start": "2022-07-01T20:12:56.000Z"
}
}
],
"address": {
"use": "home",
"text": "2804 S Elm Street\\nOverland Park, KS 66216\\nUS",
"line": [
"2804 S Elm Street"
],
"city": "Overland Park",
"district": "Johnson",
"state": "KS",
"postalCode": "66216",
"country": "US",
"period": {
"start": "2022-07-01T20:05:24.000Z"
}
},
"gender": "female",
"period": {
"start": "2022-07-01T20:12:56.000Z"
}
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490689630-0",
"reference": "Practitioner/3332086",
"display": "Cerner Test, Physician - Primary Care Eight Cerner"
}
]
}
{
"resourceType": "Patient",
"id": "12783128",
"meta": {
"versionId": "5",
"lastUpdated": "2022-05-27T20:32:48.000Z"
},
"text": {
"status": "extensions",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: FHIRTWO, BULKDATATWO</p><p><b>Status</b>: Active</p><p><b>DOB</b>: May 31, 1993</p><p><b>Birth Sex</b>: Female</p><p><b>Administrative Gender</b>: Male</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"valueCode": "F",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"id": "CI-490689642-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2",
"display": "Community Medical Record Number",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "Community Medical Record Number"
},
"system": "urn:oid:2.16.840.1.113883.3.787.0.0",
"value": "490689642",
"_value": {
"extension": [
{
"valueString": "490689642",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689641-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "490689641",
"_value": {
"extension": [
{
"valueString": "00490689641",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689644-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"system": "urn:oid:2.16.840.1.113883.3.13.8",
"value": "FED810ECAD834ABC88E88F3223B3133D",
"_value": {
"extension": [
{
"valueString": "FED810ECAD834ABC88E88F3223B3133D",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:16.000Z"
}
},
{
"id": "CI-490689640-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"_value": {
"extension": [
{
"valueString": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:15.000Z"
}
},
{
"id": "CI-490689643-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236785",
"display": "MIllennium Person Identifier",
"userSelected": true
}
],
"text": "MIllennium Person Identifier"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "50946",
"_value": {
"extension": [
{
"valueString": "50946",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:07.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12783128-0",
"use": "official",
"text": "FHIRTWO, BULKDATATWO",
"family": "FHIRTWO",
"given": [
"BULKDATATWO"
],
"period": {
"start": "2022-03-08T17:07:03.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29913344-0",
"extension": [
{
"valueUrl": "(816)204-1030",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "8162041030",
"use": "work",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913342-1",
"extension": [
{
"valueUrl": "(913)224-2321",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132242321",
"use": "home",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913345-2",
"extension": [
{
"valueUrl": "(913)268-4302",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132684302",
"use": "mobile",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
}
],
"gender": "male",
"birthDate": "1993-05-31",
"address": [
{
"id": "CI-24415346-0",
"use": "home",
"text": "2804 S Elm Street\\nOverland Park, KS 66216\\nUS",
"line": [
"2804 S Elm Street"
],
"city": "Overland Park",
"district": "Johnson",
"state": "KS",
"postalCode": "66216",
"country": "US",
"period": {
"start": "2022-03-08T16:55:27.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490689685-0",
"reference": "Practitioner/3332086",
"display": "Cerner Test, Physician - Primary Care Eight Cerner"
}
]
}
{
"resourceType": "Patient",
"id": "12783129",
"meta": {
"versionId": "5",
"lastUpdated": "2022-05-27T20:33:37.000Z"
},
"text": {
"status": "extensions",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Patient</b></p><p><b>Name</b>: FHIRTHREE, BULKDATATHREE</p><p><b>Status</b>: Active</p><p><b>DOB</b>: May 22, 1978</p><p><b>Birth Sex</b>: Female</p><p><b>Administrative Gender</b>: Female</p><p><b>Marital Status</b>: Married</p></div>"
},
"extension": [
{
"valueCode": "F",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "White",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
},
"url": "ombCategory"
},
{
"valueString": "Not Hispanic, Latino, or Spanish Origin",
"url": "text"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"id": "CI-490689697-0",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2",
"display": "Community Medical Record Number",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "Community Medical Record Number"
},
"system": "urn:oid:2.16.840.1.113883.3.787.0.0",
"value": "490689697",
"_value": {
"extension": [
{
"valueString": "490689697",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689696-1",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "10",
"display": "MRN",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.6.1000",
"value": "490689696",
"_value": {
"extension": [
{
"valueString": "00490689696",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-490689699-3",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "670843",
"display": "Messaging",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "U",
"display": "Unspecified identifier",
"userSelected": false
}
],
"text": "Messaging"
},
"system": "urn:oid:2.16.840.1.113883.3.13.8",
"value": "FED810ECAD834ABC88E88F3223B3133D",
"_value": {
"extension": [
{
"valueString": "FED810ECAD834ABC88E88F3223B3133D",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:16.000Z"
}
},
{
"id": "CI-490689695-4",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236771",
"display": "Federated Person Principal",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "AN",
"display": "Account number",
"userSelected": false
}
],
"text": "Federated Person Principal"
},
"system": "urn:oid:2.16.840.1.113883.3.13.6",
"value": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"_value": {
"extension": [
{
"valueString": "URN:CERNER:IDENTITY-FEDERATION:REALM:EC2458F2-1E24-41C8-B71B-0E701AF7583D-CH:PRINCIPAL:SN7HR6J27QX8WM5H",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:14:15.000Z"
}
},
{
"id": "CI-490689698-5",
"use": "usual",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4",
"code": "2553236785",
"display": "MIllennium Person Identifier",
"userSelected": true
}
],
"text": "MIllennium Person Identifier"
},
"_system": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
},
"value": "50946",
"_value": {
"extension": [
{
"valueString": "50946",
"url": "http://hl7.org/fhir/StructureDefinition/rendered-value"
}
]
},
"period": {
"start": "2022-03-08T17:07:07.000Z"
}
}
],
"active": true,
"name": [
{
"id": "CI-12783129-0",
"use": "official",
"text": "FHIRTHREE, BULKDATATHREE",
"family": "FHIRTHREE",
"given": [
"BULKDATATHREE"
],
"period": {
"start": "2022-03-08T17:07:03.000Z"
}
}
],
"telecom": [
{
"id": "CI-PH-29913352-0",
"extension": [
{
"valueUrl": "(816)204-1030",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "8162041030",
"use": "work",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913350-1",
"extension": [
{
"valueUrl": "(913)224-2321",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132242321",
"use": "home",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
},
{
"id": "CI-PH-29913353-2",
"extension": [
{
"valueUrl": "(913)268-4302",
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address"
}
],
"system": "phone",
"value": "9132684302",
"use": "mobile",
"rank": 1,
"period": {
"start": "2022-03-08T17:07:02.000Z"
}
}
],
"gender": "female",
"birthDate": "1978-05-22",
"address": [
{
"id": "CI-24415354-0",
"use": "home",
"text": "2804 S Elm Street\\nOverland Park, KS 66216\\nUS",
"line": [
"2804 S Elm Street"
],
"city": "Overland Park",
"district": "Johnson",
"state": "KS",
"postalCode": "66216",
"country": "US",
"period": {
"start": "2022-03-08T16:55:27.000Z"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/38",
"code": "309237",
"display": "Married",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married",
"userSelected": false
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36",
"code": "151",
"display": "English",
"userSelected": true
},
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
],
"generalPractitioner": [
{
"id": "CI-490689740-0",
"reference": "Practitioner/3332086",
"display": "Cerner Test, Physician - Primary Care Eight Cerner"
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Delete Request
Use the URL returned in the Content-Location
header from the kick off request to delete a bulk data export job (whether it’s in-progress or complete) and any associated files:
DELETE <URL from Content-Location header>
Authorization Types
Notes
- 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.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
DELETE https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/bulk-export/jobs/<job_id>
Response
Status: 202 Accepted
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Testing in sandbox
In order to call bulk data endpoints in sandbox, you will need to kick off a group export using one of the group ids listed below and then perform the subsequent requests.
- Group with 3 patients:
11ec-d16a-c763b73e-98e8-a31715e6a2bf
- Group with 10 patients:
11ec-d16a-b40370f8-9d31-577f11a339c5
Example
GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Group/11ec-d16a-c763b73e-98e8-a31715e6a2bf/$export?_type=Patient