Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: CE - XML Profile

Active as of 2024-06-19

XML representation of the CE logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CE"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
    <valueCode value="can-bind"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style">
    <valueCode value="CDA"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
  <version value="2.0.0-sd-202406-matchbox-patch"/>
  <name value="CE"/>
  <title value="CE: CodedWithEquivalents (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-06-19T17:47:42+02:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="Coded data that consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="CE">
      <path value="CE"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="CE.nullFlavor">
      <path value="CE.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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="CE.code">
      <path value="CE.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="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
    </element>
    <element id="CE.codeSystem">
      <path value="CE.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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
      </type>
    </element>
    <element id="CE.codeSystemName">
      <path value="CE.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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="CE.codeSystemVersion">
      <path value="CE.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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="CE.displayName">
      <path value="CE.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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="CE.sdtcValueSet">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
        <valueString value="valueSet"/>
      </extension>
      <path value="CE.sdtcValueSet"/>
      <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"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
      </type>
    </element>
    <element id="CE.sdtcValueSetVersion">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
        <valueString value="valueSetVersion"/>
      </extension>
      <path value="CE.sdtcValueSetVersion"/>
      <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.sdtcValueSetVersion"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="CE.originalText">
      <path value="CE.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/cda/stds/core/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="CE.qualifier">
      <path value="CE.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/cda/stds/core/StructureDefinition/CR"/>
      </type>
    </element>
    <element id="CE.translation">
      <path value="CE.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="*"/>
      <base>
        <path value="CD.translation"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="CE">
      <path value="CE"/>
      <definition
                  value="Coded data, consists of a coded value (CV) and, optionally, coded value(s) from other coding systems that identify the same concept. Used when alternative codes may exist."/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element id="CE.qualifier">
      <path value="CE.qualifier"/>
      <label value="Qualifier"/>
      <definition
                  value="Specifies additional codes that increase the specificity of the the primary code."/>
      <min value="0"/>
      <max value="0"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
      </type>
    </element>
  </differential>
</StructureDefinition>