IE (Ireland) Core Implementation Guide
0.3.0 - draft
IE (Ireland) Core Implementation Guide - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-encounter | Version: 0.3.0 | |||
| Draft as of 2026-09-28 | Computable Name: IECoreEncounter | |||
The IE Core Encounter Profile is based upon the core FHIR Encounter Resource and defines the minimum set of data required to query and retrieve encounter information within the Irish healthcare system. It establishes constraints on encounter type, subject, and hospitalization discharge disposition.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. |
![]() ![]() |
SΣ | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) |
![]() ![]() |
SΣ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location |
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Encounter.implicitRules, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.hospitalization, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.period, Encounter.serviceProvider | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.modifierExtension, Encounter.statusHistory.modifierExtension, Encounter.participant.modifierExtension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |
![]() ![]() |
S | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) |
![]() ![]() |
S | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service |
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter |
![]() ![]() |
S | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated |
![]() ![]() ![]() |
S | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) |
![]() ![]() |
S | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location |
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status | ||||
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) | ||||
![]() ![]() |
SΣ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) | ||||
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place | ||||
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location | ||||
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.appointment, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 2 elements
Must-Support: 34 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status |
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. |
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. |
![]() ![]() |
SΣ | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter |
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) |
![]() ![]() |
SΣ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location |
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Encounter.implicitRules, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.hospitalization, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.period, Encounter.serviceProvider | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.modifierExtension, Encounter.statusHistory.modifierExtension, Encounter.participant.modifierExtension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.modifierExtension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |
![]() ![]() |
S | 0..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status |
![]() ![]() |
S | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) |
![]() ![]() |
S | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service |
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter |
![]() ![]() |
S | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter |
![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Role of participant in encounter |
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated |
![]() ![]() ![]() |
S | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient |
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter |
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
![]() ![]() |
S | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) |
![]() ![]() |
S | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() |
S | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient |
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been |
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place |
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location |
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter(4.0.1) | An interaction during which services are provided to the patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() |
S | 0..* | BackboneElement | List of past encounter statuses | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
S | 1..1 | Period | The time that the episode was in the specified status | ||||
![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter (e.g. ambulatory, inpatient, emergency) Binding: ActEncounterCode (3.0.0) (extensible) | ||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() |
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: IECoreEncounterType (0.3.0) (extensible) | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(IE Core Patient(0.3.0)) | The patient present at the encounter | ||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(IE Core Practitioner(0.3.0) | IE Core PractitionerRole(0.3.0) | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() |
S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (extensible) | ||||
![]() ![]() |
SΣ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: IECoreAdmitSource (0.3.0) (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this hospitalization encounter. | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: IECoreDischargeDisposition (0.3.0) (extensible) | ||||
![]() ![]() |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(IE Core Location(0.3.0)) | Location the encounter takes place | ||||
![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Time period during which the patient was present at the location | ||||
![]() ![]() |
S | 0..1 | Reference(IE Core Organization(0.3.0)) | The organization (facility) responsible for this encounter | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📍3.0.0 | THO v7.4 |
| Encounter.type | Base | extensible | IE Core Encounter Type | 📍0.3.0 | This IG |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | extensible | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | extensible | IE Core Admission Source | 📍0.3.0 | This IG |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | extensible | IE Core Discharge Disposition | 📍0.3.0 | This IG |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Encounter | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.appointment, Encounter.period, Encounter.length, Encounter.reasonCode, Encounter.reasonReference, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 2 elements
Must-Support: 34 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron