DocumentReference REST Endpoints
Description
This topic describes information for the DocumentReference resource.
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 (CCDs), returning a list of clinical documents, and a reference to retrieve a document as a PDF. When retrieving document links and metadata, this resource refers to the Binary resource for downloading the complete document.
Additionally, this resource supports writing and updating documents. For fields supported on write or update operations, see the appropriate tasks for this resource.
This resource supports the following HL7 FHIR US Core Implementation Guide STU 4.0.0 profile:
The following fields are returned if valued for clinical documents:
Terminology Bindings
-
Description: The status of the document reference.
Details: DocumentReference status
System:
http://hl7.org/fhir/document-reference-status
-
Description: The status of the underlying document.
Details: DocumentReference docStatus
System:
http://hl7.org/fhir/r4/codesystem-composition-status.html
-
Description: Specifies the particular type of document referenced.
-
Details: US Core DocumentReference Type
System:
http://loinc.org
-
Details: US Core DocumentReference Type
System:
http://terminology.hl7.org/CodeSystem/v3-NullFlavor (when type doesn't have a LOINC code)
-
Details: For more information, see Code Set 72 Clinical Event Codes under the List of Code Sets section in Proprietary Codes and Systems.
System:
https://fhir.cerner.com/<EHR_source_id>/codeSet/72
-
-
Description: A categorization for the type of document referenced.
-
Details: US Core DocumentReference Category
System:
http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category
-
Details: US Core DiagnosticReport Category
System:
http://loinc.org
-
- Create a document reference
- Method: postPath:
/DocumentReference
- Get a document reference by ID
- Method: getPath:
/DocumentReference/{ID}
- Get a list of document references
- Method: getPath:
/DocumentReference
- Get a list of document references with $docref
- Method: getPath:
/DocumentReference/$docref
- Update a document reference
- Method: putPath:
/DocumentReference/{ID}