Terminology
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
|
|
|
Raw JSON ( canonical form + also see JSON Format Specification )
Definition
for
Code
System
ReferenceHandlingPolicy
SystemReferenceHandlingPolicy
{
"resourceType": "CodeSystem",
"id": "reference-handling-policy",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
"resourceType" : "CodeSystem",
"id" : "reference-handling-policy",
"meta" : {
"lastUpdated" : "2025-12-17T09:50:17.012+00:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem reference-handling-policy</b></p><a name=\"reference-handling-policy\"> </a><a name=\"hcreference-handling-policy\"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/reference-handling-policy</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">literal<a name=\"reference-handling-policy-literal\"> </a></td><td>Literal References</td><td>The server supports and populates Literal references (i.e. using Reference.reference) where they are known (this code does not guarantee that all references are literal; see 'enforced').</td></tr><tr><td style=\"white-space:nowrap\">logical<a name=\"reference-handling-policy-logical\"> </a></td><td>Logical References</td><td>The server allows logical references (i.e. using Reference.identifier).</td></tr><tr><td style=\"white-space:nowrap\">resolves<a name=\"reference-handling-policy-resolves\"> </a></td><td>Resolves References</td><td>The server will attempt to resolve logical references to literal references - i.e. converting Reference.identifier to Reference.reference (if resolution fails, the server may still accept resources; see logical).</td></tr><tr><td style=\"white-space:nowrap\">enforced<a name=\"reference-handling-policy-enforced\"> </a></td><td>Reference Integrity Enforced</td><td>The server enforces that references have integrity - e.g. it ensures that references can always be resolved. This is typically the case for clinical record systems, but often not the case for middleware/proxy systems.</td></tr><tr><td style=\"white-space:nowrap\">local<a name=\"reference-handling-policy-local\"> </a></td><td>Local References Only</td><td>The server does not support references that point to other servers.</td></tr></table></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Informative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/reference-handling-policy",
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.1.193"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
"version": "3.0.2",
"name": "ReferenceHandlingPolicy",
"status": "draft",
"experimental": false,
"date": "2019-10-24T11:53:00+11:00",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "A set of flags that defines how references are supported.",
"caseSensitive": true,
"valueSet": "http://hl7.org/fhir/ValueSet/reference-handling-policy",
"content": "complete",
"concept": [
{
"code": "literal",
"display": "Literal References",
"definition": "The server supports and populates Literal references where they are known (this code does not guarantee that all references are literal; see 'enforced')"
},
{
"code": "logical",
"display": "Logical References",
"definition": "The server allows logical references"
},
{
"code": "resolves",
"display": "Resolves References",
"definition": "The server will attempt to resolve logical references to literal references (if resolution fails, the server may still accept resources; see logical)"
},
{
"code": "enforced",
"display": "Reference Integrity Enforced",
"definition": "The server enforces that references have integrity - e.g. it ensures that references can always be resolved. This is typically the case for clinical record systems, but often not the case for middleware/proxy systems"
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
}],
"url" : "http://hl7.org/fhir/reference-handling-policy",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.4.203"
},
{
"use" : "old",
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.1.193"
}],
"version" : "6.0.0-ballot3",
"name" : "ReferenceHandlingPolicy",
"title" : "Reference Handling Policy",
"status" : "active",
"experimental" : false,
"date" : "2021-01-05T10:01:24+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"code": "local",
"display": "Local References Only",
"definition": "The server does not support references that point to other servers"
}
]
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "A set of flags that defines how references are supported.",
"jurisdiction" : [{
"coding" : [{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"caseSensitive" : true,
"valueSet" : "http://hl7.org/fhir/ValueSet/reference-handling-policy",
"content" : "complete",
"concept" : [{
"code" : "literal",
"display" : "Literal References",
"definition" : "The server supports and populates Literal references (i.e. using Reference.reference) where they are known (this code does not guarantee that all references are literal; see 'enforced')."
},
{
"code" : "logical",
"display" : "Logical References",
"definition" : "The server allows logical references (i.e. using Reference.identifier)."
},
{
"code" : "resolves",
"display" : "Resolves References",
"definition" : "The server will attempt to resolve logical references to literal references - i.e. converting Reference.identifier to Reference.reference (if resolution fails, the server may still accept resources; see logical)."
},
{
"code" : "enforced",
"display" : "Reference Integrity Enforced",
"definition" : "The server enforces that references have integrity - e.g. it ensures that references can always be resolved. This is typically the case for clinical record systems, but often not the case for middleware/proxy systems."
},
{
"code" : "local",
"display" : "Local References Only",
"definition" : "The server does not support references that point to other servers."
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Wed,
Dec
17,
2025
09:51+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change