R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example CodeSystem/additional-binding-purpose (XML)

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

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

Definition for Code SystemAdditionalBindingPurposeCodes

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="additional-binding-purpose"/> 
  <meta> 
    <lastUpdated value="2023-03-01T23:03:57.298+11: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/CodeSystem/additional-binding-purpose</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">maximum
            <a name="additional-binding-purpose-maximum"> </a> 
          </td> 
          <td> Maximum Binding</td> 
          <td> A required binding, for use when the binding strength is 'extensible' or 'preferred'</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">minimum
            <a name="additional-binding-purpose-minimum"> </a> 
          </td> 
          <td> Minimum Binding</td> 
          <td> The minimum allowable value set - any conformant system SHALL support all these
             codes</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">required
            <a name="additional-binding-purpose-required"> </a> 
          </td> 
          <td> Required Binding</td> 
          <td> This value set is used as a required binding (in addition to the base binding (not
             a replacement), usually in a particular usage context)</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">extensible
            <a name="additional-binding-purpose-extensible"> </a> 
          </td> 
          <td> Conformance Binding</td> 
          <td> This value set is used as an extensible binding (in addition to the base binding
             (not a replacement), usually in a particular usage context)</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">candidate
            <a name="additional-binding-purpose-candidate"> </a> 
          </td> 
          <td> Candidate Binding</td> 
          <td> This value set is a candidate to substitute for the overall conformance value set
             in some situations; usually these are defined in the documentation</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">current
            <a name="additional-binding-purpose-current"> </a> 
          </td> 
          <td> Current Binding</td> 
          <td> New records are required to use this value set, but legacy records may use other
             codes. The definition of 'new record' is difficult, since systems often create
             new records based on pre-existing data. Usually 'current' bindings are mandated
             by an external authority that makes clear rules around this</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">preferred
            <a name="additional-binding-purpose-preferred"> </a> 
          </td> 
          <td> Preferred Binding</td> 
          <td> This is the value set that is preferred in a given context (documentation should
             explain why)</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">ui
            <a name="additional-binding-purpose-ui"> </a> 
          </td> 
          <td> UI Suggested Binding</td> 
          <td> This value set is provided for user look up in a given context. Typically, these
             valuesets only include a subset of codes relevant for input in a context</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">starter
            <a name="additional-binding-purpose-starter"> </a> 
          </td> 
          <td> Starter Binding</td> 
          <td> This value set is a good set of codes to start with when designing your system</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">component
            <a name="additional-binding-purpose-component"> </a> 
          </td> 
          <td> Component Binding</td> 
          <td> This value set is a component of the base value set. Usually this is called out
             so that documentation can be written about a portion of the value set</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/CodeSystem/additional-binding-purpose"/> 
  <version value="5.0.0-draft-final"/> 
  <name value="AdditionalBindingPurposeCodes"/> 
  <title value="Additional Binding Purpose Codes"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <description value="Additional Binding Purpose"/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
    </coding> 
  </jurisdiction> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/additional-binding-purpose"/> 
  <content value="complete"/> 
  <concept> 
    <code value="maximum"/> 
    <display value="Maximum Binding"/> 
    <definition value="A required binding, for use when the binding strength is 'extensible' or 'preferred'"/> 
  </concept> 
  <concept> 
    <code value="minimum"/> 
    <display value="Minimum Binding"/> 
    <definition value="The minimum allowable value set - any conformant system SHALL support all these
     codes"/> 
  </concept> 
  <concept> 
    <code value="required"/> 
    <display value="Required Binding"/> 
    <definition value="This value set is used as a required binding (in addition to the base binding (not
     a replacement), usually in a particular usage context)"/> 
  </concept> 
  <concept> 
    <code value="extensible"/> 
    <display value="Conformance Binding"/> 
    <definition value="This value set is used as an extensible binding (in addition to the base binding
     (not a replacement), usually in a particular usage context)"/> 
  </concept> 
  <concept> 
    <code value="candidate"/> 
    <display value="Candidate Binding"/> 
    <definition value="This value set is a candidate to substitute for the overall conformance value set
     in some situations; usually these are defined in the documentation"/> 
  </concept> 
  <concept> 
    <code value="current"/> 
    <display value="Current Binding"/> 
    <definition value="New records are required to use this value set, but legacy records may use other
     codes. The definition of 'new record' is difficult, since systems often create
     new records based on pre-existing data. Usually 'current' bindings are mandated
     by an external authority that makes clear rules around this"/> 
  </concept> 
  <concept> 
    <code value="preferred"/> 
    <display value="Preferred Binding"/> 
    <definition value="This is the value set that is preferred in a given context (documentation should
     explain why)"/> 
  </concept> 
  <concept> 
    <code value="ui"/> 
    <display value="UI Suggested Binding"/> 
    <definition value="This value set is provided for user look up in a given context. Typically, these
     valuesets only include a subset of codes relevant for input in a context"/> 
  </concept> 
  <concept> 
    <code value="starter"/> 
    <display value="Starter Binding"/> 
    <definition value="This value set is a good set of codes to start with when designing your system"/> 
  </concept> 
  <concept> 
    <code value="component"/> 
    <display value="Component Binding"/> 
    <definition value="This value set is a component of the base value set. Usually this is called out
     so that documentation can be written about a portion of the value set"/> 
  </concept> 
</CodeSystem> 

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.