DocumentReference
Overview
The DocumentReference resource is used to reference a clinical document for a patient within the health system. This resource supports reading Continuity of Care Documents (CCD), returning a list of clinical documents, and a reference to retrieve a document as a PDF.
The following fields are returned if valued for clinical documents:
- DocumentReference id
- Status
- Document status
- Document type
- Document category
- Subject (Patient)
- Created Date
- Author
- Authenticator/verifying provider
- Document description/title
- Document Attachment
- Patient encounter
- Document period
Terminology Bindings
DocumentReference.status |
|
DocumentReference.docStatus |
|
DocumentReference.type |
|
DocumentReference.category |
|
Search
Search for DocumentReferences that meet supplied query parameters:
GET /DocumentReference?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This, or patient
|
token |
The logical resource id associated with the resource. Example: 12345
|
patient |
This, or _id
|
reference |
The specific patient to return DocumentReferences for. Example: 12345
|
encounter |
N | reference |
The Encounter in which the document was created. May be a list separated by commas. Example: 123,456
|
period |
N | date |
Time of service that is being documented. Must use the ge and lt prefixes. Example: lt2017-01-5
|
type |
N | token |
The type of document. May be a list separated by commas. Example: http://loinc.org|11488-4
|
_count |
N | number |
The maximum number of results to include in a page. Example: 50
|
category |
N | token |
The categorization of document. Example: http://loinc.org|11488-4
|
_revinclude |
N | token |
Provenance resource entries to be returned as part of the bundle. Example: _revinclude=Provenance:target
|
Implementation Notes
- When searching with the
period
parameter:- It must be provided twice, once with the
ge
prefix, and once with thelt
prefix. - If one
period
parameter includes a time, both must include a time.
- It must be provided twice, once with the
- When searching with the
encounter
parameter:- Patient level documents are filtered out from responses when the encounter id is zero/blank.
-
The
_revinclude
parameter may be provided once with the valueProvenance:target
. Example:_revinclude=Provenance:target
-
The
_revinclude
parameter may be provided with the_id/patient
parameter. Example:_id=214938095&_revinclude=Provenance:target
- When
_revinclude
is provided in a request to the closed endpoint, the OAuth2 token must include theuser/Provenance.read
scope. Currentlypatient/Provenance.read
is not supported and hence_revinclude
cannot be utilised for patient persona.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=2798003
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "271fc608-6a12-48f3-a9f8-2d1bfe395328",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=2798003"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21961261",
"resource": {
"resourceType": "DocumentReference",
"id": "21961261",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-12T22:35:03.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Admission Note-Physician</p><p><b>Document Category</b>: Clinical Note</p><p><b>Document Title</b>: Admission H & P</p><p><b>Service End Date</b>: Mar 12, 2021 4:31 P.M. CST</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Braus, Sasha</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21961261-2021031216350400"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820507",
"display": "Admission Note-Physician",
"userSelected": true
},
{
"system": "http://loinc.org",
"code": "83805-2",
"userSelected": false
}
],
"text": "Admission Note-Physician"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note",
"userSelected": false
}
],
"text": "Clinical Note"
},
{
"coding": [
{
"system": "http://loinc.org",
"code": "83805-2",
"userSelected": false
}
]
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"authenticator": {
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
},
{
"attachment": {
"contentType": "text/html",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-12T22:31:38.000Z"
}
}
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21674656",
"resource": {
"resourceType": "DocumentReference",
"id": "21674656",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-05T16:48:42.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Abdominal Ultrasound</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: test images</p><p><b>Service End Date</b>: Mar 5, 2021 10:47 A.M. CST</p><p><b>Document Status</b>: Preliminary</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21674656-2021030510484300"
}
],
"status": "current",
"docStatus": "preliminary",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820643",
"display": "Abdominal Ultrasound",
"userSelected": true
},
{
"system": "http://loinc.org",
"_code": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
}
],
"text": "Abdominal Ultrasound"
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-20801159",
"title": "Admission H & P",
"creation": "2021-02-10T23:27:20.000Z"
}
},
{
"attachment": {
"contentType": "text/html",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-20801159",
"title": "Admission H & P",
"creation": "2021-02-10T23:27:20.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-05T16:47:00.000Z"
}
}
}
}
]
}
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 with RevInclude
Authorization Types
Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?_id=214938095&_revinclude=Provenance:target
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "11d98db4-e637-4586-af8f-f7256ec5539b",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?_id=214938095&_revinclude=Provenance%3Atarget"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/214938095",
"resource": {
"resourceType": "DocumentReference",
"id": "214938095",
"meta": {
"versionId": "1",
"lastUpdated": "2020-10-29T09:40:27.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Document Reference</b></p><p><b>Patient Name</b>: PETERS, TIMOTHY CCCC</p><p><b>Document Type</b>: Rheumatology Consultation</p><p><b>Document Title</b>: TEST TIMEZONE A17</p><p><b>Service End Date</b>: Jul 30, 2020 6:20 A.M. CDT</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: M, SANGEETHA</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CE52dd2c20-da69-41a3-a5dc-7c34f8103ac0-214938095-2020102909402700"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820583",
"display": "Rheumatology Consultation",
"userSelected": true
},
{
"system": "http://loinc.org",
"code": "34839-1",
"userSelected": false
}
],
"text": "Rheumatology Consultation"
},
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "34839-1",
"userSelected": false
}
]
},
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note",
"userSelected": false
}
],
"text": "Clinical Note"
}
],
"subject": {
"reference": "Patient/1316024",
"display": "PETERS, TIMOTHY CCCC"
},
"author": [
{
"reference": "Practitioner/159105544",
"display": "M, SANGEETHA"
}
],
"authenticator": {
"reference": "Practitioner/159105544",
"display": "M, SANGEETHA"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-214938095",
"title": "TEST TIMEZONE A17",
"creation": "2020-07-30T11:20:00.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/32487567"
}
],
"period": {
"end": "2020-07-30T11:20:00.000Z"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.doc-214938095",
"resource": {
"resourceType": "Provenance",
"id": "INT.doc-214938095",
"meta": {
"versionId": "214938095",
"lastUpdated": "2020-07-30T11:20:00Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>DocumentReference/214938095</li></ul><p><b>Recorded</b>: Jul 30, 2020 6:20 A.M. CDT</p><p><b>Agents</b>:</p><dl><dt>M, SANGEETHA</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd><dt>DEVENG-DEFAULT-PROV</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>"
},
"target": [
{
"reference": "DocumentReference/214938095"
}
],
"recorded": "2020-07-30T11:20:00Z",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Practitioner/159105544",
"display": "M, SANGEETHA"
}
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Organization/57535538",
"display": "DEVENG-DEFAULT-PROV"
}
}
]
},
"search": {
"mode": "include"
}
}
]
}
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: search by encounter filters patients level documents
Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=823932&encounter=863887
Response
Status: 200 OK
{
"resourceType": "DocumentReference",
"id": "8676968",
"meta": {
"versionId": "4",
"lastUpdated": "2014-12-08T21:18:56.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Test, Blood Bank</p><p><b>Document Type</b>: Bone Marrow Report</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: Bone Marrow Final Report</p><p><b>Service Start Date</b>: Dec 8, 2014 3:04 P.M. CST</p><p><b>Service End Date</b>: Dec 8, 2014 3:04 P.M. CST</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Desani, Santosh</p></div>"
},
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "4184837",
"display": "Bone Marrow Report",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "UNK",
"display": "unknown"
}
],
"text": "Bone Marrow Report"
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
],
"subject": {
"reference": "Patient/823932",
"display": "Test, Blood Bank"
},
"authenticator": {
"reference": "Practitioner/1994008",
"display": "Desani, Santosh"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-ehr.devcerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-8676968",
"title": "Bone Marrow Final Report",
"creation": "2014-12-08T21:04:50.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/863887"
}
],
"period": {
"start": "2014-12-08T21:04:50.000Z",
"end": "2014-12-08T21:04:50.000Z"
}
}
}
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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=2798003
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "74e2c51e-96af-4f95-abd1-bbbe566e386b",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference?patient=2798003"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21961261",
"resource": {
"resourceType": "DocumentReference",
"id": "21961261",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-12T22:35:03.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Admission Note-Physician</p><p><b>Document Category</b>: Clinical Note</p><p><b>Document Title</b>: Admission H & P</p><p><b>Service End Date</b>: Mar 12, 2021 4:31 P.M. CST</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Braus, Sasha</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21961261-2021031216350400"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820507",
"display": "Admission Note-Physician"
},
{
"system": "http://loinc.org",
"code": "83805-2"
}
],
"text": "Admission Note-Physician"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
],
"text": "Clinical Note"
},
{
"coding": [
{
"system": "http://loinc.org",
"code": "83805-2"
}
]
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"authenticator": {
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-12T22:31:38.000Z"
}
}
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21674656",
"resource": {
"resourceType": "DocumentReference",
"id": "21674656",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-05T16:48:42.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Abdominal Ultrasound</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: test images</p><p><b>Service End Date</b>: Mar 5, 2021 10:47 A.M. CST</p><p><b>Document Status</b>: Preliminary</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21674656-2021030510484300"
}
],
"status": "current",
"docStatus": "preliminary",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820643",
"display": "Abdominal Ultrasound"
},
{
"system": "http://loinc.org",
"_code": {
"extension": [
{
"valueCode": "unknown",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
}
],
"text": "Abdominal Ultrasound"
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-20801159",
"title": "Admission H & P",
"creation": "2021-02-10T23:27:20.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-05T16:47:00.000Z"
}
}
}
}
]
}
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.
Retrieve by id
List an individual DocumentReference by its id:
GET /DocumentReference/:id
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21961261
Response
Status: 200 OK
{
"resourceType": "DocumentReference",
"id": "21961261",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-12T22:35:03.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Admission Note-Physician</p><p><b>Document Category</b>: Clinical Note</p><p><b>Document Title</b>: Admission H & P</p><p><b>Service End Date</b>: Mar 12, 2021 4:31 P.M. CST</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Braus, Sasha</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21961261-2021031216350400"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820507",
"display": "Admission Note-Physician",
"userSelected": true
},
{
"system": "http://loinc.org",
"code": "83805-2",
"userSelected": false
}
],
"text": "Admission Note-Physician"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note",
"userSelected": false
}
],
"text": "Clinical Note"
},
{
"coding": [
{
"system": "http://loinc.org",
"code": "83805-2",
"userSelected": false
}
]
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"authenticator": {
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
},
{
"attachment": {
"contentType": "text/html",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-12T22:31:38.000Z"
}
}
}
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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/21961261
Response
Status: 200 OK
{
"resourceType": "DocumentReference",
"id": "21961261",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-12T22:35:03.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Document Reference</b></p><p><b>Patient Name</b>: Parnell, Stephen M</p><p><b>Document Type</b>: Admission Note-Physician</p><p><b>Document Category</b>: Clinical Note</p><p><b>Document Title</b>: Admission H & P</p><p><b>Service End Date</b>: Mar 12, 2021 4:31 P.M. CST</p><p><b>Document Status</b>: Final</p><p><b>Verifying Provider</b>: Braus, Sasha</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-21961261-2021031216350400"
}
],
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820507",
"display": "Admission Note-Physician"
},
{
"system": "http://loinc.org",
"code": "83805-2"
}
],
"text": "Admission Note-Physician"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
],
"text": "Clinical Note"
},
{
"coding": [
{
"system": "http://loinc.org",
"code": "83805-2"
}
]
}
],
"subject": {
"reference": "Patient/2798003",
"display": "Parnell, Stephen M"
},
"author": [
{
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
}
],
"authenticator": {
"reference": "Practitioner/2797943",
"display": "Braus, Sasha"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-21961261",
"title": "Admission H & P",
"creation": "2021-03-12T22:35:03.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/2673908"
}
],
"period": {
"end": "2021-03-12T22:31:38.000Z"
}
}
}
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.
Create
Create a new document reference.
POST /DocumentReference
Implementation Notes
- Only the body fields mentioned below are supported. Unsupported fields will be ignored.
- All provided dates must have a time component.
- Supported MIME Types: application/pdf, text/plain, text/richtext, text/rtf, text/html, application/xml, and application/xhtml+xml
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
status
|
Yes |
code |
|
|
|||
docStatus
|
Yes |
code |
|
|
|||
type
|
Yes |
CodeableConcept |
|
|
|||
subject
|
Yes |
Reference |
|
|
|||
author
|
Yes |
Reference |
|
|
|||
authenticator
|
No |
Reference |
|
|
|||
content
|
Yes |
BackboneElement |
|
|
|||
content.attachment
|
Yes |
Attachment |
|
|
|||
content.attachment.contentType
|
Yes |
Code |
|
|
|||
content.attachment.data
|
Yes |
base64Binary |
|
|
|||
content.attachment.title
|
No |
Attachment |
|
|
|||
content.attachment.creation
|
No |
dateTime |
|
|
|||
context
|
Yes |
BackboneElement |
|
|
|||
context.encounter
|
No |
Reference |
|
|
|||
context.period
|
Yes |
Period |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference
Body
{
"resourceType": "DocumentReference",
"status": "current",
"docStatus": "final",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "20732501",
"display": "Height Weight Allergy Rule - Text",
"userSelected": true
}
],
"text": "Height Weight Allergy Rule - Text"
},
"subject": {
"reference": "Patient/53663272"
},
"author": [
{
"reference": "Practitioner/21500981"
}
],
"authenticator": {
"reference": "Practitioner/21500981"
},
"content": [
{
"attachment": {
"contentType": "application/xml;charset=utf-8",
"data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4=",
"title": "Height Weight Allergy Rule",
"creation": "2020-07-29T21:02:04.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/4208059"
}
],
"period": {
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T01:00:00.000Z"
}
}
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Fri, 14 Feb 2020 22:05:40 GMT Etag: W/"12793861" Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/16885181 Vary: Origin X-Request-Id: 3e4cb2f732daacdb6cca2eb944e80e55
Update
Update an existing document reference:
PUT /DocumentReference/:id
Authorization Types
Implementation Notes
- Refer to the HL7® FHIR® Update documentation for additional details about update operations.
- Both read and write scopes are required.
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/json+fhir
Content-Type: application/fhir+json
If-Match: W/"<Current version of the DocumentReference resource>"
Body fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
status
|
Yes |
code |
|
|
|||
docStatus
|
Yes |
code |
|
|
|||
type
|
‘Yes’ |
CodeableConcept |
|
|
|||
subject
|
Yes |
Reference |
|
|
|||
author
|
Yes |
Reference |
|
|
|||
authenticator
|
No |
Reference |
|
|
|||
content
|
Yes |
BackboneElement |
|
|
|||
content.attachment
|
Yes |
Attachment |
|
|
|||
content.attachment.contentType
|
Yes |
Code |
|
|
|||
content.attachment.data
|
Yes |
base64Binary |
|
|
|||
content.attachment.title
|
No |
Attachment |
|
|
|||
content.attachment.creation
|
No |
dateTime |
|
|
|||
context
|
Yes |
BackboneElement |
|
|
|||
context.encounter
|
No |
Reference |
|
|
|||
context.period
|
Yes |
Period |
|
|
Example
Request
PUT https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/16885181
Body
{
"resourceType": "DocumentReference",
"id": "16885181",
"status": "entered-in-error",
"docStatus": "amended",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2820507",
"display": "Admission Note-Physician",
"userSelected": true
}
]
},
"subject": {
"reference": "Patient/53663272"
},
"author": [
{
"reference": "Practitioner/21500981"
}
],
"authenticator": {
"reference": "Practitioner/21500981"
},
"identifier": [
{
"system": "https://fhir.cerner.com/location/source/0/0/1",
"value": "identifier 1"
}
],
"content": [
{
"attachment": {
"contentType": "application/xml;charset=utf-8",
"data": "PGh08L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4=",
"title": "Admission Note-Physician",
"creation": "2020-08-15T14:35:29.000Z"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/4208053"
}
],
"period": {
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T01:00:00.000Z"
}
}
}
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Tue, 20 Aug 2019 21:17:04 GMT Etag: W/"12793861" Last-Modified: Sat, 15 Feb 2020 22:05:40 GMT Vary: Origin X-Request-Id: 3e4cb2f732daacdb6cca2eb944e80e55
The ETag
response header indicates the current If-Match
version to use on subsequent update.
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.
Operation: docref
US Core operation for querying DocumentReferences for the supplied parameters:
GET /DocumentReference/$docref?:parameters
Terminology Bindings
DocumentReference.type |
|
DocumentReference.content.format |
|
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
patient |
Y | reference |
The specific patient to return DocumentReferences for. Example: 12345
|
type |
N | token |
The document reference type, can be a list of comma separated values. Example: http://loinc.org|34133-9 |
start |
N | number |
The start of the date range from which document reference records should be included. If not provided, then all records from the beginning of time are included. Example: 2014-09-24T12:00:00.000Z |
end |
N | number |
The end of the date range till which document reference records should be included. If not provided, then all records up to the current date are included. Example: 2016-09-24T12:00:00.000Z |
Implementation Notes
- The type parameter must include both a system and a code. (e.g. &type=http://loinc.org|34133-9)
- The start and end parameters must be valid dateTimes with a time component. They must have prefixes of eq or nothing.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351&type=http%3A%2F%2Floinc.org%7C34133-9
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "2cb9157f-0f05-4fe4-af14-95d5808a4070",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/b79484c9-1170-44cd-9910-f9013ff2ea1f",
"resource": {
"resourceType": "DocumentReference",
"id": "b79484c9-1170-44cd-9910-f9013ff2ea1f",
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34133-9",
"display": "Summary of episode note"
}
],
"text": "Summary of episode note"
},
"subject": {
"reference": "Patient/13160351"
},
"date": "2020-12-14T08:20:26Z",
"content": [
{
"attachment": {
"contentType": "application/xml",
"url": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/$autogen-ccd-if?patient=13160351"
},
"format": {
"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
"code": "urn:hl7-org:sdwg:ccda-structuredBody:2.1",
"display": "For documents following C-CDA constraints using a structured body."
}
}
]
}
}
]
}
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.
Patient Authorization Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351&type=http%3A%2F%2Floinc.org%7C34133-9
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "2cb9157f-0f05-4fe4-af14-95d5808a4070",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/$docref?patient=13160351"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DocumentReference/b79484c9-1170-44cd-9910-f9013ff2ea1f",
"resource": {
"resourceType": "DocumentReference",
"id": "b79484c9-1170-44cd-9910-f9013ff2ea1f",
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34133-9",
"display": "Summary of episode note"
}
],
"text": "Summary of episode note"
},
"subject": {
"reference": "Patient/13160351"
},
"date": "2020-12-14T08:20:26Z",
"content": [
{
"attachment": {
"contentType": "application/xml",
"url": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/$autogen-ccd-if?patient=13160351"
},
"format": {
"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
"code": "urn:hl7-org:sdwg:ccda-structuredBody:2.1",
"display": "For documents following C-CDA constraints using a structured body."
}
}
]
}
}
]
}
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.