Amakomaya Nepal FHIR Implementation Guide
2.0.0 - ci-build
Nepal
Amakomaya Nepal FHIR Implementation Guide
2.0.0 - ci-build
Nepal
Amakomaya Nepal FHIR Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.amakomaya.com/StructureDefinition/amk-encounter | Version: 2.0.0 | |||
| Active as of 2026-08-21 | Computable Name: AMKEncounter | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
Encounter representing in the Amakomaya app.
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 |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| status |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: in-progress |
 serviceType |
Σ | 0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) |
| subject |
SΣ | 1..1 | Reference(Patient) | The patient or group related to this encounter |
 plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | Encounter Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | 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())
|
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 | |
 status |
1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Required Pattern: in-progress | |
| serviceType |
0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) | |
| subject |
S | 1..1 | Reference(Patient) | The patient or group related to this encounter |
| plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
| 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: AllLanguages (required): IETF language tag for 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: in-progress | ||||||||
 businessStatus |
0..* | BackboneElement | A granular, workflows specific set of statuses that apply to 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 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| code |
1..1 | CodeableConcept | The current business status Binding Description: (example): The current business status.
| |||||||||
| type |
0..1 | CodeableConcept | The kind of workflow the status is tracking Binding: EncounterBusinessStatusType (example): The kind of workflow the status is tracking (e.g., inpatient, outpatient, emergency). | |||||||||
| effectiveDate |
0..1 | dateTime | When the encounter entered this business status | |||||||||
| class |
Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||||||
| priority |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||||||
| type |
Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||||||
| serviceType |
Σ | 0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) | ||||||||
| subject |
SΣ | 1..1 | Reference(Patient) | The patient or group related to this encounter | ||||||||
| subjectStatus |
0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest | RequestOrchestration | NutritionOrder | VisionPrescription) | The request that initiated this encounter | |||||||||
| careTeam |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||||||
| serviceProvider |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||||||
| participant |
ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| type |
ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (preferred): Role of participant in encounter. | ||||||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||||||
| actor |
ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||||||
| virtualService |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||||||
| actualPeriod |
0..1 | Period | The actual start and end time of the encounter | |||||||||
| plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||||||
| plannedEndDate |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||||||
| length |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||||||
| reason |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during 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 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| use |
Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||||||
| value |
Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| condition |
Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||||||
| use |
0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||||||
| dietPreference |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||||
| specialArrangement |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||||||
| specialCourtesy |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||||||
| admission |
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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||||||
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||||||
| reAdmission |
0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||||||
 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| location |
1..1 | Reference(Location) | Location the encounter takes place | |||||||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||||
| form |
0..1 | CodeableConcept | The form of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Form of the location. | |||||||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.businessStatus.code | Base | example | Not State | Unknown | |
| Encounter.businessStatus.type | Base | example | Encounter Business Status Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.class | Base | preferred | Encounter class | 📦2.0.1 | THO v7.3 |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.3 |
| Encounter.type | Base | example | Encounter Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
| Encounter.subjectStatus | Base | example | Encounter Subject Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.participant.type | Base | preferred | Participant Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.reason.use | Base | example | Encounter Reason Use | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.reason.value | Base | preferred | Encounter Reason Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.diagnosis.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | Encounter Diagnosis Use | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.dietPreference | Base | example | Diet | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.specialArrangement | Base | preferred | Special Arrangements | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.specialCourtesy | Base | preferred | Special Courtesy | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.admission.admitSource | Base | preferred | Admit Source | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.admission.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.3 |
| Encounter.admission.dischargeDisposition | Base | example | Discharge Disposition | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.location.status | Base | required | Encounter Location Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.location.form | Base | example | Location Form | 📍6.0.0-ballot5 | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | 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-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified |
actor.exists() or type.exists()
|
| enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant |
actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
|
This structure is derived from Encounter
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 |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| status |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: in-progress |
| serviceType |
Σ | 0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) |
| subject |
SΣ | 1..1 | Reference(Patient) | The patient or group related to this encounter |
| plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | Encounter Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | 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())
|
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 | |
| status |
1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Required Pattern: in-progress | |
| serviceType |
0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) | |
| subject |
S | 1..1 | Reference(Patient) | The patient or group related to this encounter |
| plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
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: AllLanguages (required): IETF language tag for 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||||||
| identifier |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||||
| status |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: in-progress | ||||||||
| businessStatus |
0..* | BackboneElement | A granular, workflows specific set of statuses that apply to 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 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| code |
1..1 | CodeableConcept | The current business status Binding Description: (example): The current business status.
| |||||||||
| type |
0..1 | CodeableConcept | The kind of workflow the status is tracking Binding: EncounterBusinessStatusType (example): The kind of workflow the status is tracking (e.g., inpatient, outpatient, emergency). | |||||||||
| effectiveDate |
0..1 | dateTime | When the encounter entered this business status | |||||||||
| class |
Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||||||
| priority |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||||||
| type |
Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||||||
| serviceType |
Σ | 0..1 | CodeableReference(HealthcareService) | The specific service that is to be performed during this encounter Binding: AMK Application Mode (required) | ||||||||
| subject |
SΣ | 1..1 | Reference(Patient) | The patient or group related to this encounter | ||||||||
| subjectStatus |
0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||||||
| episodeOfCare |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest | RequestOrchestration | NutritionOrder | VisionPrescription) | The request that initiated this encounter | |||||||||
| careTeam |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||||||
| partOf |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||||||
| serviceProvider |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||||||
| participant |
ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| type |
ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (preferred): Role of participant in encounter. | ||||||||
| period |
0..1 | Period | Period of time during the encounter that the participant participated | |||||||||
| actor |
ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||||||
| appointment |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||||||
| virtualService |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||||||
| actualPeriod |
0..1 | Period | The actual start and end time of the encounter | |||||||||
| plannedStartDate |
1..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||||||
| plannedEndDate |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||||||
| length |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||||||
| reason |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during 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 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| use |
Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||||||
| value |
Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||||
| 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| condition |
Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||||||
| use |
0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||||||
| dietPreference |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||||
| specialArrangement |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||||||
| specialCourtesy |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||||||
| admission |
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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| preAdmissionIdentifier |
0..1 | Identifier | Pre-admission identifier | |||||||||
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||||||
| admitSource |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||||||
| reAdmission |
0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||||||
| destination |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||||||
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||||||
| 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 Slice: Unordered, Open by value:url | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||||||
| location |
1..1 | Reference(Location) | Location the encounter takes place | |||||||||
| status |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||||
| form |
0..1 | CodeableConcept | The form of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Form of the location. | |||||||||
| period |
0..1 | Period | Time period during which the patient was present at the location | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.status | Base | required | Encounter Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.businessStatus.code | Base | example | Not State | Unknown | |
| Encounter.businessStatus.type | Base | example | Encounter Business Status Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.class | Base | preferred | Encounter class | 📦2.0.1 | THO v7.3 |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v7.3 |
| Encounter.type | Base | example | Encounter Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.serviceType | Base | required | AMK Application Mode | 📦2.0.0 | This IG |
| Encounter.subjectStatus | Base | example | Encounter Subject Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.participant.type | Base | preferred | Participant Type | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.reason.use | Base | example | Encounter Reason Use | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.reason.value | Base | preferred | Encounter Reason Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.diagnosis.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | Encounter Diagnosis Use | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.dietPreference | Base | example | Diet | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.specialArrangement | Base | preferred | Special Arrangements | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.specialCourtesy | Base | preferred | Special Courtesy | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.admission.admitSource | Base | preferred | Admit Source | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.admission.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦3.0.0 | THO v7.3 |
| Encounter.admission.dischargeDisposition | Base | example | Discharge Disposition | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.location.status | Base | required | Encounter Location Status | 📍6.0.0-ballot5 | FHIR Std. |
| Encounter.location.form | Base | example | Location Form | 📍6.0.0-ballot5 | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | 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-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified |
actor.exists() or type.exists()
|
| enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant |
actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
|
This structure is derived from Encounter
Other representations of profile: CSV, Excel, Schematron