FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example CodeSystem/reference-handling-policy (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemReferenceHandlingPolicy

{
  "resourceType" : "CodeSystem",
  "id" : "reference-handling-policy",
  "meta" : {
    "lastUpdated" : "2024-11-04T19:39:07.885+00:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "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><a name=\"reference-handling-policy-en-US\"> </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-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "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-ballot2",
  "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"
    },
    {
      "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.