Xt-EHR Metadata Standards
0.1.0 - ci-build
Xt-EHR Metadata Standards
0.1.0 - ci-build
Xt-EHR Metadata Standards, 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-metadata/ and changes regularly. See the Directory of published versions
| Draft as of 2025-08-21 |
Definitions for the EHDSPerson logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSPerson | |
| Definition | EHDS refined base model for Patient/subject information Base definition for all types defined in FHIR type system. |
| Short | PersonBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSPerson.personalIdentifier | |
| Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) or National patient identifier for the Czech patient. Multiple identifiers could be provided. |
| Short | Personal identifier |
| Control | 1..* |
| Type | Identifier |
| 4. EHDSPerson.name | |
| Definition | Name associated with the patient/subject. Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc. |
| Short | Name |
| Control | 0..* |
| Type | Base |
| 6. EHDSPerson.dateOfBirth | |
| Definition | 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. |
| Short | Date of birth |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. EHDSPerson.administrativeGender | |
| Definition | This field must contain a recognized valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere. |
| Short | Administrative gender |
| Control | 0..1 |
| Binding | HL7 Administrative Gender |
| Type | CodeableConcept |
| 10. EHDSPerson.address | |
| Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP 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. |
| Short | Address |
| Control | 0..* |
| Type | Base |
| 12. EHDSPerson.telecom | |
| Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. |
| Short | Telecom |
| Control | 0..* |
| Type | Base |
| 14. EHDSPerson.maritalStatus | |
| Definition | Marital (civil) status of a person |
| Short | Marital status |
| Control | 0..1 |
| Binding | HL7 marital-status |
| Type | CodeableConcept |
| 16. EHDSPerson.citizenship | |
| Definition | Citizenship/nationality of the person. |
| Short | Citizenship (nationality) |
| Control | 0..* |
| Binding | ISO 3166-1-2 |
| Type | CodeableConcept |
| 18. EHDSPerson.communicationLanguage | |
| Definition | The language which can be used to communicate with the patient about his or her health. |
| Short | Communication language |
| Control | 0..* |
| Binding | BCP 47 |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSPerson | |
| Definition | EHDS refined base model for Patient/subject information |
| Short | Person |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSPerson.personalIdentifier | |
| Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) or National patient identifier for the Czech patient. Multiple identifiers could be provided. |
| Short | Personal identifier |
| Control | 1..* |
| Type | Identifier |
| 4. EHDSPerson.name | |
| Definition | Name associated with the patient/subject. Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc. |
| Short | Name |
| Control | 0..* |
| Type | Base |
| 6. EHDSPerson.dateOfBirth | |
| Definition | 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. |
| Short | Date of birth |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. EHDSPerson.administrativeGender | |
| Definition | This field must contain a recognized valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere. |
| Short | Administrative gender |
| Control | 0..1 |
| Binding | HL7 Administrative Gender |
| Type | CodeableConcept |
| 10. EHDSPerson.address | |
| Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP 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. |
| Short | Address |
| Control | 0..* |
| Type | Base |
| 12. EHDSPerson.telecom | |
| Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. |
| Short | Telecom |
| Control | 0..* |
| Type | Base |
| 14. EHDSPerson.maritalStatus | |
| Definition | Marital (civil) status of a person |
| Short | Marital status |
| Control | 0..1 |
| Binding | HL7 marital-status |
| Type | CodeableConcept |
| 16. EHDSPerson.citizenship | |
| Definition | Citizenship/nationality of the person. |
| Short | Citizenship (nationality) |
| Control | 0..* |
| Binding | ISO 3166-1-2 |
| Type | CodeableConcept |
| 18. EHDSPerson.communicationLanguage | |
| Definition | The language which can be used to communicate with the patient about his or her health. |
| Short | Communication language |
| Control | 0..* |
| Binding | BCP 47 |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSPerson | |
| Definition | EHDS refined base model for Patient/subject information |
| Short | Person |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSPerson.personalIdentifier | |
| Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) or National patient identifier for the Czech patient. Multiple identifiers could be provided. |
| Short | Personal identifier |
| Control | 1..* |
| Type | Identifier |
| 4. EHDSPerson.name | |
| Definition | Name associated with the patient/subject. Name might consist of name parts, e.g. Given name or names, family name/surname, name prefix etc. |
| Short | Name |
| Control | 0..* |
| Type | Base |
| 6. EHDSPerson.dateOfBirth | |
| Definition | 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. |
| Short | Date of birth |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. EHDSPerson.administrativeGender | |
| Definition | This field must contain a recognized valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere. |
| Short | Administrative gender |
| Control | 0..1 |
| Binding | HL7 Administrative Gender |
| Type | CodeableConcept |
| 10. EHDSPerson.address | |
| Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP 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. |
| Short | Address |
| Control | 0..* |
| Type | Base |
| 12. EHDSPerson.telecom | |
| Definition | Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. |
| Short | Telecom |
| Control | 0..* |
| Type | Base |
| 14. EHDSPerson.maritalStatus | |
| Definition | Marital (civil) status of a person |
| Short | Marital status |
| Control | 0..1 |
| Binding | HL7 marital-status |
| Type | CodeableConcept |
| 16. EHDSPerson.citizenship | |
| Definition | Citizenship/nationality of the person. |
| Short | Citizenship (nationality) |
| Control | 0..* |
| Binding | ISO 3166-1-2 |
| Type | CodeableConcept |
| 18. EHDSPerson.communicationLanguage | |
| Definition | The language which can be used to communicate with the patient about his or her health. |
| Short | Communication language |
| Control | 0..* |
| Binding | BCP 47 |
| Type | CodeableConcept |
IG © 2022+ Xt-EHR. Package hl7.eu.fhir.xt-ehr.metadata#0.1.0 based on FHIR 5.0.0. Generated 2025-08-21
Links:
Table of Contents |
QA Report
The Xt-EHR action is co-funded by the European Union, EU4Health Program 2021-2027, under Grant Agreement Nr.ยบ 101128085.
