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 - JSON Representation

(back to description)

Raw json

Source view

{
  "resourceType" : "CodeSystem",
  "id" : "v3-CodingRationale",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n<p>SRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination)</p>\n<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>\n</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>"
  },
  "url" : "http://terminology.hl7.org/CodeSystem/v3-CodingRationale",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.5.1074"
    }
  ],
  "version" : "2.0.0",
  "name" : "CodingRationale",
  "title" : "CodingRationale",
  "status" : "active",
  "date" : "2019-03-20T00:00:00-04:00",
  "publisher" : "HL7 International",
  "contact" : [
    {
      "name" : "Health Level Seven, Inc."
    }
  ],
  "description" : "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:\r\n\r\nSRC - Source (or original) code HL7 - HL7 Specified or Mandated SH - both HL7 mandated and the original code (precoordination)\r\n\r\nThere 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" : "is-a",
  "content" : "complete",
  "property" : [
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Specializes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Generalizes"
        }
      ],
      "code" : "Specializes",
      "description" : "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" : "Coding"
    },
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Generalizes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Specializes"
        }
      ],
      "code" : "Generalizes",
      "description" : "Inverse of Specializes.  Only included as a derived relationship.",
      "type" : "Coding"
    },
    {
      "code" : "internalId",
      "uri" : "http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id",
      "description" : "The internal identifier for the concept in the HL7 Access database repository.",
      "type" : "code"
    },
    {
      "code" : "status",
      "uri" : "http://hl7.org/fhir/concept-properties#status",
      "description" : "Designation of a concept's state.  Normally is not populated unless the state is retired..",
      "type" : "code"
    }
  ],
  "concept" : [
    {
      "code" : "O",
      "display" : "originally produced code",
      "definition" : "**Description:** Originally produced code.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22615"
        }
      ]
    },
    {
      "code" : "OR",
      "display" : "original and required",
      "definition" : "Originally produced code, required by the specification describing the use of the coded concept.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "23533"
        }
      ]
    },
    {
      "code" : "P",
      "display" : "post-coded",
      "definition" : "**Description:** Post-coded from free text source</description>",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22617"
        }
      ]
    },
    {
      "code" : "PR",
      "display" : "post-coded and required",
      "definition" : "Post-coded from free text source, required by the specification describing the use of the coded concept.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "23534"
        }
      ]
    },
    {
      "code" : "R",
      "display" : "required",
      "definition" : "**Description:** Required standard code for HL7.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22616"
        }
      ]
    },
    {
      "code" : "HL7",
      "display" : "HL7 Specified or Mandated",
      "definition" : "HL7 Specified or Mandated",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "19252"
        }
      ]
    },
    {
      "code" : "SH",
      "display" : "Both HL7 mandated and the original code",
      "definition" : "Both HL7 mandated and the original code (precoordination)",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "19253"
        }
      ]
    },
    {
      "code" : "SRC",
      "display" : "Source (or original) code",
      "definition" : "Source (or original) code",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "19251"
        }
      ]
    }
  ]
}