FHIR DocumentReference Resource

A reference to a clinical document, including clinical notes and discharge summaries. This page documents the DocumentReference resource as served by the mock.health synthetic FHIR R4 sandbox — 7 search parameters, US Core 6.1 profiling, and the elements accepted on write.

Endpoints

• GET https://api.mock.health/fhir/DocumentReference — search
• GET https://api.mock.health/fhir/DocumentReference/{id} — read by logical id
• POST https://api.mock.health/fhir/DocumentReference — create (Pro)
• PUT https://api.mock.health/fhir/DocumentReference/{id} — update (Pro)

Search parameters

• patient (reference) — required — Patient the document is about
• type (token) — Document type code (LOINC)
• date (date) — When document was created
• category (token) — Document category
• status (token) — current | superseded | entered-in-error
• identifier (token) — External identifier
• period (date) — Time of service documented

US Core profiles

• us-core-documentreference

Write elements

Fields accepted when creating or updating a DocumentReference. Required elements are base FHIR cardinality; the rest are US Core must-support.

• status (code) — required — current | superseded | entered-in-error
• content (BackboneElement[]) — required — Document content — at least one attachment with URL or data
• type (CodeableConcept) — US Core MS — document type (LOINC)
• subject (Reference(Patient)) — US Core MS — patient the document is about
• category (CodeableConcept[]) — US Core MS — clinical-note category
• date (instant) — US Core MS — when the document was created

Notes

Supports the US Core $docref operation for CCD-style document queries. POST to /fhir/DocumentReference/$docref with a Parameters resource containing the patient ID.

Specification

Base definition: HL7 FHIR R4 DocumentReference. Category: Documents.

API reference · Quickstart · USCDI compliance · SMART on FHIR