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 EHDSDataSet logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSDataSet | |
| Definition | Common elements for all EHDS data exchange. Base definition for all types defined in FHIR type system. |
| Short | EHDS data exchangeBase 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. EHDSDataSet.identifier | |
| Definition | Unique identifier of the data object |
| Short | Document ID |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSDataSet.subject | |
| Definition | Patient/subject information |
| Short | Subject |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 6. EHDSDataSet.country | |
| Definition | Country of the data exchange initiator. |
| Short | Country |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 8. EHDSDataSet.relatedPerson | |
| Definition | Patient/subject guardian and related person information |
| Short | Related person |
| Control | 0..* |
| Type | BackboneElement |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] A.1.2 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. EHDSDataSet.relatedPerson.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | idstring |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 12. EHDSDataSet.relatedPerson.extension | |
| Definition | 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. |
| Short | Additional content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on EHDSDataSet.relatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. EHDSDataSet.relatedPerson.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. EHDSDataSet.relatedPerson.person | |
| Definition | Identification and description of the contact person for that patient. This includes relatives, guardians, caring persons etc. |
| Short | Identification and description of the person |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 18. EHDSDataSet.relatedPerson.relationship | |
| Definition | The nature of the relationship between the patient and the related person. |
| Short | Relationship |
| Control | 0..1 |
| Binding | HL7 RoleCode |
| Type | CodeableConcept |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] C.13.3 |
| 20. EHDSDataSet.authorship | |
| Definition | Document/resource authoring details |
| Short | Authorship |
| Control | 1..* |
| Type | Base |
| 22. EHDSDataSet.authorship.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 24. EHDSDataSet.authorship.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
| 26. EHDSDataSet.lastUpdate | |
| Definition | Date and time of the last update to the document/information |
| Short | Date and time of the last update to the data object |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. EHDSDataSet.status | |
| Definition | Status of the information |
| Short | Status of the information |
| Control | 1..1 |
| Type | CodeableConcept |
| 30. EHDSDataSet.version | |
| Definition | Business version of the data object. |
| Short | Version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. EHDSDataSet.language | |
| Definition | Language in which the information is written. Language is expressed by the IETF language tag. |
| Short | Language |
| Control | 0..1 |
| Binding | BCP 47 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] A.1.9.12 |
| 34. EHDSDataSet.presentation | |
| Definition | The presentation of the data, e.g. a PDF document, a video, a text file, etc. In case of unstructured data, this is the actual content. |
| Short | Presentation form |
| Control | 1..* |
| Type | Base |
| 36. EHDSDataSet.presentation.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 38. EHDSDataSet.presentation.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSDataSet | |
| Definition | Common elements for all EHDS data exchange. |
| Short | EHDS data exchange |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSDataSet.identifier | |
| Definition | Unique identifier of the data object |
| Short | Document ID |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSDataSet.subject | |
| Definition | Patient/subject information |
| Short | Subject |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 6. EHDSDataSet.country | |
| Definition | Country of the data exchange initiator. |
| Short | Country |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 8. EHDSDataSet.relatedPerson | |
| Definition | Patient/subject guardian and related person information |
| Short | Related person |
| Control | 0..* |
| Type | BackboneElement |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] A.1.2 |
| 10. EHDSDataSet.relatedPerson.person | |
| Definition | Identification and description of the contact person for that patient. This includes relatives, guardians, caring persons etc. |
| Short | Identification and description of the person |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 12. EHDSDataSet.relatedPerson.relationship | |
| Definition | The nature of the relationship between the patient and the related person. |
| Short | Relationship |
| Control | 0..1 |
| Binding | HL7 RoleCode |
| Type | CodeableConcept |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] C.13.3 |
| 14. EHDSDataSet.authorship | |
| Definition | Document/resource authoring details |
| Short | Authorship |
| Control | 1..* |
| Type | Base |
| 16. EHDSDataSet.authorship.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 18. EHDSDataSet.authorship.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
| 20. EHDSDataSet.lastUpdate | |
| Definition | Date and time of the last update to the document/information |
| Short | Date and time of the last update to the data object |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. EHDSDataSet.status | |
| Definition | Status of the information |
| Short | Status of the information |
| Control | 1..1 |
| Type | CodeableConcept |
| 24. EHDSDataSet.version | |
| Definition | Business version of the data object. |
| Short | Version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EHDSDataSet.language | |
| Definition | Language in which the information is written. Language is expressed by the IETF language tag. |
| Short | Language |
| Control | 0..1 |
| Binding | BCP 47 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] A.1.9.12 |
| 28. EHDSDataSet.presentation | |
| Definition | The presentation of the data, e.g. a PDF document, a video, a text file, etc. In case of unstructured data, this is the actual content. |
| Short | Presentation form |
| Control | 1..* |
| Type | Base |
| 30. EHDSDataSet.presentation.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 32. EHDSDataSet.presentation.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSDataSet | |
| Definition | Common elements for all EHDS data exchange. |
| Short | EHDS data exchange |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSDataSet.identifier | |
| Definition | Unique identifier of the data object |
| Short | Document ID |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSDataSet.subject | |
| Definition | Patient/subject information |
| Short | Subject |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 6. EHDSDataSet.country | |
| Definition | Country of the data exchange initiator. |
| Short | Country |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 8. EHDSDataSet.relatedPerson | |
| Definition | Patient/subject guardian and related person information |
| Short | Related person |
| Control | 0..* |
| Type | BackboneElement |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] A.1.2 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. EHDSDataSet.relatedPerson.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 12. EHDSDataSet.relatedPerson.extension | |
| Definition | 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. |
| Short | Additional content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on EHDSDataSet.relatedPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. EHDSDataSet.relatedPerson.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. EHDSDataSet.relatedPerson.person | |
| Definition | Identification and description of the contact person for that patient. This includes relatives, guardians, caring persons etc. |
| Short | Identification and description of the person |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPerson |
| 18. EHDSDataSet.relatedPerson.relationship | |
| Definition | The nature of the relationship between the patient and the related person. |
| Short | Relationship |
| Control | 0..1 |
| Binding | HL7 RoleCode |
| Type | CodeableConcept |
| Requirements | Some roles for the related person are essential for data access control. For example, the role of the guardian is essential for the data access control of a minor patient. |
| Definitional Codes | [not stated] C.13.3 |
| 20. EHDSDataSet.authorship | |
| Definition | Document/resource authoring details |
| Short | Authorship |
| Control | 1..* |
| Type | Base |
| 22. EHDSDataSet.authorship.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 24. EHDSDataSet.authorship.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
| 26. EHDSDataSet.lastUpdate | |
| Definition | Date and time of the last update to the document/information |
| Short | Date and time of the last update to the data object |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. EHDSDataSet.status | |
| Definition | Status of the information |
| Short | Status of the information |
| Control | 1..1 |
| Type | CodeableConcept |
| 30. EHDSDataSet.version | |
| Definition | Business version of the data object. |
| Short | Version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. EHDSDataSet.language | |
| Definition | Language in which the information is written. Language is expressed by the IETF language tag. |
| Short | Language |
| Control | 0..1 |
| Binding | BCP 47 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] A.1.9.12 |
| 34. EHDSDataSet.presentation | |
| Definition | The presentation of the data, e.g. a PDF document, a video, a text file, etc. In case of unstructured data, this is the actual content. |
| Short | Presentation form |
| Control | 1..* |
| Type | Base |
| 36. EHDSDataSet.presentation.author | |
| Definition | Author by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| Definitional Codes | [not stated] A.1.6.1 |
| 38. EHDSDataSet.presentation.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | [not stated] A.1.6.2 |
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.
