DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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: R4 R3 R2

V3-CodingRationale.xml

Raw XML (canonical form)

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.

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-CodingRationale"/>
  <meta>
    <lastUpdated value="2015-07-31T00:00:00.000+10:00"/>
    <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Release Date: 2015-07-31</p>

      <p>OID for code system: 2.16.840.1.113883.5.1074</p>

      <p>OID for value set: 2.16.840.1.113883.1.11.19250 (this is the value set that includes the
           entire code system)</p>

      <h2>Description</h2>

      <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:
        <br/>

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

                  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.
        <br/>

               
      </p>

      <hr/>

      <table class="grid">
 
        <tr>
          <td>
            <b>Level</b>
          </td>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>O
            <a name="O"> </a>
          </td>
          <td>originally produced code</td>
          <td>
                        
                           Description: Originally produced code.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>OR
            <a name="OR"> </a>
          </td>
          <td>original and required</td>
          <td>
                        Originally produced code, required by the specification describing
               the use of the coded concept.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>P
            <a name="P"> </a>
          </td>
          <td>post-coded</td>
          <td>
                        
                           Description: Post-coded from free text source&lt;/description&gt;
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>PR
            <a name="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.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>R
            <a name="R"> </a>
          </td>
          <td>required</td>
          <td>
                        
                           Description: Required standard code for HL7.
            <br/>

                     
          </td>
        </tr>
 
        <tr style="background: #EFEFEF">
          <td>1</td>
          <td>HL7
            <a name="HL7"> </a> 
            <b>
              <i>Deprecated</i>
            </b>
          </td>
          <td>HL7 Specified or Mandated</td>
          <td>
                        HL7 Specified or Mandated
            <br/>

                     
          </td>
        </tr>
 
        <tr style="background: #EFEFEF">
          <td>1</td>
          <td>SH
            <a name="SH"> </a> 
            <b>
              <i>Deprecated</i>
            </b>
          </td>
          <td>Both HL7 mandated and the original code</td>
          <td>
                        Both HL7 mandated and the original code (precoordination)
            <br/>

                     
          </td>
        </tr>
 
        <tr style="background: #EFEFEF">
          <td>1</td>
          <td>SRC
            <a name="SRC"> </a> 
            <b>
              <i>Deprecated</i>
            </b>
          </td>
          <td>Source (or original) code</td>
          <td>
                        Source (or original) code
            <br/>

                     
          </td>
        </tr>

      </table>

    </div>
  </text>
  <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
    <valueUri value="urn:oid:2.16.840.1.113883.1.11.19250"/>
  </extension>
  <url value="http://hl7.org/fhir/ValueSet/v3-CodingRationale"/>
  <version value="2015-07-31"/>
  <name value="v3 Code System CodingRationale"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7, Inc"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <date value="2015-07-31"/>
  <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."/>
  <codeSystem>
    <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
      <valueUri value="urn:oid:2.16.840.1.113883.5.1074"/>
    </extension>
    <system value="http://hl7.org/fhir/v3/CodingRationale"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="O"/>
      <abstract value="false"/>
      <display value="originally produced code"/>
      <definition value="Description: Originally produced code."/>
    </concept>
    <concept>
      <code value="OR"/>
      <abstract value="false"/>
      <display value="original and required"/>
      <definition value="Originally produced code, required by the specification describing the use of the coded
         concept."/>
    </concept>
    <concept>
      <code value="P"/>
      <abstract value="false"/>
      <display value="post-coded"/>
      <definition value="Description: Post-coded from free text source&lt;/description&gt;"/>
    </concept>
    <concept>
      <code value="PR"/>
      <abstract value="false"/>
      <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."/>
    </concept>
    <concept>
      <code value="R"/>
      <abstract value="false"/>
      <display value="required"/>
      <definition value="Description: Required standard code for HL7."/>
    </concept>
    <concept>
      <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated">
        <valueBoolean value="true"/>
      </extension>
      <code value="HL7"/>
      <abstract value="false"/>
      <display value="HL7 Specified or Mandated"/>
      <definition value="HL7 Specified or Mandated"/>
    </concept>
    <concept>
      <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated">
        <valueBoolean value="true"/>
      </extension>
      <code value="SH"/>
      <abstract value="false"/>
      <display value="Both HL7 mandated and the original code"/>
      <definition value="Both HL7 mandated and the original code (precoordination)"/>
    </concept>
    <concept>
      <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated">
        <valueBoolean value="true"/>
      </extension>
      <code value="SRC"/>
      <abstract value="false"/>
      <display value="Source (or original) code"/>
      <definition value="Source (or original) code"/>
    </concept>
  </codeSystem>
</ValueSet>

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.