DocumentReference REST Endpoints

Sort by

Task Path Method

Description

DocumentReference

This topic describes information for the DocumentReference resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The DocumentReference resource is used to reference a clinical document for a patient in 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 file. When retrieving document links and metadata, this resource references the Binary resource for downloading the complete document.

This resource also supports writing and updating documents.

Profile Support

This resource supports the US Core DocumentReference Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
DocumentReference	DomainResource
DocumentReference.identifier	Identifier
DocumentReference.status	code
DocumentReference.type	CodeableConcept
DocumentReference.category	CodeableConcept
DocumentReference.subject	Reference(Patient)
DocumentReference.date	instant
DocumentReference.author	Reference Practitioner Organization Device RelatedPerson Patient
DocumentReference.content	BackboneElement
DocumentReference.content.attachment	Attachment
DocumentReference.content.attachment.contentType	code
DocumentReference.content.attachment.data	base64Binary
DocumentReference.content.attachment.url	url
DocumentReference.content.format	Coding
DocumentReference.context	BackboneElement
DocumentReference.context.encounter	Reference(Encounter)
DocumentReference.context.period	Period

Terminology Bindings

Element	Description	Details
DocumentReference.status	The status of this document reference.	System
DocumentReference.type	The particular type of document referenced (for example, History and Physical, Discharge Summary, Progress Note). This type usually equates to the purpose of making the document referenced.	LOINC System
DocumentReference.category	A categorization for the type of document referenced, which is intended to help with indexing and searching. This categorization may be implied by or derived from the code specified in the DocumentReference.type.	System

DocumentReference

The operations from the DocumentReference category.

Get a document reference by ID

Method: get

Path: /DocumentReference/{id}

Get a list of document references

Method: get

Path: /DocumentReference

Get a list of document references with $docref

Method: get

Path: /DocumentReference/$docref