R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example CodeSystem/codesystem-hierarchy-meaning (JSON)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemCodeSystemHierarchyMeaning

{
  "resourceType" : "CodeSystem",
  "id" : "codesystem-hierarchy-meaning",
  "meta" : {
    "lastUpdated" : "2023-12-18T15:12:07.602+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This case-sensitive code system <code>http://hl7.org/fhir/codesystem-hierarchy-meaning</code> 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></tr><tr><td style=\"white-space:nowrap\">grouped-by<a name=\"codesystem-hierarchy-meaning-grouped-by\"> </a></td><td>Grouped By</td><td>No particular relationship between the concepts can be assumed, except what can be determined by inspection of the definitions of the elements (possible reasons to use this: importing from a source where this is not defined, or where various parts of the hierarchy have different meanings).</td></tr><tr><td style=\"white-space:nowrap\">is-a<a name=\"codesystem-hierarchy-meaning-is-a\"> </a></td><td>Is-A</td><td>A hierarchy where the child concepts have an IS-A relationship with the parents - that is, all the properties of the parent are also true for its child concepts. Not that is-a is a property of the concepts, so additional subsumption relationships may be defined using properties.</td></tr><tr><td style=\"white-space:nowrap\">part-of<a name=\"codesystem-hierarchy-meaning-part-of\"> </a></td><td>Part Of</td><td>Child elements list the individual parts of a composite whole (e.g. body site).</td></tr><tr><td style=\"white-space:nowrap\">classified-with<a name=\"codesystem-hierarchy-meaning-classified-with\"> </a></td><td>Classified With</td><td>Child concepts in the hierarchy may have only one parent, and there is a presumption that the code system is a &quot;closed world&quot; meaning all things must be in the hierarchy. This results in concepts such as &quot;not otherwise classified.&quot;.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/codesystem-hierarchy-meaning",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.785"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.768"
  }],
  "version" : "6.0.0-ballot1",
  "name" : "CodeSystemHierarchyMeaning",
  "title" : "Code System Hierarchy Meaning",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab/index.cfm"
    }]
  }],
  "description" : "The meaning of the hierarchy of concepts in a code system.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning",
  "content" : "complete",
  "concept" : [{
    "code" : "grouped-by",
    "display" : "Grouped By",
    "definition" : "No particular relationship between the concepts can be assumed, except what can be determined by inspection of the definitions of the elements (possible reasons to use this: importing from a source where this is not defined, or where various parts of the hierarchy have different meanings)."
  },
  {
    "code" : "is-a",
    "display" : "Is-A",
    "definition" : "A hierarchy where the child concepts have an IS-A relationship with the parents - that is, all the properties of the parent are also true for its child concepts. Not that is-a is a property of the concepts, so additional subsumption relationships may be defined using properties."
  },
  {
    "code" : "part-of",
    "display" : "Part Of",
    "definition" : "Child elements list the individual parts of a composite whole (e.g. body site)."
  },
  {
    "code" : "classified-with",
    "display" : "Classified With",
    "definition" : "Child concepts in the hierarchy may have only one parent, and there is a presumption that the code system is a \"closed world\" meaning all things must be in the hierarchy. This results in concepts such as \"not otherwise classified.\"."
  }]
}

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.