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 (XML)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemConceptProperties

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="concept-properties"/> 
  <meta> 
    <lastUpdated value="2022-09-10T04:52:37.223+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <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> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="4"/> 
  </extension> 
  <url value="http://hl7.org/fhir/concept-properties"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.1826"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="ConceptProperties"/> 
  <title value="FHIR Defined Concept Properties"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <publisher value="FHIR Project"/> 
  <description value="A set of common concept properties for use on coded systems throughout the FHIR
   eco-system."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/concept-properties"/> 
  <content value="complete"/> 
  <property> 
    <code value="status"/> 
    <uri value="http://hl7.org/fhir/concept-properties#status"/> 
    <description value="A code that indicates the status of the concept. Typical values are active, experimental,
     deprecated, and retired"/> 
    <type value="code"/> 
  </property> 
  <concept> 
    <code value="status"/> 
    <display value="Status"/> 
    <definition value="A code that indicates the status of the concept. Typical values are active, experimental,
     deprecated, and retired"/> 
  </concept> 
  <concept id="t1">
    <code value="inactive"/> 
    <display value="Inactive"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="effectiveDate"/> 
    <display value="effectiveDate"/> 
    <definition value="The date at which the concept was status was last changed"/> 
  </concept> 
  <concept> 
    <code value="deprecated"/> 
    <display value="Deprecated"/> 
    <definition value="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 value="status"/> 
      <valueCode value="deprecated"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="deprecationDate"/> 
    <display value="Deprecation Date"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="retirementDate"/> 
    <display value="Retirement Date"/> 
    <definition value="The date at which a concept was retired"/> 
  </concept> 
  <concept> 
    <code value="notSelectable"/> 
    <display value="Not Selectable"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="parent"/> 
    <display value="Parent"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="child"/> 
    <display value="Child"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="partOf"/> 
    <display value="Part Of"/> 
    <definition value="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"/> 
  </concept> 
  <concept> 
    <code value="synonym"/> 
    <display value="Synonym"/> 
    <definition value="This property contains an alternative code that may be used to identify this concept
     instead of the primary code"/> 
  </concept> 
  <concept> 
    <code value="comment"/> 
    <display value="Comment"/> 
    <definition value="A string that provides additional detail pertinent to the use or understanding
     of the concept"/> 
  </concept> 
</CodeSystem> 

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.