STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/CD.xml

Raw XML (canonical form)

Logical Model V3 Data type CD (ConceptDescriptor)

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CD"/>
  <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/CD"/>
  <name value="V3 Data type CD (ConceptDescriptor)"/>
  <display value="V3 Data type CD (ConceptDescriptor)"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7"/>
  <description value="A concept descriptor represents any kind of concept usually by giving a code defined in
   a code system. A concept descriptor can contain the original text or phrase that served
   as the basis of the coding and one or more translations into different coding systems.
   A concept descriptor can also contain qualifiers to describe, e.g., the concept of a &quot;left
   foot&quot; as a postcoordinated term built from the primary code &quot;FOOT&quot; and
   the qualifier &quot;LEFT&quot;. In cases of an exceptional value, the concept descriptor
   need not contain a code but only the original text describing that concept."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ANY"/>
  <snapshot>
    <element>
      <path value="CD"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="CD.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper
       information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="CD.code"/>
      <representation value="xmlAttr"/>
      <label value="Code"/>
      <definition value="The plain code symbol defined by the code system. For example, &quot;784.0&quot; is the
       code symbol of the ICD-9 code &quot;784.0&quot; for headache."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystem"/>
      <representation value="xmlAttr"/>
      <label value="Code System"/>
      <definition value="Specifies the code system that defines the code."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystemName"/>
      <representation value="xmlAttr"/>
      <label value="Code System Name"/>
      <definition value="The common name of the coding system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystemVersion"/>
      <representation value="xmlAttr"/>
      <label value="Code System Version"/>
      <definition value="If applicable, a version descriptor defined specifically for the given code system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.displayName"/>
      <representation value="xmlAttr"/>
      <label value="Display Name"/>
      <definition value="A name or title for the code, under which the sending system shows the code value to its
       users."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.originalText"/>
      <label value="Original Text"/>
      <definition value="The text or phrase used as the basis for the coding."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="ED"/>
      </type>
    </element>
    <element>
      <path value="CD.translation"/>
      <label value="Translation"/>
      <definition value="A set of other concept descriptors that translate this concept descriptor into other code
       systems."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CD"/>
      </type>
    </element>
    <element>
      <path value="CD.qualifier"/>
      <label value="Qualifier"/>
      <definition value="Specifies additional codes that increase the specificity of the the primary code."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CR"/>
      </type>
    </element>
    <element>
      <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="CD.valueSetVersion"/>
      <representation value="xmlAttr"/>
      <representation value="xmlAttr"/>
      <definition value="The valueSetVersion extension adds an attribute for elements with a CD dataType which
       indicates the version of the particular value set constraining the coded concept."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code value="string"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="CD"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="CD.code"/>
      <representation value="xmlAttr"/>
      <label value="Code"/>
      <definition value="The plain code symbol defined by the code system. For example, &quot;784.0&quot; is the
       code symbol of the ICD-9 code &quot;784.0&quot; for headache."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystem"/>
      <representation value="xmlAttr"/>
      <label value="Code System"/>
      <definition value="Specifies the code system that defines the code."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystemName"/>
      <representation value="xmlAttr"/>
      <label value="Code System Name"/>
      <definition value="The common name of the coding system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.codeSystemVersion"/>
      <representation value="xmlAttr"/>
      <label value="Code System Version"/>
      <definition value="If applicable, a version descriptor defined specifically for the given code system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.displayName"/>
      <representation value="xmlAttr"/>
      <label value="Display Name"/>
      <definition value="A name or title for the code, under which the sending system shows the code value to its
       users."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="CD.originalText"/>
      <label value="Original Text"/>
      <definition value="The text or phrase used as the basis for the coding."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="ED"/>
      </type>
    </element>
    <element>
      <path value="CD.translation"/>
      <label value="Translation"/>
      <definition value="A set of other concept descriptors that translate this concept descriptor into other code
       systems."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CD"/>
      </type>
    </element>
    <element>
      <path value="CD.qualifier"/>
      <label value="Qualifier"/>
      <definition value="Specifies additional codes that increase the specificity of the the primary code."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CR"/>
      </type>
    </element>
    <element>
      <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="CD.valueSetVersion"/>
      <representation value="xmlAttr"/>
      <representation value="xmlAttr"/>
      <definition value="The valueSetVersion extension adds an attribute for elements with a CD dataType which
       indicates the version of the particular value set constraining the coded concept."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code value="string"/>
      </type>
    </element>
  </differential>
</StructureDefinition>

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.