FHIR Reference Data Type (R4)

Reference links one resource to another. Element table, example JSON and FHIRPath for FHIR R4.

Overview

Reference links one resource to another. It can hold a literal reference (Patient/123 or an absolute URL), a logical identifier, and a display string.

Elements

ElementTypeCardinalityDescription
Reference.referencestring0..1Literal reference, Relative, internal or absolute URL
Reference.typeuri0..1Type the reference refers to (e.g. "Patient")
Reference.identifierIdentifier0..1Logical reference, when literal reference is not known
Reference.displaystring0..1Text alternative for the resource

Example JSON (R4)

{
  "reference": "Patient/example",
  "type": "Patient",
  "display": "John Smith"
}

FHIRPath

  • Observation.subject.reference — Reference string
  • Bundle.entry.resource.ofType(Observation).subject.reference — Subjects of Observations in a Bundle

FHIR Toolbox is a free collection of HL7 FHIR tools by Omindra Labs. The tools process your data in your browser; it is not uploaded for normal tool operations.