EHDS Logical Information Models
0.2.1 - qa-preview

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/xt-ehr-common/ and changes regularly. See the Directory of published versions

## Logical Model: EHDSEncounter - Detailed Descriptions

Draft as of 2025-12-03

Definitions for the EHDSEncounter logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. EHDSEncounter
Definition | EHDS refined base model for Encounter Base definition for all types defined in FHIR type system.
Short | Encounter 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. EHDSEncounter.header
Definition | Common header for all patient-related data
Short | Common header for all patient-related data
Control | 1..1
Type | Base
4. EHDSEncounter.header.subject
Definition | Patient/subject information
Short | Patient/subject information
Control | 1..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. EHDSEncounter.header.identifier
Definition | Business identifier for the object
Short | Business identifier for the object
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
8. EHDSEncounter.header.authorship
Definition | Resource authoring details
Short | Resource authoring details
Control | 1..*
Type | Base
10. EHDSEncounter.header.authorship.author[x]
Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided.
Short | Author(s) by whom the resource was/were authored. Multiple authors could be provided.
Control | 1..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
12. EHDSEncounter.header.authorship.datetime
Definition | Date and time of authoring/issuing
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. EHDSEncounter.header.lastUpdate
Definition | Date and time of the last update to the resource (may be used for technical corrections).
Short | Date and time of the last update to the resource (may be used for technical corrections).
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. EHDSEncounter.header.status
Definition | Status of the resource or document
Short | Status of the resource or document
Control | 1..1
Type | CodeableConcept
18. EHDSEncounter.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. EHDSEncounter.header.language
Definition | Language in which the resource is written. Language is expressed by the IETF language tag.
Short | Language in which the resource is written. Language is expressed by the IETF language tag.
Control | 0..1
Binding | BCP 47
Type | CodeableConcept
22. EHDSEncounter.priority
Definition | Indicates the urgency of the encounter.
Short | Priority
Control | 0..1
Binding | hl7:v3-xEncounterAdmissionUrgency
Type | CodeableConcept
24. EHDSEncounter.actualPeriod
Definition | The actual start and end time of the encounter
Short | The actual start and end time of the encounter
Control | 0..1
Type | Period
26. EHDSEncounter.admission
Definition | Details about the admission to a healthcare service
Short | Details about the admission to a healthcare service
Control | 0..1
Type | Base
28. EHDSEncounter.admission.reason[x]
Definition | Reason(s) for admission, e.g. problem, procedure or finding.
Short | Reason(s) for admission, e.g. problem, procedure or finding.
Control | 0..*
Type | Choice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCondition, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSProcedure, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSObservation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
30. EHDSEncounter.admission.reasonComment
Definition | Explanation of the reason for the encounter.
Short | Explanation of the reason for the encounter.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
32. EHDSEncounter.admission.admitter
Definition | Admitting healthcare professional
Short | Admitting healthcare professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
34. EHDSEncounter.admission.admittingOrganization
Definition | Admitting healthcare professional
Short | Admitting healthcare professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
36. EHDSEncounter.admission.admitSourceType
Definition | From where the patient was admitted (e.g. physician referral, transfer).
Short | From where the patient was admitted (e.g. physician referral, transfer).
Control | 0..1
Binding | hl7:admit-source
Type | CodeableConcept
38. EHDSEncounter.admission.admitSource
Definition | From where the patient was admitted (e.g. physician referral, transfer).
Short | From where the patient was admitted (e.g. physician referral, transfer).
Control | 0..1
Binding | hl7:admit-source
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
40. EHDSEncounter.admission.referringProfessional
Definition | Referring Healthcare Professional
Short | Referring Healthcare Professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
42. EHDSEncounter.admission.legalStatus
Definition | Legal status can be either voluntary or involuntary, however the legal status is always determined by a court. A patient can also receive healthcare based on a forensic status. (voluntary, involuntary, admission by legal authority).
Short | Legal status/situation at admission (indicates the basis on which the patient is staying in a healthcare organisation).
Control | 0..1
Binding | SNOMED CT
Type | CodeableConcept
44. EHDSEncounter.discharge
Definition | Discharge details
Short | Discharge details
Control | 0..1
Type | Base
46. EHDSEncounter.discharge.destinationType
Definition | Type of location to which the patient will go after the encounter. E.g. home, hospital, nursing home, left against medical advice etc.
Short | Type of location to which the patient will go after the encounter. E.g. home, hospital, nursing home, left against medical advice etc.
Control | 0..1
Binding | hl7.discharge-disposition
Type | CodeableConcept
48. EHDSEncounter.discharge.destinationLocation[x]
Definition | The location/organisation to which the patient will go after the encounter. Name, address and telecommunication contact.
Short | The location/organisation to which the patient will go after the encounter. Name, address and telecommunication contact.
Control | 0..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSLocation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
50. EHDSEncounter.location
Definition | List of locations where the patient has been.
Short | List of locations where the patient has been.
Control | 0..*
Type | Base
52. EHDSEncounter.location.period
Definition | Time period during which the patient was present at the location
Short | Time period during which the patient was present at the location
Control | 0..1
Type | Period
54. EHDSEncounter.location.organisationPart[x]
Definition | Organisation or organisation part (department) where the patient was present.
Short | Organisation or organisation part (department) where the patient was present.
Control | 1..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSLocation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
56. EHDSEncounter.type
Definition | The type of the encounter whether inpatient or short stay encounter.
Short | Encounter type
Control | 1..1
Binding | hl7v3:ActEncounterCode
Type | CodeableConcept
58. EHDSEncounter.note
Definition | A narrative description of the encounter course.
Short | A narrative description of the encounter course.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
60. EHDSEncounter.episodeOfCare
Definition | Reference to the episode(s) of care that this encounter should be recorded against
Short | Reference to the episode(s) of care that this encounter should be recorded against
Control | 0..*
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEpisodeOfCare
62. EHDSEncounter.basedOn[x]
Definition | Reference to the request that initiated this encounter
Short | Reference to the request that initiated this encounter
Control | 0..*
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCarePlan, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSServiceRequest
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
64. EHDSEncounter.partOf
Definition | Reference to another encounter this encounter is part of
Short | Reference to another encounter this encounter is part of
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEncounter
66. EHDSEncounter.serviceProvider
Definition | The organisation (facility) responsible for this encounter
Short | The organisation (facility) responsible for this encounter
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
68. EHDSEncounter.plannedStartDate
Definition | The planned start date/time (or admission date) of the encounter
Short | The planned start date/time (or admission date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
70. EHDSEncounter.plannedEndDate
Definition | The planned end date/time (or discharge date) of the encounter
Short | The planned end date/time (or discharge date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension

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

0. EHDSEncounter
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. EHDSEncounter.episodeOfCare
Definition | Reference to the episode(s) of care that this encounter should be recorded against
Short | Reference to the episode(s) of care that this encounter should be recorded against
Control | 0..*
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEpisodeOfCare
4. EHDSEncounter.basedOn[x]
Definition | Reference to the request that initiated this encounter
Short | Reference to the request that initiated this encounter
Control | 0..*
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCarePlan, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSServiceRequest
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
6. EHDSEncounter.partOf
Definition | Reference to another encounter this encounter is part of
Short | Reference to another encounter this encounter is part of
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEncounter
8. EHDSEncounter.serviceProvider
Definition | The organisation (facility) responsible for this encounter
Short | The organisation (facility) responsible for this encounter
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
10. EHDSEncounter.plannedStartDate
Definition | The planned start date/time (or admission date) of the encounter
Short | The planned start date/time (or admission date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. EHDSEncounter.plannedEndDate
Definition | The planned end date/time (or discharge date) of the encounter
Short | The planned end date/time (or discharge date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension

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

0. EHDSEncounter
Definition | EHDS refined base model for Encounter
Short | Encounter model
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. EHDSEncounter.header
Definition | Common header for all patient-related data
Short | Common header for all patient-related data
Control | 1..1
Type | Base
4. EHDSEncounter.header.subject
Definition | Patient/subject information
Short | Patient/subject information
Control | 1..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. EHDSEncounter.header.identifier
Definition | Business identifier for the object
Short | Business identifier for the object
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
8. EHDSEncounter.header.authorship
Definition | Resource authoring details
Short | Resource authoring details
Control | 1..*
Type | Base
10. EHDSEncounter.header.authorship.author[x]
Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided.
Short | Author(s) by whom the resource was/were authored. Multiple authors could be provided.
Control | 1..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
12. EHDSEncounter.header.authorship.datetime
Definition | Date and time of authoring/issuing
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. EHDSEncounter.header.lastUpdate
Definition | Date and time of the last update to the resource (may be used for technical corrections).
Short | Date and time of the last update to the resource (may be used for technical corrections).
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. EHDSEncounter.header.status
Definition | Status of the resource or document
Short | Status of the resource or document
Control | 1..1
Type | CodeableConcept
18. EHDSEncounter.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. EHDSEncounter.header.language
Definition | Language in which the resource is written. Language is expressed by the IETF language tag.
Short | Language in which the resource is written. Language is expressed by the IETF language tag.
Control | 0..1
Binding | BCP 47
Type | CodeableConcept
22. EHDSEncounter.priority
Definition | Indicates the urgency of the encounter.
Short | Priority
Control | 0..1
Binding | hl7:v3-xEncounterAdmissionUrgency
Type | CodeableConcept
24. EHDSEncounter.actualPeriod
Definition | The actual start and end time of the encounter
Short | The actual start and end time of the encounter
Control | 0..1
Type | Period
26. EHDSEncounter.admission
Definition | Details about the admission to a healthcare service
Short | Details about the admission to a healthcare service
Control | 0..1
Type | Base
28. EHDSEncounter.admission.reason[x]
Definition | Reason(s) for admission, e.g. problem, procedure or finding.
Short | Reason(s) for admission, e.g. problem, procedure or finding.
Control | 0..*
Type | Choice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCondition, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSProcedure, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSObservation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
30. EHDSEncounter.admission.reasonComment
Definition | Explanation of the reason for the encounter.
Short | Explanation of the reason for the encounter.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
32. EHDSEncounter.admission.admitter
Definition | Admitting healthcare professional
Short | Admitting healthcare professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
34. EHDSEncounter.admission.admittingOrganization
Definition | Admitting healthcare professional
Short | Admitting healthcare professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
36. EHDSEncounter.admission.admitSourceType
Definition | From where the patient was admitted (e.g. physician referral, transfer).
Short | From where the patient was admitted (e.g. physician referral, transfer).
Control | 0..1
Binding | hl7:admit-source
Type | CodeableConcept
38. EHDSEncounter.admission.admitSource
Definition | From where the patient was admitted (e.g. physician referral, transfer).
Short | From where the patient was admitted (e.g. physician referral, transfer).
Control | 0..1
Binding | hl7:admit-source
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
40. EHDSEncounter.admission.referringProfessional
Definition | Referring Healthcare Professional
Short | Referring Healthcare Professional
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
42. EHDSEncounter.admission.legalStatus
Definition | Legal status can be either voluntary or involuntary, however the legal status is always determined by a court. A patient can also receive healthcare based on a forensic status. (voluntary, involuntary, admission by legal authority).
Short | Legal status/situation at admission (indicates the basis on which the patient is staying in a healthcare organisation).
Control | 0..1
Binding | SNOMED CT
Type | CodeableConcept
44. EHDSEncounter.discharge
Definition | Discharge details
Short | Discharge details
Control | 0..1
Type | Base
46. EHDSEncounter.discharge.destinationType
Definition | Type of location to which the patient will go after the encounter. E.g. home, hospital, nursing home, left against medical advice etc.
Short | Type of location to which the patient will go after the encounter. E.g. home, hospital, nursing home, left against medical advice etc.
Control | 0..1
Binding | hl7.discharge-disposition
Type | CodeableConcept
48. EHDSEncounter.discharge.destinationLocation[x]
Definition | The location/organisation to which the patient will go after the encounter. Name, address and telecommunication contact.
Short | The location/organisation to which the patient will go after the encounter. Name, address and telecommunication contact.
Control | 0..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSLocation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
50. EHDSEncounter.location
Definition | List of locations where the patient has been.
Short | List of locations where the patient has been.
Control | 0..*
Type | Base
52. EHDSEncounter.location.period
Definition | Time period during which the patient was present at the location
Short | Time period during which the patient was present at the location
Control | 0..1
Type | Period
54. EHDSEncounter.location.organisationPart[x]
Definition | Organisation or organisation part (department) where the patient was present.
Short | Organisation or organisation part (department) where the patient was present.
Control | 1..1
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSLocation
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
56. EHDSEncounter.type
Definition | The type of the encounter whether inpatient or short stay encounter.
Short | Encounter type
Control | 1..1
Binding | hl7v3:ActEncounterCode
Type | CodeableConcept
58. EHDSEncounter.note
Definition | A narrative description of the encounter course.
Short | A narrative description of the encounter course.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
60. EHDSEncounter.episodeOfCare
Definition | Reference to the episode(s) of care that this encounter should be recorded against
Short | Reference to the episode(s) of care that this encounter should be recorded against
Control | 0..*
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEpisodeOfCare
62. EHDSEncounter.basedOn[x]
Definition | Reference to the request that initiated this encounter
Short | Reference to the request that initiated this encounter
Control | 0..*
Type | Choice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCarePlan, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSServiceRequest
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
64. EHDSEncounter.partOf
Definition | Reference to another encounter this encounter is part of
Short | Reference to another encounter this encounter is part of
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSEncounter
66. EHDSEncounter.serviceProvider
Definition | The organisation (facility) responsible for this encounter
Short | The organisation (facility) responsible for this encounter
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
68. EHDSEncounter.plannedStartDate
Definition | The planned start date/time (or admission date) of the encounter
Short | The planned start date/time (or admission date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
70. EHDSEncounter.plannedEndDate
Definition | The planned end date/time (or discharge date) of the encounter
Short | The planned end date/time (or discharge date) of the encounter
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension