HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

CodingRationale - XML Representation

(back to description)

Raw xml

Source view


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-CodingRationale"/>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><h2>CodingRationale</h2><div><p>Identifies how to interpret the instance of the code, codeSystem value in a set of translations. Since HL7 (or a government body) may mandate that codes from certain code systems be sent in conformant messages, other synonyms that are sent in the translation set need to be distinguished among the originally captured source, the HL7 specified code, or some future role. When this code is NULL, it indicates that the translation is an undefined type. When valued, this property must contain one of the following values:</p>
<p>SRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination)</p>
<p>There may be additional values added to this value set as we work through the use of codes in messages and determine other Use Cases requiring special interpretation of the translations.</p>
</div><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>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></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-CodingRationale 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><td><b>internalId</b></td><td><b>status</b></td></tr><tr><td style="white-space:nowrap">O<a name="v3-CodingRationale-O"> </a></td><td>originally produced code</td><td>**Description:** Originally produced code.</td><td>22615</td><td>active</td></tr><tr><td style="white-space:nowrap">OR<a name="v3-CodingRationale-OR"> </a></td><td>original and required</td><td>Originally produced code, required by the specification describing the use of the coded concept.</td><td>23533</td><td>active</td></tr><tr><td style="white-space:nowrap">P<a name="v3-CodingRationale-P"> </a></td><td>post-coded</td><td>**Description:** Post-coded from free text source&lt;/description&gt;</td><td>22617</td><td>active</td></tr><tr><td style="white-space:nowrap">PR<a name="v3-CodingRationale-PR"> </a></td><td>post-coded and required</td><td>Post-coded from free text source, required by the specification describing the use of the coded concept.</td><td>23534</td><td>active</td></tr><tr><td style="white-space:nowrap">R<a name="v3-CodingRationale-R"> </a></td><td>required</td><td>**Description:** Required standard code for HL7.</td><td>22616</td><td>active</td></tr><tr><td style="white-space:nowrap">HL7<a name="v3-CodingRationale-HL7"> </a></td><td>HL7 Specified or Mandated</td><td>HL7 Specified or Mandated</td><td>19252</td><td>retired</td></tr><tr><td style="white-space:nowrap">SH<a name="v3-CodingRationale-SH"> </a></td><td>Both HL7 mandated and the original code</td><td>Both HL7 mandated and the original code (precoordination)</td><td>19253</td><td>retired</td></tr><tr><td style="white-space:nowrap">SRC<a name="v3-CodingRationale-SRC"> </a></td><td>Source (or original) code</td><td>Source (or original) code</td><td>19251</td><td>retired</td></tr></table></div>
  </text>
  <url value="http://terminology.hl7.org/CodeSystem/v3-CodingRationale"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.5.1074"/>
  </identifier>
  <version value="2.0.0"/>
  <name value="CodingRationale"/>
  <title value="CodingRationale"/>
  <status value="active"/>
  <date value="2019-03-20T00:00:00-04:00"/>
  <publisher value="HL7 International"/>
  <contact>
    <name value="Health Level Seven, Inc."/>
  </contact>
  <description
               value="Identifies how to interpret the instance of the code, codeSystem value in a set of translations. Since HL7 (or a government body) may mandate that codes from certain code systems be sent in conformant messages, other synonyms that are sent in the translation set need to be distinguished among the originally captured source, the HL7 specified code, or some future role. When this code is NULL, it indicates that the translation is an undefined type. When valued, this property must contain one of the following values:

SRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination)

There may be additional values added to this value set as we work through the use of codes in messages and determine other Use Cases requiring special interpretation of the translations."/>
  <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="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>
  <concept>
    <code value="O"/>
    <display value="originally produced code"/>
    <definition value="**Description:** Originally produced code."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="22615"/>
    </property>
  </concept>
  <concept>
    <code value="OR"/>
    <display value="original and required"/>
    <definition
                value="Originally produced code, required by the specification describing the use of the coded concept."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="23533"/>
    </property>
  </concept>
  <concept>
    <code value="P"/>
    <display value="post-coded"/>
    <definition
                value="**Description:** Post-coded from free text source&lt;/description&gt;"/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="22617"/>
    </property>
  </concept>
  <concept>
    <code value="PR"/>
    <display value="post-coded and required"/>
    <definition
                value="Post-coded from free text source, required by the specification describing the use of the coded concept."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="23534"/>
    </property>
  </concept>
  <concept>
    <code value="R"/>
    <display value="required"/>
    <definition value="**Description:** Required standard code for HL7."/>
    <property>
      <code value="status"/>
      <valueCode value="active"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="22616"/>
    </property>
  </concept>
  <concept>
    <code value="HL7"/>
    <display value="HL7 Specified or Mandated"/>
    <definition value="HL7 Specified or Mandated"/>
    <property>
      <code value="status"/>
      <valueCode value="retired"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="19252"/>
    </property>
  </concept>
  <concept>
    <code value="SH"/>
    <display value="Both HL7 mandated and the original code"/>
    <definition
                value="Both HL7 mandated and the original code (precoordination)"/>
    <property>
      <code value="status"/>
      <valueCode value="retired"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="19253"/>
    </property>
  </concept>
  <concept>
    <code value="SRC"/>
    <display value="Source (or original) code"/>
    <definition value="Source (or original) code"/>
    <property>
      <code value="status"/>
      <valueCode value="retired"/>
    </property>
    <property>
      <code value="internalId"/>
      <valueCode value="19251"/>
    </property>
  </concept>
</CodeSystem>