Xt-EHR
0.1.0 - ci-build
Xt-EHR, 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/ and changes regularly. See the Directory of published versions
Draft as of 2024-11-07 |
Definitions for the EHDSPatientSummaryHeader logical model.
Guidance on how to interpret the contents of this table can be found here
0. EHDSPatientSummaryHeader | |
Definition | A.1 - EHDS refined base model for Report header data elements |
Short | Report header |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSPatientSummaryHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSPatientSummaryHeader.relatedPerson | |
Definition | Patient/subject guardian and related person information |
Short | A.1.2 - Related person |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSRelatedPerson |
6. EHDSPatientSummaryHeader.preferredHealthProfessional | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.3 - Preferred Health Professional |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
8. EHDSPatientSummaryHeader.authorship | |
Definition | Information about author or authors of the document |
Short | A.1.6 - Authorship |
Control | 1..* |
Type | Base |
10. EHDSPatientSummaryHeader.authorship.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6.1 - Author |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
12. EHDSPatientSummaryHeader.authorship.datetime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.6.2 - DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSPatientSummaryHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | Base |
16. EHDSPatientSummaryHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
18. EHDSPatientSummaryHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
20. EHDSPatientSummaryHeader.documentMetadata.documentStatus | |
Definition | The status of the document/report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
22. EHDSPatientSummaryHeader.documentMetadata.period | |
Definition | Documented period service. Typically used for searching purposes. |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
24. EHDSPatientSummaryHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSPatientSummaryHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSPatientSummaryHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
30. EHDSPatientSummaryHeader.documentMetadata.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 | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
32. EHDSPatientSummaryHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
34. EHDSPatientSummaryHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
36. EHDSPatientSummaryHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - 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 |
38. EHDSPatientSummaryHeader.documentMetadata.dateOfLastUpdate | |
Definition | Date on which document or document part was updated (date of most recent version) |
Short | A.1.9.16 - Date of last update |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSPatientSummaryHeader.documentMetadata.natureOfTheDocument | |
Definition | Defines the context in which the document was generated. Distinguishes between four methodological approaches for generating the document:1) Created entirely by a HCP2) Manually created by HCP(s) and collected by machine(s)3) Created by machine(s) and checked by HCP(s)4) Created and collected by machine(s) |
Short | A.1.9.17 - Nature of the document |
Control | 1..1 |
Type | Base |
42. EHDSPatientSummaryHeader.KnowledgeResources | |
Definition | To provide links between specified data elements and external knowledge resources |
Short | A.1.10 - Additional information / Knowledge resources |
Control | 0..* |
Type | Base |
44. EHDSPatientSummaryHeader.KnowledgeResources.externalReference | |
Definition | A reference leading to Clinical Practice Guidelines (CPG), emergency and anesthesia guidelines or other clinical relevant guidelines. This should be used only for providing specific guidance which may not be readily available to the health professional caring for the patient. |
Short | A.1.10.1 - External reference |
Control | 0..* |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSPatientSummaryHeader.KnowledgeResources.relatedWith | |
Definition | Identify the entry or entries of this document or document part for which this additional information relates with, for example a link between a rare disease problem and guidelines for that particular rare disease (this section). |
Short | A.1.10.2 - Related with |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model)) |
Guidance on how to interpret the contents of this table can be found here
0. EHDSPatientSummaryHeader | |
Definition | A.1 - EHDS refined base model for Report header data elements Base definition for all types defined in FHIR type system. |
Short | Report headerBase 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. EHDSPatientSummaryHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSPatientSummaryHeader.relatedPerson | |
Definition | Patient/subject guardian and related person information |
Short | A.1.2 - Related person |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSRelatedPerson |
6. EHDSPatientSummaryHeader.preferredHealthProfessional | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.3 - Preferred Health Professional |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
8. EHDSPatientSummaryHeader.authorship | |
Definition | Information about author or authors of the document |
Short | A.1.6 - Authorship |
Control | 1..* |
Type | Base |
10. EHDSPatientSummaryHeader.authorship.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6.1 - Author |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
12. EHDSPatientSummaryHeader.authorship.datetime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.6.2 - DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSPatientSummaryHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | Base |
16. EHDSPatientSummaryHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
18. EHDSPatientSummaryHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
20. EHDSPatientSummaryHeader.documentMetadata.documentStatus | |
Definition | The status of the document/report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
22. EHDSPatientSummaryHeader.documentMetadata.period | |
Definition | Documented period service. Typically used for searching purposes. |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
24. EHDSPatientSummaryHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSPatientSummaryHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSPatientSummaryHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
30. EHDSPatientSummaryHeader.documentMetadata.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 | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
32. EHDSPatientSummaryHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
34. EHDSPatientSummaryHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
36. EHDSPatientSummaryHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - 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 |
38. EHDSPatientSummaryHeader.documentMetadata.dateOfLastUpdate | |
Definition | Date on which document or document part was updated (date of most recent version) |
Short | A.1.9.16 - Date of last update |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSPatientSummaryHeader.documentMetadata.natureOfTheDocument | |
Definition | Defines the context in which the document was generated. Distinguishes between four methodological approaches for generating the document:1) Created entirely by a HCP2) Manually created by HCP(s) and collected by machine(s)3) Created by machine(s) and checked by HCP(s)4) Created and collected by machine(s) |
Short | A.1.9.17 - Nature of the document |
Control | 1..1 |
Type | Base |
42. EHDSPatientSummaryHeader.KnowledgeResources | |
Definition | To provide links between specified data elements and external knowledge resources |
Short | A.1.10 - Additional information / Knowledge resources |
Control | 0..* |
Type | Base |
44. EHDSPatientSummaryHeader.KnowledgeResources.externalReference | |
Definition | A reference leading to Clinical Practice Guidelines (CPG), emergency and anesthesia guidelines or other clinical relevant guidelines. This should be used only for providing specific guidance which may not be readily available to the health professional caring for the patient. |
Short | A.1.10.1 - External reference |
Control | 0..* |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSPatientSummaryHeader.KnowledgeResources.relatedWith | |
Definition | Identify the entry or entries of this document or document part for which this additional information relates with, for example a link between a rare disease problem and guidelines for that particular rare disease (this section). |
Short | A.1.10.2 - Related with |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model)) |
Guidance on how to interpret the contents of this table can be found here
0. EHDSPatientSummaryHeader | |
Definition | A.1 - EHDS refined base model for Report header data elements |
Short | Report header |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSPatientSummaryHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSPatientSummaryHeader.relatedPerson | |
Definition | Patient/subject guardian and related person information |
Short | A.1.2 - Related person |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSRelatedPerson |
6. EHDSPatientSummaryHeader.preferredHealthProfessional | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.3 - Preferred Health Professional |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
8. EHDSPatientSummaryHeader.authorship | |
Definition | Information about author or authors of the document |
Short | A.1.6 - Authorship |
Control | 1..* |
Type | Base |
10. EHDSPatientSummaryHeader.authorship.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6.1 - Author |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
12. EHDSPatientSummaryHeader.authorship.datetime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.6.2 - DateTime |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. EHDSPatientSummaryHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | Base |
16. EHDSPatientSummaryHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
18. EHDSPatientSummaryHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
20. EHDSPatientSummaryHeader.documentMetadata.documentStatus | |
Definition | The status of the document/report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
22. EHDSPatientSummaryHeader.documentMetadata.period | |
Definition | Documented period service. Typically used for searching purposes. |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
24. EHDSPatientSummaryHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. EHDSPatientSummaryHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. EHDSPatientSummaryHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
30. EHDSPatientSummaryHeader.documentMetadata.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 | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
32. EHDSPatientSummaryHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
34. EHDSPatientSummaryHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
36. EHDSPatientSummaryHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - 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 |
38. EHDSPatientSummaryHeader.documentMetadata.dateOfLastUpdate | |
Definition | Date on which document or document part was updated (date of most recent version) |
Short | A.1.9.16 - Date of last update |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. EHDSPatientSummaryHeader.documentMetadata.natureOfTheDocument | |
Definition | Defines the context in which the document was generated. Distinguishes between four methodological approaches for generating the document:1) Created entirely by a HCP2) Manually created by HCP(s) and collected by machine(s)3) Created by machine(s) and checked by HCP(s)4) Created and collected by machine(s) |
Short | A.1.9.17 - Nature of the document |
Control | 1..1 |
Type | Base |
42. EHDSPatientSummaryHeader.KnowledgeResources | |
Definition | To provide links between specified data elements and external knowledge resources |
Short | A.1.10 - Additional information / Knowledge resources |
Control | 0..* |
Type | Base |
44. EHDSPatientSummaryHeader.KnowledgeResources.externalReference | |
Definition | A reference leading to Clinical Practice Guidelines (CPG), emergency and anesthesia guidelines or other clinical relevant guidelines. This should be used only for providing specific guidance which may not be readily available to the health professional caring for the patient. |
Short | A.1.10.1 - External reference |
Control | 0..* |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSPatientSummaryHeader.KnowledgeResources.relatedWith | |
Definition | Identify the entry or entries of this document or document part for which this additional information relates with, for example a link between a rare disease problem and guidelines for that particular rare disease (this section). |
Short | A.1.10.2 - Related with |
Control | 0..* |
Type | Reference(Condition (model), Procedure (model), Observation (model)) |