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/main and changes regularly. See the Directory of published versions
Draft as of 2025-06-13 |
Definitions for the EHDSDocument logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. EHDSDocument | |
Definition | EHDS refined base model for common document data elements, including the common header. Data relevant to document type and its content for administrative and searching purposes. Base definition for all types defined in FHIR type system. |
Short | Document modelBase 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. EHDSDocument.header | |
Definition | Common header for all patient-related data |
Short | Document header elements |
Control | 1..* |
Type | Base |
4. EHDSDocument.header.subject | |
Definition | Patient/subject information |
Short | Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
6. EHDSDocument.header.identifier | |
Definition | Unique identifier of the document |
Short | Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
8. EHDSDocument.header.authorship | |
Definition | Resource authoring details |
Short | Authorship |
Control | 1..* |
Type | Base |
10. EHDSDocument.header.authorship.author[x] | |
Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided. |
Short | Author |
Control | 1..1 |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
12. EHDSDocument.header.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 |
14. EHDSDocument.header.lastUpdate | |
Definition | Date and time of the last update to the document/information |
Short | Date and time of the last update to the resource |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSDocument.header.status | |
Definition | Status of the resource |
Short | Status of the resource |
Control | 1..1 |
Type | CodeableConcept |
18. EHDSDocument.header.statusReason[x] | |
Definition | Reason for the current status of the resource. |
Short | Reason for the current status of the resource. |
Control | 0..1 |
Type | Choice of: CodeableConcept, string |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSDocument.header.language | |
Definition | Language in which the resource is written. Language is expressed by the IETF language tag. |
Short | Language |
Control | 0..1 |
Binding | BCP 47 |
Type | CodeableConcept |
22. EHDSDocument.header.version | |
Definition | Business version of the resource. |
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 |
24. EHDSDocument.presentedForm | |
Definition | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
Short | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
26. EHDSDocument.header.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
28. EHDSDocument.header.documentTitle | |
Definition | Document title, such as Hospital Discharge Report, Laboratory Result Report, etc. |
Short | Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. EHDSDocument.header.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
32. EHDSDocument.header.period | |
Definition | Time of service that is being documented |
Short | Period |
Control | 0..1 |
Type | Period |
34. EHDSDocument.header.attestation | |
Definition | Document attestation details |
Short | Attestation |
Control | 0..* |
Type | Base |
36. EHDSDocument.header.attestation.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | Attester |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
38. EHDSDocument.header.attestation.datetime | |
Definition | Date and time of the approval of the document by Attester. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSDocument.header.legalAuthentication | |
Definition | Document legal authentication |
Short | Legal authentication |
Control | 0..1 |
Type | Base |
42. EHDSDocument.header.legalAuthentication.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | Legal authenticator |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
44. EHDSDocument.header.legalAuthentication.datetime | |
Definition | Date and time when the document was authorized. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSDocument.header.eventType | |
Definition | Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
48. EHDSDocument.header.authorSpecialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
50. EHDSDocument.header.custodian | |
Definition | Organisation that is in charge of maintaining the document/report. |
Short | Document custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
52. EHDSDocument.header.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
54. EHDSDocument.header.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
56. EHDSDocument.knowledgeResources | |
Definition | Related documents and information sources |
Short | Related documents and information sources |
Control | 0..* |
Type | Base |
58. EHDSDocument.knowledgeResources.externalReference | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | RelatedArtifact |
60. EHDSDocument.knowledgeResources.relatedTo | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | Reference |
Guidance on how to interpret the contents of this table can be foundhere
0. EHDSDocument | |
Definition | EHDS refined base model for common document data elements, including the common header. Data relevant to document type and its content for administrative and searching purposes. |
Short | Document model |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSDocument.header | |
Short | Document header elements |
4. EHDSDocument.header.identifier | |
Definition | Unique identifier of the document |
Short | Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
6. EHDSDocument.header.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
8. EHDSDocument.header.documentTitle | |
Definition | Document title, such as Hospital Discharge Report, Laboratory Result Report, etc. |
Short | Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. EHDSDocument.header.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
12. EHDSDocument.header.period | |
Definition | Time of service that is being documented |
Short | Period |
Control | 0..1 |
Type | Period |
14. EHDSDocument.header.attestation | |
Definition | Document attestation details |
Short | Attestation |
Control | 0..* |
Type | Base |
16. EHDSDocument.header.attestation.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | Attester |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
18. EHDSDocument.header.attestation.datetime | |
Definition | Date and time of the approval of the document by Attester. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSDocument.header.legalAuthentication | |
Definition | Document legal authentication |
Short | Legal authentication |
Control | 0..1 |
Type | Base |
22. EHDSDocument.header.legalAuthentication.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | Legal authenticator |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
24. EHDSDocument.header.legalAuthentication.datetime | |
Definition | Date and time when the document was authorized. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSDocument.header.eventType | |
Definition | Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
28. EHDSDocument.header.authorSpecialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
30. EHDSDocument.header.custodian | |
Definition | Organisation that is in charge of maintaining the document/report. |
Short | Document custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
32. EHDSDocument.header.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
34. EHDSDocument.header.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
36. EHDSDocument.knowledgeResources | |
Definition | Related documents and information sources |
Short | Related documents and information sources |
Control | 0..* |
Type | Base |
38. EHDSDocument.knowledgeResources.externalReference | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | RelatedArtifact |
40. EHDSDocument.knowledgeResources.relatedTo | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | Reference |
Guidance on how to interpret the contents of this table can be foundhere
0. EHDSDocument | |
Definition | EHDS refined base model for common document data elements, including the common header. Data relevant to document type and its content for administrative and searching purposes. |
Short | Document model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSDocument.header | |
Definition | Common header for all patient-related data |
Short | Document header elements |
Control | 1..* |
Type | Base |
4. EHDSDocument.header.subject | |
Definition | Patient/subject information |
Short | Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
6. EHDSDocument.header.identifier | |
Definition | Unique identifier of the document |
Short | Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
8. EHDSDocument.header.authorship | |
Definition | Resource authoring details |
Short | Authorship |
Control | 1..* |
Type | Base |
10. EHDSDocument.header.authorship.author[x] | |
Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided. |
Short | Author |
Control | 1..1 |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
12. EHDSDocument.header.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 |
14. EHDSDocument.header.lastUpdate | |
Definition | Date and time of the last update to the document/information |
Short | Date and time of the last update to the resource |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSDocument.header.status | |
Definition | Status of the resource |
Short | Status of the resource |
Control | 1..1 |
Type | CodeableConcept |
18. EHDSDocument.header.statusReason[x] | |
Definition | Reason for the current status of the resource. |
Short | Reason for the current status of the resource. |
Control | 0..1 |
Type | Choice of: CodeableConcept, string |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. EHDSDocument.header.language | |
Definition | Language in which the resource is written. Language is expressed by the IETF language tag. |
Short | Language |
Control | 0..1 |
Binding | BCP 47 |
Type | CodeableConcept |
22. EHDSDocument.header.version | |
Definition | Business version of the resource. |
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 |
24. EHDSDocument.presentedForm | |
Definition | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
Short | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
26. EHDSDocument.header.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
28. EHDSDocument.header.documentTitle | |
Definition | Document title, such as Hospital Discharge Report, Laboratory Result Report, etc. |
Short | Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. EHDSDocument.header.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
32. EHDSDocument.header.period | |
Definition | Time of service that is being documented |
Short | Period |
Control | 0..1 |
Type | Period |
34. EHDSDocument.header.attestation | |
Definition | Document attestation details |
Short | Attestation |
Control | 0..* |
Type | Base |
36. EHDSDocument.header.attestation.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | Attester |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
38. EHDSDocument.header.attestation.datetime | |
Definition | Date and time of the approval of the document by Attester. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSDocument.header.legalAuthentication | |
Definition | Document legal authentication |
Short | Legal authentication |
Control | 0..1 |
Type | Base |
42. EHDSDocument.header.legalAuthentication.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | Legal authenticator |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
44. EHDSDocument.header.legalAuthentication.datetime | |
Definition | Date and time when the document was authorized. |
Short | DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSDocument.header.eventType | |
Definition | Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
48. EHDSDocument.header.authorSpecialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
50. EHDSDocument.header.custodian | |
Definition | Organisation that is in charge of maintaining the document/report. |
Short | Document custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
52. EHDSDocument.header.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
54. EHDSDocument.header.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
56. EHDSDocument.knowledgeResources | |
Definition | Related documents and information sources |
Short | Related documents and information sources |
Control | 0..* |
Type | Base |
58. EHDSDocument.knowledgeResources.externalReference | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | RelatedArtifact |
60. EHDSDocument.knowledgeResources.relatedTo | |
Definition | ... |
Short | ... |
Control | 0..* |
Type | Reference |