Draft PH Core Implementation Guide
0.2.0 - ci-build
Draft PH Core Implementation Guide
0.2.0 - ci-build
Draft PH Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/ph-core-encounter | Version: 0.2.0 | |||
| Draft as of 2026-04-10 | Computable Name: PHCoreEncounter | |||
This profile sets minimum expectations for an Encounter resource to record, search, and fetch basic encounter information for a patient. It is based on the FHIR R4 Encounter resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Encounter when conforming to this profile. It provides the floor for standards development for specific uses cases in a Philippine context.
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:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
 identifier |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||||
| class |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||||||
| type |
SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||||
 serviceType |
SOΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
| ||||||||
 coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
 text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
 subject |
SΣ | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| participant |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| type |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||||
| individual |
Σ | 0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | ||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| reasonReference |
SΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | 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 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | ||||||||
 use |
SO | 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.
| ||||||||
 coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| hospitalization |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| origin |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||||||
| location |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| location |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| physicalType |
SO | 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.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | 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.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| 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 | example | Discharge disposition | 📍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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| 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 |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
 identifier |
S | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||||||
| class |
S | 1..1 | Coding | Classification of patient encounter | ||||||||
| type |
S | 0..* | CodeableConcept | Specific type of encounter | ||||||||
| serviceType |
SO | 0..1 | CodeableConcept | Specific type of service
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
S | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| participant |
S | 0..* | BackboneElement | List of participants involved in the encounter | ||||||||
| type |
S | 0..* | CodeableConcept | Role of participant in encounter | ||||||||
| individual |
0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | |||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| start |
S | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| reasonCode |
S | 0..* | CodeableConcept | Coded reason the encounter takes place | ||||||||
| reasonReference |
S | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||||||
| diagnosis |
||||||||||||
| condition |
1..1 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | |||||||||
| use |
SO | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| hospitalization |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||||||
| origin |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc.
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge | ||||||||
| location |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||||||
| location |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| physicalType |
SO | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | The organization (facility) responsible for this encounter | ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
| 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): A human language.
| |||||||||
| 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 | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!SΣ | 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 |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||||||
| 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 |
SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||||
| serviceType |
SOΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SΣ | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||||||
| participant |
SΣ | 0..* | 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 |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||||||
| individual |
Σ | 0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | ||||||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| reasonReference |
SΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | 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 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | ||||||||
| use |
SO | 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.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
S | 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 |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||||||
| location |
S | 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 |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||||
| physicalType |
SO | 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.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | The organization (facility) responsible for this encounter | ||||||||
| partOf |
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.0 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| 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 | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| 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: 1 element
Must-Support: 44 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||||
| class |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||||||
| type |
SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||||
| serviceType |
SOΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SΣ | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| participant |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| type |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||||
| individual |
Σ | 0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | ||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| reasonReference |
SΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | 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 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | ||||||||
| use |
SO | 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.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| hospitalization |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| origin |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||||||
| location |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| location |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| physicalType |
SO | 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.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | 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.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| 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 | example | Discharge disposition | 📍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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| 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 |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
| identifier |
S | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||||||
| class |
S | 1..1 | Coding | Classification of patient encounter | ||||||||
| type |
S | 0..* | CodeableConcept | Specific type of encounter | ||||||||
| serviceType |
SO | 0..1 | CodeableConcept | Specific type of service
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
S | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| participant |
S | 0..* | BackboneElement | List of participants involved in the encounter | ||||||||
| type |
S | 0..* | CodeableConcept | Role of participant in encounter | ||||||||
| individual |
0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | |||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| start |
S | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| reasonCode |
S | 0..* | CodeableConcept | Coded reason the encounter takes place | ||||||||
| reasonReference |
S | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||||||
| diagnosis |
||||||||||||
| condition |
1..1 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | |||||||||
| use |
SO | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| hospitalization |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||||||
| origin |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc.
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge | ||||||||
| location |
S | 0..* | BackboneElement | List of locations where the patient has been | ||||||||
| location |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| physicalType |
SO | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | The organization (facility) responsible for this encounter | ||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |||||||||
| 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): A human language.
| |||||||||
| 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 | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!SΣ | 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 |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||||||
| 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 |
SΣ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||||
| serviceType |
SOΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| priority |
SO | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SΣ | 1..1 | Reference(PH Core Patient | Group) | The patient or group present at the encounter | ||||||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||||||
| basedOn |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||||||
| participant |
SΣ | 0..* | 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 |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||||||
| individual |
Σ | 0..1 | Reference(PH Core Practitioner | PH Core RelatedPerson | PH Core PractitionerRole) | Persons involved in the encounter other than the patient | ||||||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||||||
| period |
S | 0..1 | Period | The start and end time of the encounter | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| reasonReference |
SΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | ImmunizationRecommendation) | 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 | Reference(Condition | PH Core Procedure) | The diagnosis or procedure relevant to the encounter | ||||||||
| use |
SO | 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.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
S | 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 |
S | 0..1 | Reference(PH Core Location | PH Core Organization) | The location/organization from which the patient came before admission | ||||||||
| admitSource |
SO | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reAdmission |
SO | 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: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| dietPreference |
SO | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialCourtesy |
SO | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| specialArrangement |
SO | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||
| dischargeDisposition |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||||||
| location |
S | 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 |
S | 1..1 | Reference(PH Core Location) | Location the encounter takes place | ||||||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||||
| physicalType |
SO | 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.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||||||
| serviceProvider |
S | 0..1 | Reference(PH Core Organization) | The organization (facility) responsible for this encounter | ||||||||
| partOf |
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.0 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.0 |
| Encounter.type | Base | example | Encounter type | 📍4.0.1 | FHIR Std. |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.0 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v7.0 |
| 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 | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| 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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| 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: 1 element
Must-Support: 44 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron