EHDS Logical Information Models
0.2.1 - qa-preview

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

## Logical Model: EHDSPatient - XML Profile

Draft as of 2025-12-03

XML representation of the EHDSPatient logical model.

Raw xml | Download

    <StructureDefinition xmlns="http://hl7.org/fhir">
      <id value="EHDSPatient"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition EHDSPatient</b></p><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 : var(--ig-left,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 : var(--ig-left,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 : var(--ig-left,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="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; 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 : var(--ig-left,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,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" 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 : var(--ig-left,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-EHDSPatient-definitions.html#EHDSPatient">EHDSPatient</a><a name="EHDSPatient"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-EHDSPatientCore.html">EHDSPatientCore</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Patient model</span><br/><br/>Elements defined in Ancestors:<a href="StructureDefinition-EHDSPatientCore.html" title="Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc.">name</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided.">dateOfBirth</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="An identifier of the patient that is unique within a defined scope (typically a national patient identifier, but it can also be a temporary identifier issued by the EHR).">personalIdentifier</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="Citizenship/nationality of the patient.">citizenship</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="This field must contain a recognized valid value for &quot;administrative gender&quot;. If different, &quot;physiological gender&quot; should be communicated elsewhere.">administrativeGender</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="The patient's country of affiliation">countryOfAffiliation</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="The addresses are always sequences of address parts (e.g. street address line, country, postal code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose.">address</a>, <a href="StructureDefinition-EHDSPatientCore.html" title="Telecommunication contact information (addresses) associated to a person.">telecom</a><br/><span style="font-weight:bold">Instances of this logical model can be the target of a Reference</span></td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-EHDSPatient-definitions.html#EHDSPatient.maritalStatus" title="Marital (civil) status of a patient">maritalStatus</a><a name="EHDSPatient.maritalStatus"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; 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 : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Marital (civil) status of a patient<br class="binding"/><span style="font-weight:bold" title="null" class="binding">Binding Description: </span><span title="null" class="binding"> (</span><a href="http://hl7.org/fhir/R5/terminologies.html#preferred" title="Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant." class="binding">preferred</a><span title="null" class="binding">)</span><span title="null" class="binding">: </span><span title="null" class="binding">HL7 marital-status</span></td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; 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_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-EHDSPatient-definitions.html#EHDSPatient.communicationLanguage" title="The language which can be used to communicate with the patient about his or her health.">communicationLanguage</a><a name="EHDSPatient.communicationLanguage"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td style="vertical-align: top; text-align : var(--ig-left,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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">The language which can be used to communicate with the patient about his or her health.<br class="binding"/><span style="font-weight:bold" title="null" class="binding">Binding Description: </span><span title="null" class="binding"> (</span><a href="http://hl7.org/fhir/R5/terminologies.html#preferred" title="Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant." class="binding">preferred</a><span title="null" class="binding">)</span><span title="null" class="binding">: </span><span title="null" class="binding">BCP 47</span><br/></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,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" 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-be-target"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
        <valueCode value="can-be-target"/>
      </extension>
      <url
           value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"/>
      <version value="0.2.1"/>
      <name value="EHDSPatient"/>
      <title value="Patient model"/>
      <status value="draft"/>
      <date value="2025-12-03T08:01:45+00:00"/>
      <publisher value="Xt-EHR"/>
      <contact>
        <name value="Xt-EHR"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.xt-ehr.eu/"/>
        </telecom>
      </contact>
      <description
                   value="EHDS refined base model for patient (subject of care) information"/>
      <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://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"/>
      <baseDefinition
                      value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatientCore"/>
      <derivation value="specialization"/>
      <snapshot>
        <extension
                   url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
          <valueString value="0.2.1"/>
        </extension>
        <element id="EHDSPatient">
          <path value="EHDSPatient"/>
          <short value="Patient model"/>
          <definition
                      value="EHDS refined base model for patient (subject of care) information"/>
          <min value="0"/>
          <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="EHDSPatient.name">
          <path value="EHDSPatient.name"/>
          <short value="Name associated with the patient/subject."/>
          <definition
                      value="Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatientCore.name"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code
                  value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHumanName"/>
          </type>
        </element>
        <element id="EHDSPatient.dateOfBirth">
          <path value="EHDSPatient.dateOfBirth"/>
          <short value="Date of birth"/>
          <definition
                      value="The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="EHDSPatientCore.dateOfBirth"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="dateTime"/>
          </type>
        </element>
        <element id="EHDSPatient.personalIdentifier">
          <path value="EHDSPatient.personalIdentifier"/>
          <short
                 value="An identifier of the patient that is unique within a defined scope (typically a national patient identifier, but it can also be a temporary identifier issued by the EHR)."/>
          <definition
                      value="An identifier of the patient that is unique within a defined scope (typically a national patient identifier, but it can also be a temporary identifier issued by the EHR)."/>
          <min value="1"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatientCore.personalIdentifier"/>
            <min value="1"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Identifier"/>
          </type>
        </element>
        <element id="EHDSPatient.citizenship">
          <path value="EHDSPatient.citizenship"/>
          <short value="Citizenship (nationality)"/>
          <definition value="Citizenship/nationality of the patient."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatientCore.citizenship"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="ISO 3166-1 alpha-2"/>
          </binding>
        </element>
        <element id="EHDSPatient.administrativeGender">
          <path value="EHDSPatient.administrativeGender"/>
          <short value="Administrative gender"/>
          <definition
                      value="This field must contain a recognized valid value for &quot;administrative gender&quot;. If different, &quot;physiological gender&quot; should be communicated elsewhere."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="EHDSPatientCore.administrativeGender"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="HL7 Administrative Gender"/>
          </binding>
        </element>
        <element id="EHDSPatient.countryOfAffiliation">
          <path value="EHDSPatient.countryOfAffiliation"/>
          <short value="The patient's country of affiliation"/>
          <definition value="The patient's country of affiliation"/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="EHDSPatientCore.countryOfAffiliation"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="ISO 3166"/>
          </binding>
        </element>
        <element id="EHDSPatient.address">
          <path value="EHDSPatient.address"/>
          <short value="Mailing and home or office addresses."/>
          <definition
                      value="The addresses are always sequences of address parts (e.g. street address line, country, postal code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatientCore.address"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code
                  value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAddress"/>
          </type>
        </element>
        <element id="EHDSPatient.telecom">
          <path value="EHDSPatient.telecom"/>
          <short
                 value="Telecommunication contact information (addresses) associated to a person."/>
          <definition
                      value="Telecommunication contact information (addresses) associated to a person."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatientCore.telecom"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code
                  value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSTelecom"/>
          </type>
        </element>
        <element id="EHDSPatient.maritalStatus">
          <path value="EHDSPatient.maritalStatus"/>
          <short value="Marital (civil) status of a patient"/>
          <definition value="Marital (civil) status of a patient"/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="EHDSPatient.maritalStatus"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="HL7 marital-status"/>
          </binding>
        </element>
        <element id="EHDSPatient.communicationLanguage">
          <path value="EHDSPatient.communicationLanguage"/>
          <short
                 value="The language which can be used to communicate with the patient about his or her health."/>
          <definition
                      value="The language which can be used to communicate with the patient about his or her health."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="EHDSPatient.communicationLanguage"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="BCP 47"/>
          </binding>
        </element>
      </snapshot>
      <differential>
        <element id="EHDSPatient">
          <path value="EHDSPatient"/>
        </element>
        <element id="EHDSPatient.maritalStatus">
          <path value="EHDSPatient.maritalStatus"/>
          <short value="Marital (civil) status of a patient"/>
          <definition value="Marital (civil) status of a patient"/>
          <min value="0"/>
          <max value="1"/>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="HL7 marital-status"/>
          </binding>
        </element>
        <element id="EHDSPatient.communicationLanguage">
          <path value="EHDSPatient.communicationLanguage"/>
          <short
                 value="The language which can be used to communicate with the patient about his or her health."/>
          <definition
                      value="The language which can be used to communicate with the patient about his or her health."/>
          <min value="0"/>
          <max value="*"/>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <binding>
            <strength value="preferred"/>
            <description value="BCP 47"/>
          </binding>
        </element>
      </differential>
    </StructureDefinition>