Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: R5 R4B R4 R3

Example CodeSystem/concept-properties (JSON)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemConceptProperties

{
  "resourceType" : "CodeSystem",
  "id" : "concept-properties",
  "meta" : {
    "lastUpdated" : "2022-09-10T04:52:37.223+10:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><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></tr></table><p>This 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>Status</b></td></tr><tr><td style=\"white-space:nowrap\">status<a name=\"concept-properties-status\"> </a></td><td>Status</td><td>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</td><td/></tr><tr><td style=\"white-space:nowrap\">inactive<a name=\"concept-properties-inactive\"> </a></td><td>Inactive</td><td>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</td><td/></tr><tr><td style=\"white-space:nowrap\">effectiveDate<a name=\"concept-properties-effectiveDate\"> </a></td><td>effectiveDate</td><td>The date at which the concept was status was last changed</td><td/></tr><tr><td style=\"white-space:nowrap\">deprecated<a name=\"concept-properties-deprecated\"> </a></td><td>Deprecated</td><td>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</td><td>deprecated</td></tr><tr><td style=\"white-space:nowrap\">deprecationDate<a name=\"concept-properties-deprecationDate\"> </a></td><td>Deprecation Date</td><td>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</td><td/></tr><tr><td style=\"white-space:nowrap\">retirementDate<a name=\"concept-properties-retirementDate\"> </a></td><td>Retirement Date</td><td>The date at which a concept was retired</td><td/></tr><tr><td style=\"white-space:nowrap\">notSelectable<a name=\"concept-properties-notSelectable\"> </a></td><td>Not Selectable</td><td>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</td><td/></tr><tr><td style=\"white-space:nowrap\">parent<a name=\"concept-properties-parent\"> </a></td><td>Parent</td><td>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</td><td/></tr><tr><td style=\"white-space:nowrap\">child<a name=\"concept-properties-child\"> </a></td><td>Child</td><td>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</td><td/></tr><tr><td style=\"white-space:nowrap\">partOf<a name=\"concept-properties-partOf\"> </a></td><td>Part Of</td><td>The concept identified in this property (by it's 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</td><td/></tr><tr><td style=\"white-space:nowrap\">synonym<a name=\"concept-properties-synonym\"> </a></td><td>Synonym</td><td>This property contains an alternative code that may be used to identify this concept instead of the primary code</td><td/></tr><tr><td style=\"white-space:nowrap\">comment<a name=\"concept-properties-comment\"> </a></td><td>Comment</td><td>A string that provides additional detail pertinent to the use or understanding of the concept</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/concept-properties",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1826"
  }],
  "version" : "5.0.0-ballot",
  "name" : "ConceptProperties",
  "title" : "FHIR Defined Concept Properties",
  "status" : "draft",
  "experimental" : false,
  "publisher" : "FHIR Project",
  "description" : "A set of common concept properties for use on coded systems throughout the FHIR eco-system.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/concept-properties",
  "content" : "complete",
  "property" : [{
    "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"
  },
  {
    "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"
  },
  {
    "code" : "effectiveDate",
    "display" : "effectiveDate",
    "definition" : "The date at which the concept was status was last changed"
  },
  {
    "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",
    "property" : [{
      "code" : "status",
      "valueCode" : "deprecated"
    }]
  },
  {
    "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"
  },
  {
    "code" : "retirementDate",
    "display" : "Retirement Date",
    "definition" : "The date at which a concept was retired"
  },
  {
    "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"
  },
  {
    "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"
  },
  {
    "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"
  },
  {
    "code" : "partOf",
    "display" : "Part Of",
    "definition" : "The concept identified in this property (by it's 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"
  },
  {
    "code" : "synonym",
    "display" : "Synonym",
    "definition" : "This property contains an alternative code that may be used to identify this concept instead of the primary code"
  },
  {
    "code" : "comment",
    "display" : "Comment",
    "definition" : "A string that provides additional detail pertinent to the use or understanding of the concept"
  }]
}

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.