R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #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

V3-CodingRationale.cs.json

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

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

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.

{
  "resourceType" : "CodeSystem",
  "id" : "v3-CodingRationale",
  "meta" : {
    "lastUpdated" : "2018-08-12T00:00:00.000+10:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueString" : "External"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0
  }],
  "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" : "2018-08-12",
  "name" : "v3.CodingRationale",
  "title" : "v3 Code System CodingRationale",
  "status" : "active",
  "experimental" : false,
  "date" : "2018-08-12T00:00:00+10:00",
  "publisher" : "HL7, Inc",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org"
    }]
  }],
  "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: 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.",
  "caseSensitive" : true,
  "valueSet" : "http://terminology.hl7.org/ValueSet/v3-CodingRationale",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "property" : [{
    "code" : "status",
    "uri" : "http://hl7.org/fhir/concept-properties#status",
    "description" : "A property that indicates the status of the concept. One of active, experimental, deprecated, retired",
    "type" : "code"
  }],
  "concept" : [{
    "code" : "O",
    "display" : "originally produced code",
    "definition" : "Description: Originally produced code."
  },
  {
    "code" : "OR",
    "display" : "original and required",
    "definition" : "Originally produced code, required by the specification describing the use of the coded concept."
  },
  {
    "code" : "P",
    "display" : "post-coded",
    "definition" : "Description: Post-coded from free text source</description>"
  },
  {
    "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."
  },
  {
    "code" : "R",
    "display" : "required",
    "definition" : "Description: Required standard code for HL7."
  },
  {
    "code" : "HL7",
    "display" : "HL7 Specified or Mandated",
    "definition" : "HL7 Specified or Mandated",
    "property" : [{
      "code" : "status",
      "valueCode" : "retired"
    }]
  },
  {
    "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" : "SRC",
    "display" : "Source (or original) code",
    "definition" : "Source (or original) code",
    "property" : [{
      "code" : "status",
      "valueCode" : "retired"
    }]
  }]
}

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.