This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
FHIR
Infrastructure
Work
Group
|
|
See also Base Definition , Profiles and Extensions
| Reference | |||||||||||||
|
| Reference | ||||||||||||
| Definition |
A reference from one resource to another. |
||||||||||||
| Short Display | A reference from one resource to another | ||||||||||||
| Cardinality | 0..* | ||||||||||||
|
| DataType | ||||||||||||
| Summary | true | ||||||||||||
| Comments |
References
SHALL
be
a
reference
to
an
actual
FHIR
resource,
and
SHALL
be
|
||||||||||||
|
|
|
||||||||||||
| Reference.reference | |||||||||||||
|
| Reference.reference | ||||||||||||
| Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
||||||||||||
| Short Display | Literal reference, Relative, internal or absolute URL | ||||||||||||
| Cardinality | 0..1 | ||||||||||||
| Type | string | ||||||||||||
| Summary | true | ||||||||||||
| Comments |
Using
absolute
URLs
provides
a
stable
scalable
approach
suitable
for
a
cloud/web
context,
while
using
relative/logical
references
provides
a
flexible
approach
suitable
for
use
when
trading
across
closed
eco-system
boundaries.
Absolute
URLs
do
not
need
to
point
to
a
FHIR
RESTful
server,
though
this
is
the
preferred
approach.
If
the
URL
conforms
to
the
structure
|
||||||||||||
|
|
| ||||||||||||
| Reference.type | |||||||||||||
| Element Id | Reference.type | ||||||||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||||||||
| Short Display | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||||||||||||
| Cardinality | 0..1 | ||||||||||||
| Terminology Binding | Resource Types ( Extensible ) | ||||||||||||
| Type | uri | ||||||||||||
| Summary | true | ||||||||||||
| Comments |
This
element
is
used
to
indicate
the
type
of
the
target
of
the
reference.
This
may
be
used
which
ever
of
the
other
elements
are
populated
(or
not).
In
some
cases,
the
type
of
the
target
may
be
determined
by
inspection
of
the
reference
(e.g.
a
known
RESTful
URL)
or
|
||||||||||||
| Reference.identifier | |||||||||||||
|
| Reference.identifier | ||||||||||||
| Definition |
An
identifier
for
the
|
||||||||||||
|
| Logical reference, when literal reference is not known | ||||||||||||
| Note |
This
is
a
business
|
||||||||||||
|
|
0..1 | ||||||||||||
| Type | Identifier | ||||||||||||
| Summary | true | ||||||||||||
| Comments |
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifiers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
||||||||||||
| Constraints |
| ||||||||||||
| Reference.display | |||||||||||||
|
| Reference.display | ||||||||||||
| Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
||||||||||||
| Short Display | Text alternative for the resource | ||||||||||||
| Cardinality | 0..1 | ||||||||||||
| Type | string | ||||||||||||
| Summary | true | ||||||||||||
| Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
||||||||||||
| Constraints |
| ||||||||||||
See also Base Definition , Profiles and Extensions
| CodeableReference | |
| Element Id | CodeableReference |
| Definition | A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class). |
| Short Display | Reference to a resource or a concept |
| Cardinality | 0..* |
| Type | DataType |
| Requirements | This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere. |
| Summary | true |
| CodeableReference.concept | |
| Element Id | CodeableReference.concept |
| Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
| Short Display | Reference to a concept (by class) |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Summary | true |
| CodeableReference.reference | |
| Element Id | CodeableReference.reference |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Short Display | Reference to a resource (by instance) |
| Cardinality | 0..1 |
| Type | Reference |
| Summary | true |