Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2 R3

Content Detailed Descriptions Mappings XML JSON

Example CodeSystem/reference-handling-policy (XML)

Extension: citizenship URL for this extension: http://hl7.org/fhir/StructureDefinition/patient-citizenship Status: draft. Extension maintained by: HL7 The patient's legal status as citizen of a country. Context of Use: Use on Element ID Patient Extension Content
Patient Administration FHIR Infrastructure Work Group   Maturity Level : 1 N/A Standards Status : Informative Use Context : Any
  • Summary Narrative
    • Full Structure
  • XML
  • JSON
  • All TTL
    • Summary Name Flags Card. Type Description & Constraints citizenship 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient code 0..1 CodeableConcept Nation code representing the citizenship of patient. period 0..1 Period Period when citizenship was effective. Documentation for this format

Full Structure Name Flags Card. Type Description & Constraints extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of a country. Use on Element ID Patient extension I 0..* Extension Additional content defined by implementations Slice: Unordered, Open by value:url extension:code I 0..1 Extension Nation code of citizenship extension I 0..0 url 1..1 uri "code" value[x] I 1..1 CodeableConcept Value of extension extension:period I 0..1 Extension Time period of citizenship extension I 0..0 url 1..1 uri "period" value[x] I 1..1 Period Value of extension url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship" value[x] I 0 .. 0 valueBase64Binary base64Binary valueBoolean boolean Raw XML valueCanonical ( canonical form () valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueReference Reference () valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage valueMeta Meta Documentation for this format + also see XML Template Format Specification )

<!-- citizenship --> < xmlns="http://hl7.org/fhir" url="" > < < Value of extension</valueCodeableConcept> </extension> < <</valuePeriod> </extension> </extension>

JSON Template Definition for Code SystemReferenceHandlingPolicy

{ // " { // // from Element: " ] " " }, { // // from Element: " ] " " } ], " } Summary 
<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="reference-handling-policy"/> 
  <meta> 
    <lastUpdated value="2022-09-10T04:52:37.223+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This 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> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/reference-handling-policy"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.203"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="ReferenceHandlingPolicy"/> 
  <title value="ReferenceHandlingPolicy"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="A set of flags that defines how references are supported."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/reference-handling-policy"/> 
  <content value="complete"/> 
  <concept> 
    <code value="literal"/> 
    <display value="Literal References"/> 
    <definition value="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')."/> 
  </concept> 
  <concept> 
    <code value="logical"/> 
    <display value="Logical References"/> 
    <definition value="The server allows logical references (i.e. using Reference.identifier)."/> 
  </concept> 
  <concept> 
    <code value="resolves"/> 
    <display value="Resolves References"/> 
    <definition value="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)."/> 
  </concept> 
  <concept> 
    <code value="enforced"/> 
    <display value="Reference Integrity Enforced"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="local"/> 
    <display value="Local References Only"/> 
    <definition value="The server does not support references that point to other servers."/> 
  </concept> 

Name
Flags
Card.
Type
Description
&
Constraints


</

CodeSystem


>


citizenship
0..*
Extension
URL
=
http://hl7.org/fhir/StructureDefinition/patient-citizenship
citizenship:
The
patient's
legal
status
as
citizen
of
a
country.
Use
on
Element
ID
Patient
code
0..1
CodeableConcept
Nation
code
representing
the
citizenship
of
patient.
period
0..1
Period
Period
when
citizenship
was
effective.
Documentation
for
this
format

Full Structure Name Flags Card. Type Description & Constraints extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/patient-citizenship citizenship: The patient's legal status as citizen of Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a country. Use on Element ID Patient extension I 0..* Extension Additional content defined by implementations Slice: Unordered, Open by value:url extension:code I 0..1 Extension Nation code of citizenship extension I 0..0 url 1..1 uri "code" value[x] I 1..1 CodeableConcept Value of extension extension:period I 0..1 Extension Time period of citizenship extension I 0..0 url 1..1 uri "period" value[x] I 1..1 Period Value normative part of extension url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship" value[x] I 0 .. 0 valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical () valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueReference Reference () valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage valueMeta Meta Documentation for this format XML Template <!-- citizenship --> < xmlns="http://hl7.org/fhir" url="" > < < Value of extension</valueCodeableConcept> </extension> < <</valuePeriod> </extension> </extension> JSON Template the specification.

{ // " { // // from Element: " ] " " }, { // // from Element: " ] " " } ], " }
  Constraints ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div ) ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) ) ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div ) ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div ) ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )