HL7 Terminology
2.1.0 - Publication

This page is part of the HL7 Terminology (v2.1.0: Release) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: HL7ConformanceInclusion - XML Representation

Raw xml | Download



<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-HL7ConformanceInclusion"/>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><p><b>Properties</b></p><table class="grid"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>Specializes</td><td/><td>The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.</td><td>Coding</td></tr><tr><td>Generalizes</td><td/><td>Inverse of Specializes.  Only included as a derived relationship.</td><td>Coding</td></tr><tr><td>internalId</td><td>http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id</td><td>The internal identifier for the concept in the HL7 Access database repository.</td><td>code</td></tr><tr><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>Indicates that the code is abstract - only intended to be used as a selector for other concepts</td><td>boolean</td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>Designation of a concept's state. Normally is not populated unless the state is retired.</td><td>code</td></tr><tr><td>synonymCode</td><td>http://hl7.org/fhir/concept-properties#synonym</td><td>An additional concept code that was also attributed to a concept</td><td>code</td></tr></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-HL7ConformanceInclusion defines the following codes:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>internalId</b></td><td><b>Not Selectable</b></td><td><b>status</b></td><td><b>synonymCode</b></td></tr><tr><td>1</td><td style="white-space:nowrap">_InclusionNotMandatory<a name="v3-HL7ConformanceInclusion-_InclusionNotMandatory"> </a></td><td>InclusionNotMandatory</td><td>The message element is not mandatory, but its appearance may be constrained by one of the non-mandatory concepts.</td><td>21081</td><td>true</td><td>active</td><td/></tr><tr><td>2</td><td style="white-space:nowrap">  NP<a name="v3-HL7ConformanceInclusion-NP"> </a></td><td>Not permitted</td><td>This message element may not appear when the message is communicated.</td><td>10014</td><td/><td>active</td><td/></tr><tr><td>2</td><td style="white-space:nowrap">  NR<a name="v3-HL7ConformanceInclusion-NR"> </a></td><td>Not required</td><td>The message element may be populated or used by one system sponsor (or profile), but not by another. Each system sponsor or profile is required to state the ability to accept or send the message element as part of a conformance claim.</td><td>10015</td><td/><td>active</td><td/></tr><tr><td>3</td><td style="white-space:nowrap">    RE<a name="v3-HL7ConformanceInclusion-RE"> </a></td><td>Required may be empty</td><td>Pursuant to a profile or vendor conformance claim, the message element must appear every time the message is communicated, but the value may be communicated as null.</td><td>10016</td><td/><td>active</td><td/></tr><tr><td>3</td><td style="white-space:nowrap">    X<a name="v3-HL7ConformanceInclusion-X"> </a></td><td>Excluded</td><td>Pursuant to a profile or vendor conformance claim, this message element may not appear when the message is communicated.</td><td>10017</td><td/><td>active</td><td/></tr><tr><td>2</td><td style="white-space:nowrap">  RQ<a name="v3-HL7ConformanceInclusion-RQ"> </a></td><td>Required</td><td>The message element must appear every time the message is communicated, but the value may be communicated as null.</td><td>10013</td><td/><td>active</td><td/></tr><tr><td>1</td><td style="white-space:nowrap">M<a name="v3-HL7ConformanceInclusion-M"> </a></td><td>Mandatory</td><td>The message element must appear every time the message is communicated and its value must not be null. This condition is subject to the rules of multiplicity and conditionality. If a non-null default value is defined for the element, a null value may be communicated.</td><td>10011</td><td/><td>active</td><td>R</td></tr><tr><td>1</td><td style="white-space:nowrap">R<a name="v3-HL7ConformanceInclusion-R"> </a></td><td>Mandatory</td><td>The message element must appear every time the message is communicated and its value must not be null. This condition is subject to the rules of multiplicity and conditionality. If a non-null default value is defined for the element, a null value may be communicated.</td><td>10011</td><td/><td>active</td><td>M</td></tr></table></div>
  </text>
  <url value="http://terminology.hl7.org/CodeSystem/v3-HL7ConformanceInclusion"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.5.55"/>
  </identifier>
  <version value="2.0.0"/>
  <name value="HL7ConformanceInclusion"/>
  <title value="HL7ConformanceInclusion"/>
  <status value="retired"/>
  <date value="2019-03-20"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="Health Level Seven"/>
  </contact>
  <description
               value="These concepts represent theconformance requirments defined for including or valuing an element of an HL7 message. The concepts apply equally to conformance profiles defined for Version 2.x messgaes as defined by the Conformance SIG, and to the conformance columns for Version 3 messages as specified in the HMD.

**Deprecation Comment:** Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used."/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <property>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry">
      <valueCode value="antisymmetric"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity">
      <valueCode value="transitive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity">
      <valueCode value="irreflexive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable">
      <valueBoolean value="true"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind">
      <valueCode value="Specializes"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName">
      <valueString value="Generalizes"/>
    </extension>
    <code value="Specializes"/>
    <description
                 value="The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric."/>
    <type value="Coding"/>
  </property>
  <property>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry">
      <valueCode value="antisymmetric"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity">
      <valueCode value="transitive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity">
      <valueCode value="irreflexive"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable">
      <valueBoolean value="true"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind">
      <valueCode value="Generalizes"/>
    </extension>
    <extension
               url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName">
      <valueString value="Specializes"/>
    </extension>
    <code value="Generalizes"/>
    <description
                 value="Inverse of Specializes.  Only included as a derived relationship."/>
    <type value="Coding"/>
  </property>
  <property>
    <code value="internalId"/>
    <uri
         value="http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id"/>
    <description
                 value="The internal identifier for the concept in the HL7 Access database repository."/>
    <type value="code"/>
  </property>
  <property>
    <code value="notSelectable"/>
    <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>
    <description
                 value="Indicates that the code is abstract - only intended to be used as a selector for other concepts"/>
    <type value="boolean"/>
  </property>
  <property>
    <code value="status"/>
    <uri value="http://hl7.org/fhir/concept-properties#status"/>
    <description
                 value="Designation of a concept&#39;s state. Normally is not populated unless the state is retired."/>
    <type value="code"/>
  </property>
  <property>
    <code value="synonymCode"/>
    <uri value="http://hl7.org/fhir/concept-properties#synonym"/>
    <description
                 value="An additional concept code that was also attributed to a concept"/>
    <type value="code"/>
  </property>
  <concept>
    <code value="_InclusionNotMandatory"/>
    <display value="InclusionNotMandatory"/>
    <definition
                value="The message element is not mandatory, but its appearance may be constrained by one of the non-mandatory concepts."/>
    <property>
      <code value="notSelectable"/>
      <valueBoolean value="true"/>
    </property>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="21081"/>
    </property>
    <concept>
      <code value="NP"/>
      <display value="Not permitted"/>
      <definition
                  value="This message element may not appear when the message is communicated."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="10014"/>
      </property>
    </concept>
    <concept>
      <code value="NR"/>
      <display value="Not required"/>
      <definition
                  value="The message element may be populated or used by one system sponsor (or profile), but not by another. Each system sponsor or profile is required to state the ability to accept or send the message element as part of a conformance claim."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="10015"/>
      </property>
      <concept>
        <code value="RE"/>
        <display value="Required may be empty"/>
        <definition
                    value="Pursuant to a profile or vendor conformance claim, the message element must appear every time the message is communicated, but the value may be communicated as null."/>
        <property>
          <code value="status"/>
          <valueCode value="active"/>
        </property>
        <property>
          <code value="internalId"/>
          <valueCode value="10016"/>
        </property>
      </concept>
      <concept>
        <code value="X"/>
        <display value="Excluded"/>
        <definition
                    value="Pursuant to a profile or vendor conformance claim, this message element may not appear when the message is communicated."/>
        <property>
          <code value="status"/>
          <valueCode value="active"/>
        </property>
        <property>
          <code value="internalId"/>
          <valueCode value="10017"/>
        </property>
      </concept>
    </concept>
    <concept>
      <code value="RQ"/>
      <display value="Required"/>
      <definition
                  value="The message element must appear every time the message is communicated, but the value may be communicated as null."/>
      <property>
        <code value="status"/>
        <valueCode value="active"/>
      </property>
      <property>
        <code value="internalId"/>
        <valueCode value="10013"/>
      </property>
    </concept>
  </concept>
  <concept>
    <code value="M"/>
    <display value="Mandatory"/>
    <definition
                value="The message element must appear every time the message is communicated and its value must not be null. This condition is subject to the rules of multiplicity and conditionality. If a non-null default value is defined for the element, a null value may be communicated."/>
    <designation>
      <language value="en"/>
      <use>
        <system value="http://snomed.info/sct"/>
        <code value="900000000000013009"/>
      </use>
      <value value="Required - V2.x"/>
    </designation>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="synonymCode"/>
      <valueCode value="R"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="10011"/>
    </property>
  </concept>
  <concept>
    <code value="R"/>
    <display value="Mandatory"/>
    <definition
                value="The message element must appear every time the message is communicated and its value must not be null. This condition is subject to the rules of multiplicity and conditionality. If a non-null default value is defined for the element, a null value may be communicated."/>
    <designation>
      <language value="en"/>
      <use>
        <system value="http://snomed.info/sct"/>
        <code value="900000000000013009"/>
      </use>
      <value value="Required - V2.x"/>
    </designation>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="synonymCode"/>
      <valueCode value="M"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="10011"/>
    </property>
  </concept>
</CodeSystem>