Definition for Code SystemConceptProperties

{
  "resourceType" : "CodeSystem",
  "id" : "concept-properties",
  "meta" : {
    "lastUpdated" : "2025-03-18T13:49:06.036+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem concept-properties</b></p><a name=\"concept-properties\"> </a><a name=\"hcconcept-properties\"> </a><a name=\"concept-properties-en-US\"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td><td><b>Value Set</b></td></tr><tr><td>dataType</td><td>dataType</td><td>http://hl7.org/fhir/concept-properties#dataType</td><td>code</td><td>data type of property value</td><td/></tr><tr><td>Status</td><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>code</td><td>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</td><td><a href=\"valueset-concept-property-type.html\">Property Type</a></td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/concept-properties</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><td><b>dataType</b></td><td><b>Status</b></td></tr><tr><td style=\"white-space:nowrap\">status<a name=\"concept-properties-status\"> </a></td><td>Status</td><td><div><p>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</p>\n</div></td><td>code</td><td/></tr><tr><td style=\"white-space:nowrap\">inactive<a name=\"concept-properties-inactive\"> </a></td><td>Inactive</td><td><div><p>True if the concept is not considered active - e.g. not a valid concept any more. Property type is boolean, default value is false. Note that the status property may also be used to indicate that a concept is inactive</p>\n</div></td><td>boolean</td><td/></tr><tr><td style=\"white-space:nowrap\">effectiveDate<a name=\"concept-properties-effectiveDate\"> </a></td><td>effectiveDate</td><td><div><p>The date at which the concept status was last changed</p>\n</div></td><td>dateTime</td><td/></tr><tr style=\"background-color: #ffeeee\"><td style=\"white-space:nowrap\">deprecated<a name=\"concept-properties-deprecated\"> </a></td><td>Deprecated</td><td><div><p>The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated. This property is itself deprecated due to potential confusion with status - use deprecationDate instead</p>\n</div></td><td>dateTime</td><td>deprecated</td></tr><tr><td style=\"white-space:nowrap\">deprecationDate<a name=\"concept-properties-deprecationDate\"> </a></td><td>Deprecation Date</td><td><div><p>The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated</p>\n</div></td><td>dateTime</td><td/></tr><tr><td style=\"white-space:nowrap\">retirementDate<a name=\"concept-properties-retirementDate\"> </a></td><td>Retirement Date</td><td><div><p>The date at which a concept was retired</p>\n</div></td><td>dateTime</td><td/></tr><tr><td style=\"white-space:nowrap\">notSelectable<a name=\"concept-properties-notSelectable\"> </a></td><td>Not Selectable</td><td><div><p>The concept is not intended to be chosen by the user - only intended to be used as a selector for other concepts. Note, though, that the interpretation of this is highly contextual; all concepts are selectable in some context. Property type is boolean, default value is false</p>\n</div></td><td>boolean</td><td/></tr><tr><td style=\"white-space:nowrap\">parent<a name=\"concept-properties-parent\"> </a></td><td>Parent</td><td><div><p>The concept identified in this property is a parent of the concept on which it is a property. The property type will be 'code'. The meaning of 'parent' is defined by the hierarchyMeaning attribute</p>\n</div></td><td>code</td><td/></tr><tr><td style=\"white-space:nowrap\">child<a name=\"concept-properties-child\"> </a></td><td>Child</td><td><div><p>The concept identified in this property is a child of the concept on which it is a property. The property type will be 'code'. The meaning of 'child' is defined by the hierarchyMeaning attribute</p>\n</div></td><td>code</td><td/></tr><tr><td style=\"white-space:nowrap\">partOf<a name=\"concept-properties-partOf\"> </a></td><td>Part Of</td><td><div><p>The concept identified in this property (by its code) contains this concept as a component (i.e. a part-of relationship rather than a subsumption relationship such as elbow is part-of arm</p>\n</div></td><td>code</td><td/></tr><tr style=\"background-color: #ffeeee\"><td style=\"white-space:nowrap\">synonym<a name=\"concept-properties-synonym\"> </a></td><td>Synonym</td><td><div><p>This property contains an alternative code that may be used to identify this concept instead of the primary code. Synonyms should not be used due to the operational complexity they introduce - see alternateCode</p>\n</div></td><td>code</td><td>deprecated</td></tr><tr><td style=\"white-space:nowrap\">alternateCode<a name=\"concept-properties-alternateCode\"> </a></td><td>Alternate Code</td><td><div><p>This property contains the code for another representation of this concept, with the same real-world meaning, in this code system.</p>\n</div></td><td>code</td><td/></tr><tr><td style=\"white-space:nowrap\">comment<a name=\"concept-properties-comment\"> </a></td><td>Comment</td><td><div><p>A string that provides additional detail pertinent to the use or understanding of the concept</p>\n</div></td><td>string</td><td/></tr><tr><td style=\"white-space:nowrap\">itemWeight<a name=\"concept-properties-itemWeight\"> </a></td><td>itemWeight</td><td><div><p>A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the <a href=\"https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-itemWeight.html\">http://hl7.org/fhir/StructureDefinition/itemWeight</a> extension</p>\n</div></td><td>decimal</td><td/></tr><tr><td style=\"white-space:nowrap\">order<a name=\"concept-properties-order\"> </a></td><td>Order</td><td><div><p>Order of the concept amongst sibling concepts as a decimal value</p>\n</div></td><td>decimal</td><td/></tr><tr><td style=\"white-space:nowrap\">definition<a name=\"concept-properties-definition\"> </a></td><td>Definition</td><td><div><p>A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the <a href=\"https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-itemWeight.html\">http://hl7.org/fhir/StructureDefinition/itemWeight</a> extension</p>\n</div></td><td>string</td><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-fmm",
    "valueInteger" : 4
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-use-markdown",
    "valueBoolean" : true
  }],
  "url" : "http://hl7.org/fhir/concept-properties",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1826"
  }],
  "version" : "6.0.0-ballot2",
  "name" : "ConceptProperties",
  "title" : "FHIR Defined Concept Properties",
  "status" : "draft",
  "experimental" : false,
  "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" : "A set of common concept properties for use on coded systems throughout the FHIR eco-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/concept-properties",
  "content" : "complete",
  "property" : [{
    "code" : "dataType",
    "uri" : "http://hl7.org/fhir/concept-properties#dataType",
    "description" : "data type of property value",
    "type" : "code"
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-property-valueset",
      "valueCanonical" : "http://hl7.org/fhir/ValueSet/concept-property-type"
    }],
    "code" : "status",
    "uri" : "http://hl7.org/fhir/concept-properties#status",
    "description" : "A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired",
    "type" : "code"
  }],
  "concept" : [{
    "code" : "status",
    "display" : "Status",
    "definition" : "A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    }]
  },
  {
    "id" : "t1",
    "code" : "inactive",
    "display" : "Inactive",
    "definition" : "True if the concept is not considered active - e.g. not a valid concept any more. Property type is boolean, default value is false. Note that the status property may also be used to indicate that a concept is inactive",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "boolean"
    }]
  },
  {
    "code" : "effectiveDate",
    "display" : "effectiveDate",
    "definition" : "The date at which the concept status was last changed",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "dateTime"
    }]
  },
  {
    "code" : "deprecated",
    "display" : "Deprecated",
    "definition" : "The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated. This property is itself deprecated due to potential confusion with status - use deprecationDate instead",
    "property" : [{
      "code" : "status",
      "valueCode" : "deprecated"
    },
    {
      "code" : "dataType",
      "valueCode" : "dateTime"
    }]
  },
  {
    "code" : "deprecationDate",
    "display" : "Deprecation Date",
    "definition" : "The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "dateTime"
    }]
  },
  {
    "code" : "retirementDate",
    "display" : "Retirement Date",
    "definition" : "The date at which a concept was retired",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "dateTime"
    }]
  },
  {
    "code" : "notSelectable",
    "display" : "Not Selectable",
    "definition" : "The concept is not intended to be chosen by the user - only intended to be used as a selector for other concepts. Note, though, that the interpretation of this is highly contextual; all concepts are selectable in some context. Property type is boolean, default value is false",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "boolean"
    }]
  },
  {
    "code" : "parent",
    "display" : "Parent",
    "definition" : "The concept identified in this property is a parent of the concept on which it is a property. The property type will be 'code'. The meaning of 'parent' is defined by the hierarchyMeaning attribute",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    }]
  },
  {
    "code" : "child",
    "display" : "Child",
    "definition" : "The concept identified in this property is a child of the concept on which it is a property. The property type will be 'code'. The meaning of 'child' is defined by the hierarchyMeaning attribute",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    }]
  },
  {
    "code" : "partOf",
    "display" : "Part Of",
    "definition" : "The concept identified in this property (by its code) contains this concept as a component (i.e. a part-of relationship rather than a subsumption relationship such as elbow is part-of arm",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    }]
  },
  {
    "code" : "synonym",
    "display" : "Synonym",
    "definition" : "This property contains an alternative code that may be used to identify this concept instead of the primary code. Synonyms should not be used due to the operational complexity they introduce - see alternateCode",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    },
    {
      "code" : "status",
      "valueCode" : "deprecated"
    },
    {
      "code" : "deprecationDate",
      "valueCode" : "2025-03-14"
    }]
  },
  {
    "code" : "alternateCode",
    "display" : "Alternate Code",
    "definition" : "This property contains the code for another representation of this concept, with the same real-world meaning, in this code system.",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "code"
    }]
  },
  {
    "code" : "comment",
    "display" : "Comment",
    "definition" : "A string that provides additional detail pertinent to the use or understanding of the concept",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "string"
    }]
  },
  {
    "code" : "itemWeight",
    "display" : "itemWeight",
    "definition" : "A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the [[[http://hl7.org/fhir/StructureDefinition/itemWeight]]] extension",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "decimal"
    }]
  },
  {
    "code" : "order",
    "display" : "Order",
    "definition" : "Order of the concept amongst sibling concepts as a decimal value",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "decimal"
    }]
  },
  {
    "code" : "definition",
    "display" : "Definition",
    "definition" : "A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the [[[http://hl7.org/fhir/StructureDefinition/itemWeight]]] extension",
    "property" : [{
      "code" : "dataType",
      "valueCode" : "string"
    }]
  }]
}