EHDS Logical Information Models
0.1.0 - ci-build

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/tree/stakeholder-consultation-D6-2 and changes regularly. See the Directory of published versions

## Data Type Profile: Coded - XML Profile

Draft as of 2025-05-26

XML representation of the Coded data type profile.

Raw xml | Download

    <StructureDefinition xmlns="http://hl7.org/fhir">
      <id value="Coded"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition Coded</b></p><a name="Coded"> </a><a name="hcCoded"> </a><a name="Coded-en-US"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64, " alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-Coded-definitions.html#CodeableConcept" title="Coded data element should have at least one code from a specified code system present">CodeableConcept</a><a name="CodeableConcept"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Coded</td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-Coded-definitions.html#CodeableConcept.coding">coding</a><a name="CodeableConcept.coding"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#Coding">Coding</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Code defined by a terminology system</span></td></tr>
    <tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64, " alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
        <valueCode value="can-bind"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
        <valueCode value="do-translations"/>
      </extension>
      <url
           value="https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/Coded"/>
      <version value="0.1.0"/>
      <name value="Coded"/>
      <status value="draft"/>
      <date value="2025-05-26T10:09:34+00:00"/>
      <publisher value="Xt-EHR"/>
      <contact>
        <name value="Xt-EHR"/>
        <telecom>
          <system value="url"/>
          <value value="http://Xt-EHR.eu"/>
        </telecom>
      </contact>
      <description value="Coded data element"/>
      <fhirVersion value="5.0.0"/>
      <mapping>
        <identity value="v2"/>
        <uri value="http://hl7.org/v2"/>
        <name value="HL7 V2 Mapping"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <uri value="http://hl7.org/v3"/>
        <name value="RIM Mapping"/>
      </mapping>
      <mapping>
        <identity value="orim"/>
        <uri value="http://hl7.org/orim"/>
        <name value="Ontological RIM Mapping"/>
      </mapping>
      <kind value="complex-type"/>
      <abstract value="false"/>
      <type value="CodeableConcept"/>
      <baseDefinition
                      value="http://hl7.org/fhir/StructureDefinition/CodeableConcept"/>
      <derivation value="constraint"/>
      <snapshot>
        <extension
                   url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
          <valueString value="5.0.0"/>
        </extension>
        <element id="CodeableConcept">
          <path value="CodeableConcept"/>
          <short value="Coded"/>
          <definition
                      value="Coded data element should have at least one code from a specified code system present"/>
          <comment
                   value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="CodeableConcept"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a,CD"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map value="CE/CNE/CWE"/>
          </mapping>
          <mapping>
            <identity value="orim"/>
            <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD"/>
          </mapping>
        </element>
        <element id="CodeableConcept.id">
          <path value="CodeableConcept.id"/>
          <representation value="xmlAttr"/>
          <short value="Unique id for inter-element referencing"/>
          <definition
                      value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Element.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="id"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <condition value="ele-1"/>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="CodeableConcept.extension">
          <path value="CodeableConcept.extension"/>
          <slicing>
            <discriminator>
              <type value="value"/>
              <path value="url"/>
            </discriminator>
            <description value="Extensions are always sliced by (at least) url"/>
            <rules value="open"/>
          </slicing>
          <short value="Additional content defined by implementations"/>
          <definition
                      value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
          <comment
                   value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="CodeableConcept.coding">
          <path value="CodeableConcept.coding"/>
          <short value="Code defined by a terminology system"/>
          <definition
                      value="A reference to a code defined by a terminology system."/>
          <comment
                   value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true."/>
          <requirements
                        value="Allows for alternative encodings within a code system, and translations to other code systems."/>
          <min value="1"/>
          <max value="*"/>
          <base>
            <path value="CodeableConcept.coding"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Coding"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="C*E.1-8, C*E.10-22"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="union(., ./translation)"/>
          </mapping>
          <mapping>
            <identity value="orim"/>
            <map
                 value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"/>
          </mapping>
        </element>
        <element id="CodeableConcept.text">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
            <valueBoolean value="true"/>
          </extension>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
            <valueBoolean value="true"/>
          </extension>
          <path value="CodeableConcept.text"/>
          <short value="Plain text representation of the concept"/>
          <definition
                      value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user."/>
          <comment
                   value="Very often the text is the same as a displayName of one of the codings."/>
          <requirements
                        value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="CodeableConcept.text"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="string"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="C*E.9. But note many systems use C*E.2 for this"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value="./originalText[mediaType/code=&quot;text/plain&quot;]/data"/>
          </mapping>
          <mapping>
            <identity value="orim"/>
            <map
                 value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"/>
          </mapping>
        </element>
      </snapshot>
      <differential>
        <element id="CodeableConcept">
          <path value="CodeableConcept"/>
          <short value="Coded"/>
          <definition
                      value="Coded data element should have at least one code from a specified code system present"/>
        </element>
        <element id="CodeableConcept.coding">
          <path value="CodeableConcept.coding"/>
          <min value="1"/>
        </element>
      </differential>
    </StructureDefinition>