SIL HIE Implementation Guide, published by Kathurima Kimathi. 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/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
Resource Profile: HIE Encounter
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/encounter | Version: 0.1.0 | |||
| Active as of 2026-10-20 | Computable Name: HIEEncounter | |||
An interaction between a patient and healthcare providers to deliver services or assess health status.
Usages:
- Refer to this Profile: HIE AllergyIntolerance, HIE Claim, HIE Condition, HIE DiagnosticReport...
- Examples for this Profile: Encounter/HIEEncounter-example
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |
 use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
  assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |
| type |
C | 0..* | HIECodeableConcept | Specific type of encounter Binding: EncounterType (example): A specific code indicating type of service provided Constraints: cc-text-or-code |
| priority |
C | 0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) Constraints: cc-text-or-code |
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
C | 0..* | HIECodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code |
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |
| reasonCode |
C | 0..* | HIECodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Constraints: cc-text-or-code |
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
C | 0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) Constraints: cc-text-or-code |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |
| admitSource |
C | 0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. Constraints: cc-text-or-code |
| reAdmission |
C | 0..1 | HIECodeableConcept | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. Constraints: cc-text-or-code |
| dietPreference |
C | 0..* | HIECodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: cc-text-or-code |
| specialCourtesy |
C | 0..* | HIECodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. Constraints: cc-text-or-code |
| specialArrangement |
C | 0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. Constraints: cc-text-or-code |
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
C | 0..1 | HIECodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. Constraints: cc-text-or-code |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | EncounterType | 📍4.3.0 | FHIR Std. |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | AdmitSource | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | SpecialCourtesy | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | SpecialArrangements | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | DischargeDisposition | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Encounter.identifier.type, Encounter.type, Encounter.priority, Encounter.participant.type, Encounter.reasonCode, Encounter.diagnosis.use, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.dischargeDisposition | Text is optional, coding is required |
coding.exists()
|
| 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.exists() and ('#'+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(uri) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
| ext-1 | error | **ALL** extensions | 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: |
|---|---|---|---|---|
| Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor |
 identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |
| type |
0..* | HIECodeableConcept | Specific type of encounter | |
| priority |
0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) | |
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |
| type |
0..* | HIECodeableConcept | Role of participant in encounter | |
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |
| reasonCode |
0..* | HIECodeableConcept | Coded reason the encounter takes place | |
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |
| admitSource |
0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) | |
| reAdmission |
0..1 | HIECodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | |
| dietPreference |
0..* | HIECodeableConcept | Diet preferences reported by the patient | |
| specialCourtesy |
0..* | HIECodeableConcept | Special courtesies (VIP, board member) | |
| specialArrangement |
0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. | |
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | HIECodeableConcept | Category or kind of location after discharge | |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| statusHistory |
0..* | BackboneElement | List of past encounter statuses | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified status | |||||
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |||||
| classHistory |
0..* | BackboneElement | List of past encounter classes | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| class |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified class | |||||
| type |
C | 0..* | HIECodeableConcept | Specific type of encounter Binding: EncounterType (example): A specific code indicating type of service provided Constraints: cc-text-or-code | ||||
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
C | 0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) Constraints: cc-text-or-code | ||||
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |||||
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
C | 0..* | HIECodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code | ||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |||||
| period |
0..1 | Period | The start and end time of the encounter | |||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
C | 0..* | HIECodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Constraints: cc-text-or-code | ||||
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |||||
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |||||
| use |
C | 0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) Constraints: cc-text-or-code | ||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |||||
| admitSource |
C | 0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. Constraints: cc-text-or-code | ||||
| reAdmission |
C | 0..1 | HIECodeableConcept | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. Constraints: cc-text-or-code | ||||
| dietPreference |
C | 0..* | HIECodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: cc-text-or-code | ||||
| specialCourtesy |
C | 0..* | HIECodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. Constraints: cc-text-or-code | ||||
| specialArrangement |
C | 0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. Constraints: cc-text-or-code | ||||
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
C | 0..1 | HIECodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. Constraints: cc-text-or-code | ||||
| location |
0..* | BackboneElement | List of locations where the patient has been | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType |
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. | |||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | EncounterType | 📍4.3.0 | FHIR Std. |
| Encounter.serviceType | Base | example | ServiceType | 📍4.3.0 | FHIR Std. |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | AdmitSource | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | SpecialCourtesy | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | SpecialArrangements | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | DischargeDisposition | 📍4.3.0 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.3.0 | FHIR Std. |
| Encounter.location.physicalType | Base | example | LocationType | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Encounter.identifier.type, Encounter.type, Encounter.priority, Encounter.participant.type, Encounter.reasonCode, Encounter.diagnosis.use, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.dischargeDisposition | Text is optional, coding is required |
coding.exists()
|
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Encounter.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 21 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE EpisodeOfCare (https://nshr.dha.go.ke/fhir/StructureDefinition/episodeofcare)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
- HIE Encounter (https://nshr.dha.go.ke/fhir/StructureDefinition/encounter)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |
| type |
C | 0..* | HIECodeableConcept | Specific type of encounter Binding: EncounterType (example): A specific code indicating type of service provided Constraints: cc-text-or-code |
| priority |
C | 0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) Constraints: cc-text-or-code |
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
C | 0..* | HIECodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code |
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |
| reasonCode |
C | 0..* | HIECodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Constraints: cc-text-or-code |
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
C | 0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) Constraints: cc-text-or-code |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |
| admitSource |
C | 0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. Constraints: cc-text-or-code |
| reAdmission |
C | 0..1 | HIECodeableConcept | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. Constraints: cc-text-or-code |
| dietPreference |
C | 0..* | HIECodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: cc-text-or-code |
| specialCourtesy |
C | 0..* | HIECodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. Constraints: cc-text-or-code |
| specialArrangement |
C | 0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. Constraints: cc-text-or-code |
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
C | 0..1 | HIECodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. Constraints: cc-text-or-code |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | EncounterType | 📍4.3.0 | FHIR Std. |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | AdmitSource | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | SpecialCourtesy | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | SpecialArrangements | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | DischargeDisposition | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Encounter.identifier.type, Encounter.type, Encounter.priority, Encounter.participant.type, Encounter.reasonCode, Encounter.diagnosis.use, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.dischargeDisposition | Text is optional, coding is required |
coding.exists()
|
| 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.exists() and ('#'+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(uri) = '#').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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
| ext-1 | error | **ALL** extensions | 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: |
|---|---|---|---|---|
| Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor |
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |
| type |
0..* | HIECodeableConcept | Specific type of encounter | |
| priority |
0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) | |
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |
| type |
0..* | HIECodeableConcept | Role of participant in encounter | |
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |
| reasonCode |
0..* | HIECodeableConcept | Coded reason the encounter takes place | |
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |
| admitSource |
0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) | |
| reAdmission |
0..1 | HIECodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | |
| dietPreference |
0..* | HIECodeableConcept | Diet preferences reported by the patient | |
| specialCourtesy |
0..* | HIECodeableConcept | Special courtesies (VIP, board member) | |
| specialArrangement |
0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. | |
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | HIECodeableConcept | Category or kind of location after discharge | |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter |
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: enc-reason-present, enc-participant-has-actor | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Identifier(s) by which this encounter is known | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| statusHistory |
0..* | BackboneElement | List of past encounter statuses | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified status | |||||
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (required) | |||||
| classHistory |
0..* | BackboneElement | List of past encounter classes | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| class |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period |
1..1 | Period | The time that the episode was in the specified class | |||||
| type |
C | 0..* | HIECodeableConcept | Specific type of encounter Binding: EncounterType (example): A specific code indicating type of service provided Constraints: cc-text-or-code | ||||
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | |||||
| priority |
C | 0..1 | HIECodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) Constraints: cc-text-or-code | ||||
| subject |
1..1 | HIEReference(Patient) | The patient or group present at the encounter | |||||
| episodeOfCare |
1..* | HIEReference(HIE EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |||||
| basedOn |
0..* | HIEReference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| participant |
1..* | BackboneElement | List of participants involved in the encounter | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
C | 0..* | HIECodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code | ||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual |
0..1 | HIEReference(HIE Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |||||
| appointment |
0..* | HIEReference(Appointment) | The appointment that scheduled this encounter | |||||
| period |
0..1 | Period | The start and end time of the encounter | |||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| reasonCode |
C | 0..* | HIECodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. Constraints: cc-text-or-code | ||||
| reasonReference |
0..* | HIEReference(Condition | Procedure | Observation) | Reason the encounter takes place (reference) | |||||
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| condition |
1..1 | HIEReference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |||||
| use |
C | 0..1 | HIECodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred) Constraints: cc-text-or-code | ||||
| rank |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||
| origin |
0..1 | HIEReference(Location | HIE Organization) | The location/organization from which the patient came before admission | |||||
| admitSource |
C | 0..1 | HIECodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. Constraints: cc-text-or-code | ||||
| reAdmission |
C | 0..1 | HIECodeableConcept | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. Constraints: cc-text-or-code | ||||
| dietPreference |
C | 0..* | HIECodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: cc-text-or-code | ||||
| specialCourtesy |
C | 0..* | HIECodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. Constraints: cc-text-or-code | ||||
| specialArrangement |
C | 0..* | HIECodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. Constraints: cc-text-or-code | ||||
| destination |
0..1 | HIEReference(Location | HIE Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition |
C | 0..1 | HIECodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. Constraints: cc-text-or-code | ||||
| location |
0..* | BackboneElement | List of locations where the patient has been | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| location |
1..1 | HIEReference(Location) | Location the encounter takes place | |||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType |
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. | |||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider |
1..1 | HIEReference(HIE Organization) | The organization (facility) responsible for this encounter | |||||
| partOf |
0..1 | HIEReference(HIE Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.3.0 | FHIR Std. |
| Encounter.class | Base | required | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.type | Base | example | EncounterType | 📍4.3.0 | FHIR Std. |
| Encounter.serviceType | Base | example | ServiceType | 📍4.3.0 | FHIR Std. |
| Encounter.priority | Base | required | ActPriority | 📦3.0.0 | THO v7.4 |
| Encounter.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📦4.3.0 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | AdmitSource | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.4 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | SpecialCourtesy | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | SpecialArrangements | 📍4.3.0 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | DischargeDisposition | 📍4.3.0 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.3.0 | FHIR Std. |
| Encounter.location.physicalType | Base | example | LocationType | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | Encounter.identifier.type, Encounter.type, Encounter.priority, Encounter.participant.type, Encounter.reasonCode, Encounter.diagnosis.use, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.dischargeDisposition | Text is optional, coding is required |
coding.exists()
|
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Encounter.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-participant-has-actor | error | Encounter | Participant must reference an actor when type is present |
participant.where(type.exists()).all(individual.exists())
|
| enc-reason-present | error | Encounter | Provide at least one reasonCode or reasonReference |
reasonCode.exists() or reasonReference.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Encounter
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 21 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE EpisodeOfCare (https://nshr.dha.go.ke/fhir/StructureDefinition/episodeofcare)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
- HIE Encounter (https://nshr.dha.go.ke/fhir/StructureDefinition/encounter)
Other representations of profile: CSV, Excel, Schematron