Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CO - XML Profile

XML representation of the CO logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CO"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/cda/StructureDefinition/CO"/>
  <version value="2.1.0"/>
  <name value="CO"/>
  <title value="CO: CodedOrdinal (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2021-04-15T20:51:17+00:00"/>
  <publisher value="Health Level 7"/>
  <description
               value="Coded data, where the coding system from which the code comes is ordered"/>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="CO"/>
  <baseDefinition value="http://hl7.org/fhir/cda/StructureDefinition/CV"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="CO">
      <path value="CO"/>
      <definition
                  value="Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
    </element>
    <element id="CO.nullFlavor">
      <path value="CO.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"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
      </binding>
    </element>
    <element id="CO.code">
      <path value="CO.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"/>
      <base>
        <path value="CD.code"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.codeSystem">
      <path value="CO.codeSystem"/>
      <representation value="xmlAttr"/>
      <label value="Code System"/>
      <definition value="Specifies the code system that defines the code."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="CD.codeSystem"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.codeSystemName">
      <path value="CO.codeSystemName"/>
      <representation value="xmlAttr"/>
      <label value="Code System Name"/>
      <definition value="The common name of the coding system."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="CD.codeSystemName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.codeSystemVersion">
      <path value="CO.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"/>
      <base>
        <path value="CD.codeSystemVersion"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.displayName">
      <path value="CO.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"/>
      <base>
        <path value="CD.displayName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.valueSet">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="CO.valueSet"/>
      <representation value="xmlAttr"/>
      <definition
                  value="The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="CD.valueSet"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.valueSetVersion">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="CO.valueSetVersion"/>
      <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"/>
      <base>
        <path value="CD.valueSetVersion"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="CO.originalText">
      <path value="CO.originalText"/>
      <label value="Original Text"/>
      <definition value="The text or phrase used as the basis for the coding."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="CD.originalText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="CO.qualifier">
      <path value="CO.qualifier"/>
      <label value="Qualifier"/>
      <definition
                  value="Specifies additional codes that increase the specificity of the the primary code."/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="CD.qualifier"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CR"/>
      </type>
    </element>
    <element id="CO.translation">
      <path value="CO.translation"/>
      <representation value="typeAttr"/>
      <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="0"/>
      <base>
        <path value="CD.translation"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CD"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="CO">
      <path value="CO"/>
      <definition
                  value="Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain."/>
      <min value="1"/>
      <max value="*"/>
    </element>
  </differential>
</StructureDefinition>