EHDS Logical Information Models
0.4.0 - draft

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.4.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/ and changes regularly. See the Directory of published versions

Logical Model: EHDSPatientObligations - Detailed Descriptions

Draft as of 2026-03-05

Definitions for the EHDSPatientObligations logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. EHDSPatient
Definition

Model for information about a patient (subject of care).


Base definition for all types defined in FHIR type system.

ShortPatient modelBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSPatient.identifier
Definition

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).

ShortAn 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).
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Obligations
    ObligationsActor
    SHALL:able-to-populateProducer
    4. EHDSPatient.name
    Definition

    Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc.

    ShortName associated with the patient/subject.
    Control0..*
    Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHumanName
    Obligations
      ObligationsActor
      SHALL:able-to-populateProducer
      6. EHDSPatient.name.use
      Definition

      Identifies the purpose of this name.

      ShortIdentifies the purpose of this name.
      Control0..1
      Binding

      HL7 Name Use

      TypeCodeableConcept
      Obligations
        ObligationsActor
        SHOULD:able-to-populateProducer
        8. EHDSPatient.name.text
        Definition

        Specifies the entire name as it should be displayed e.g. on an application UI.

        ShortSpecifies the entire name as it should be displayed e.g. on an application UI.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Obligations
          ObligationsActor
          SHOULD:able-to-populateProducer
          10. EHDSPatient.name.family
          Definition

          The family name/surname/last name of a person.

          ShortThe family name/surname/last name of a person.
          Control0..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Obligations
            ObligationsActor
            SHALL:able-to-populateProducer
            12. EHDSPatient.name.given
            Definition

            The given name/first name.

            ShortThe given name/first name.
            Control0..*
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Obligations
              ObligationsActor
              SHALL:able-to-populateProducer
              14. EHDSPatient.name.prefix
              Definition

              Name parts that come before the name. Prefixes appear in the correct order for presenting the name.

              ShortName parts that come before the name. Prefixes appear in the correct order for presenting the name.
              Control0..*
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              16. EHDSPatient.name.suffix
              Definition

              Name parts that come after the name. Suffixes appear in the correct order for presenting the name.

              ShortName parts that come after the name. Suffixes appear in the correct order for presenting the name.
              Control0..*
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              18. EHDSPatient.dateOfBirth
              Definition

              Date of birth

              ShortDate of birth
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Obligations
                ObligationsActor
                SHOULD:able-to-populateProducer
                20. EHDSPatient.deceased[x]
                Definition

                Whether the patient is deceased or date of death.

                ShortWhether the patient is deceased or date of death.
                Control0..1
                TypeChoice of: boolean, dateTime
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                22. EHDSPatient.administrativeGender
                Definition

                This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere.

                ShortAdministrative gender
                Control0..1
                Binding

                HL7 Administrative Gender

                TypeCodeableConcept
                Obligations
                  ObligationsActor
                  SHOULD:able-to-populateProducer
                  24. EHDSPatient.address
                  Definition

                  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.

                  ShortMailing and home or office addresses.
                  Control0..*
                  Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAddress
                  26. EHDSPatient.telecom
                  Definition

                  Contact information.

                  ShortContact information.
                  Control0..*
                  Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSTelecom

                  Guidance on how to interpret the contents of this table can be foundhere

                  0. EHDSPatient
                  Logical ModelInstances of this logical model are not marked to be the target of a Reference
                  2. EHDSPatient.identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Obligations
                    ObligationsActor
                    SHALL:able-to-populateProducer
                    4. EHDSPatient.name
                    Obligations
                      ObligationsActor
                      SHALL:able-to-populateProducer
                      6. EHDSPatient.name.use
                      Obligations
                        ObligationsActor
                        SHOULD:able-to-populateProducer
                        8. EHDSPatient.name.text
                        Obligations
                          ObligationsActor
                          SHOULD:able-to-populateProducer
                          10. EHDSPatient.name.family
                          Obligations
                            ObligationsActor
                            SHALL:able-to-populateProducer
                            12. EHDSPatient.name.given
                            Obligations
                              ObligationsActor
                              SHALL:able-to-populateProducer
                              14. EHDSPatient.dateOfBirth
                              Obligations
                                ObligationsActor
                                SHOULD:able-to-populateProducer
                                16. EHDSPatient.administrativeGender
                                Obligations
                                  ObligationsActor
                                  SHOULD:able-to-populateProducer

                                  Guidance on how to interpret the contents of this table can be foundhere

                                  0. EHDSPatient
                                  Definition

                                  Model for information about a patient (subject of care).

                                  ShortPatient model
                                  Control0..*
                                  Is Modifierfalse
                                  Logical ModelInstances of this logical model are not marked to be the target of a Reference
                                  2. EHDSPatient.identifier
                                  Definition

                                  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).

                                  ShortAn 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).
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control1..*
                                  TypeIdentifier
                                  Obligations
                                    ObligationsActor
                                    SHALL:able-to-populateProducer
                                    4. EHDSPatient.name
                                    Definition

                                    Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc.

                                    ShortName associated with the patient/subject.
                                    Control0..*
                                    Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHumanName
                                    Obligations
                                      ObligationsActor
                                      SHALL:able-to-populateProducer
                                      6. EHDSPatient.name.use
                                      Definition

                                      Identifies the purpose of this name.

                                      ShortIdentifies the purpose of this name.
                                      Control0..1
                                      Binding

                                      HL7 Name Use

                                      TypeCodeableConcept
                                      Obligations
                                        ObligationsActor
                                        SHOULD:able-to-populateProducer
                                        8. EHDSPatient.name.text
                                        Definition

                                        Specifies the entire name as it should be displayed e.g. on an application UI.

                                        ShortSpecifies the entire name as it should be displayed e.g. on an application UI.
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Obligations
                                          ObligationsActor
                                          SHOULD:able-to-populateProducer
                                          10. EHDSPatient.name.family
                                          Definition

                                          The family name/surname/last name of a person.

                                          ShortThe family name/surname/last name of a person.
                                          Control0..*
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Obligations
                                            ObligationsActor
                                            SHALL:able-to-populateProducer
                                            12. EHDSPatient.name.given
                                            Definition

                                            The given name/first name.

                                            ShortThe given name/first name.
                                            Control0..*
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Obligations
                                              ObligationsActor
                                              SHALL:able-to-populateProducer
                                              14. EHDSPatient.name.prefix
                                              Definition

                                              Name parts that come before the name. Prefixes appear in the correct order for presenting the name.

                                              ShortName parts that come before the name. Prefixes appear in the correct order for presenting the name.
                                              Control0..*
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              16. EHDSPatient.name.suffix
                                              Definition

                                              Name parts that come after the name. Suffixes appear in the correct order for presenting the name.

                                              ShortName parts that come after the name. Suffixes appear in the correct order for presenting the name.
                                              Control0..*
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              18. EHDSPatient.dateOfBirth
                                              Definition

                                              Date of birth

                                              ShortDate of birth
                                              Control0..1
                                              TypedateTime
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Obligations
                                                ObligationsActor
                                                SHOULD:able-to-populateProducer
                                                20. EHDSPatient.deceased[x]
                                                Definition

                                                Whether the patient is deceased or date of death.

                                                ShortWhether the patient is deceased or date of death.
                                                Control0..1
                                                TypeChoice of: boolean, dateTime
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                22. EHDSPatient.administrativeGender
                                                Definition

                                                This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere.

                                                ShortAdministrative gender
                                                Control0..1
                                                Binding

                                                HL7 Administrative Gender

                                                TypeCodeableConcept
                                                Obligations
                                                  ObligationsActor
                                                  SHOULD:able-to-populateProducer
                                                  24. EHDSPatient.address
                                                  Definition

                                                  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.

                                                  ShortMailing and home or office addresses.
                                                  Control0..*
                                                  Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAddress
                                                  26. EHDSPatient.telecom
                                                  Definition

                                                  Contact information.

                                                  ShortContact information.
                                                  Control0..*
                                                  Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSTelecom