NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions
Resource Profile: PH Encounter
| Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Encounter | Version: 0.1.0 | |||
| Standards status: Draft | Computable Name: PH_Encounter | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.
Usages:
- Refer to this Profile: Encounter (Extension), PH AllergyIntolerance, PH Condition, PH DiagnosticReport...
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
 extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
 Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
   use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
 system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
 identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
 status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". Binding: EncounterStatus (required): Current state of the encounter. | |
 class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
 subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
 serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier:PhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
Constraints
| 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 | |
 meta |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
| extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
 modifierExtension |
0..0 | Extension | ||
| Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
 type |
||||
  coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NIIP | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: placeholder | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
| identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: COVID | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
| status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". | |
| statusHistory |
0..0 | List of past encounter statuses | ||
| classHistory |
0..0 | List of past encounter classes | ||
| type |
0..0 | Specific type of encounter | ||
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
| priority |
0..0 | Indicates the urgency of the encounter | ||
| subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
| episodeOfCare |
0..0 | Episode(s) of care that this encounter should be recorded against | ||
| basedOn |
0..0 | The ServiceRequest that initiated this encounter | ||
| participant |
0..0 | List of participants involved in the encounter | ||
| appointment |
0..0 | The appointment that scheduled this encounter | ||
| diagnosis |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| condition |
1..1 | Reference(PH Condition | PH Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
0..0 | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) | ||
| rank |
0..0 | Ranking of the diagnosis (for each role type) | ||
| account |
0..0 | The set of accounts that may be used for billing for this Encounter | ||
| hospitalization |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| preAdmissionIdentifier |
0..0 | Pre-admission identifier | ||
| admitSource |
0..0 | From where patient was admitted (physician referral, transfer) | ||
| reAdmission |
0..0 | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | ||
| dietPreference |
0..0 | Diet preferences reported by the patient | ||
| specialCourtesy |
0..0 | Special courtesies (VIP, board member) | ||
| specialArrangement |
0..0 | Wheelchair, translator, stretcher, etc. | ||
| destination |
0..1 | Reference(Location | PH Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
| location |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| status |
0..0 | planned | active | reserved | completed | ||
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (required) | |
| period |
0..0 | Time period during which the patient was present at the location | ||
| serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..0 | Another Encounter this encounter is part of | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | required | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | required | Location type | 📦4.0.1 | FHIR Std. |
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
| extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
| Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NIIP | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: placeholder | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: COVID | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
| subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
| period |
0..1 | Period | The start and end time of the encounter | |
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | Reference(PH Condition | PH Procedure) | The diagnosis or procedure relevant to the encounter | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |
| destination |
0..1 | Reference(Location | PH Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| location |
1..1 | Reference(Location) | Location the encounter takes place | |
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (required) | |
| serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:PhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:PhilHealthID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
| 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.hospitalization.dischargeDisposition | Base | required | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | required | Location type | 📦4.0.1 | FHIR Std. |
Constraints
| 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: 0 element(3 nested mandatory elements)
Prohibited: 34 elements
Structures
This structure refers to these other structures:
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Condition (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Condition)
- PH Procedure (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Procedure)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)
Extensions
This structure refers to these extensions:
- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays
- https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification
- https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer
- https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName
- https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview
- https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation
- https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Encounter.identifier
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
| extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
| Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
| identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
| status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
| subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
| serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.identifier:PhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
Constraints
| 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 | |
| meta |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
| extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
| modifierExtension |
0..0 | Extension | ||
| Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NIIP | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: placeholder | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
| identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| type |
||||
| coding |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: COVID | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
| status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". | |
| statusHistory |
0..0 | List of past encounter statuses | ||
| classHistory |
0..0 | List of past encounter classes | ||
| type |
0..0 | Specific type of encounter | ||
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
| priority |
0..0 | Indicates the urgency of the encounter | ||
| subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
| episodeOfCare |
0..0 | Episode(s) of care that this encounter should be recorded against | ||
| basedOn |
0..0 | The ServiceRequest that initiated this encounter | ||
| participant |
0..0 | List of participants involved in the encounter | ||
| appointment |
0..0 | The appointment that scheduled this encounter | ||
| diagnosis |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| condition |
1..1 | Reference(PH Condition | PH Procedure) | The diagnosis or procedure relevant to the encounter | |
| use |
0..0 | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) | ||
| rank |
0..0 | Ranking of the diagnosis (for each role type) | ||
| account |
0..0 | The set of accounts that may be used for billing for this Encounter | ||
| hospitalization |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| preAdmissionIdentifier |
0..0 | Pre-admission identifier | ||
| admitSource |
0..0 | From where patient was admitted (physician referral, transfer) | ||
| reAdmission |
0..0 | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | ||
| dietPreference |
0..0 | Diet preferences reported by the patient | ||
| specialCourtesy |
0..0 | Special courtesies (VIP, board member) | ||
| specialArrangement |
0..0 | Wheelchair, translator, stretcher, etc. | ||
| destination |
0..1 | Reference(Location | PH Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
| location |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| status |
0..0 | planned | active | reserved | completed | ||
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (required) | |
| period |
0..0 | Time period during which the patient was present at the location | ||
| serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| partOf |
0..0 | Another Encounter this encounter is part of | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
| Encounter.hospitalization.dischargeDisposition | Base | required | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | required | Location type | 📦4.0.1 | FHIR Std. |
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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ageYears |
0..* | integer | Age in Years URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears | |
| extension:ageMonths |
0..* | integer | Age in Months URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths | |
| extension:ageDays |
0..* | integer | Age in Days URL: https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays | |
| extension:patientClassification |
0..* | string | Patient Classification URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification | |
| extension:interviewer |
0..* | HumanName | Interviewer URL: https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer | |
| extension:investigatorName |
0..* | HumanName | Investigator URL: https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName | |
| extension:dateInterview |
0..* | dateTime | Date of Interview URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview | |
| extension:dateInvestigation |
0..* | dateTime | Date of Investigation URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation | |
| extension:reporterName |
0..* | HumanName | Reporter URL: https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName | |
| Slices for identifier |
0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PhilHealthID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NIIP | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier:COVIDDataID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: placeholder | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/coviddata-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier:COVIDPatientID |
0..1 | Identifier | Identifier(s) by which this encounter is known | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| 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 |
0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: COVID | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://nhdr.gov.ph/fhir/Identifier/covidpatient-id | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | NHDR will only use "triaged", "in-progress", "cancelled", and "finished". Binding: EncounterStatus (required): Current state of the encounter. | |
| class |
1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | |
| serviceType |
0..1 | CodeableConcept | Specific type of service Binding: Service Type (required) | |
| subject |
0..1 | Reference(PH Patient) | The patient or group present at the encounter | |
| period |
0..1 | Period | The start and end time of the encounter | |
| length |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |
| reasonCode |
0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | |
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |
| diagnosis |
0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| condition |
1..1 | Reference(PH Condition | PH Procedure) | The diagnosis or procedure relevant to the encounter | |
| hospitalization |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
| origin |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |
| destination |
0..1 | Reference(Location | PH Organization) | Location/organization to which the patient is discharged | |
| dischargeDisposition |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (required) | |
| location |
0..* | BackboneElement | List of locations where the patient has been | |
| location |
1..1 | Reference(Location) | Location the encounter takes place | |
| physicalType |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (required) | |
| serviceProvider |
0..1 | Reference(PH Organization) | The organization (facility) responsible for this encounter | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Encounter.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:PhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:PhilHealthID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDDataID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Encounter.identifier:COVIDPatientID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v7.4 |
| Encounter.serviceType | Base | required | Service Type | 📦0.1.0 | This IG |
| 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.hospitalization.dischargeDisposition | Base | required | Discharge disposition | 📦4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | required | Location type | 📦4.0.1 | FHIR Std. |
Constraints
| 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: 0 element(3 nested mandatory elements)
Prohibited: 34 elements
Structures
This structure refers to these other structures:
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Condition (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Condition)
- PH Procedure (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Procedure)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)
Extensions
This structure refers to these extensions:
- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeYears
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeMonths
- https://nhdr.gov.ph/fhir/StructureDefinition/AgeDays
- https://nhdr.gov.ph/fhir/StructureDefinition/PatientClassification
- https://nhdr.gov.ph/fhir/StructureDefinition/Interviewer
- https://nhdr.gov.ph/fhir/StructureDefinition/InvestigatorName
- https://nhdr.gov.ph/fhir/StructureDefinition/DateInterview
- https://nhdr.gov.ph/fhir/StructureDefinition/DateInvestigation
- https://nhdr.gov.ph/fhir/StructureDefinition/ReporterName
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Encounter.identifier
Other representations of profile: CSV, Excel, Schematron