NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

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:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
.... 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.
... 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

doco 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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... language 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... Slices for identifier 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... 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
... classHistory 0..0
... type 0..0
... serviceType 0..1 CodeableConcept Specific type of service
Binding: Service Type (required)
... priority 0..0
... subject 0..1 Reference(PH Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... diagnosis
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... condition 1..1 Reference(PH Condition | PH Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..0
.... rank 0..0
... account 0..0
... hospitalization
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... preAdmissionIdentifier 0..0
.... admitSource 0..0
.... reAdmission 0..0
.... dietPreference 0..0
.... specialCourtesy 0..0
.... specialArrangement 0..0
.... 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
.... extension 0..0
.... modifierExtension 0..0
.... status 0..0
.... 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
... serviceProvider 0..1 Reference(PH Organization) The organization (facility) responsible for this encounter
... partOf 0..0

doco 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.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
.... 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

doco 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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
.... 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.
... 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

doco 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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... language 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... Slices for identifier 0..* Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Open by value:system
.... 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
... classHistory 0..0
... type 0..0
... serviceType 0..1 CodeableConcept Specific type of service
Binding: Service Type (required)
... priority 0..0
... subject 0..1 Reference(PH Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... diagnosis
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... condition 1..1 Reference(PH Condition | PH Procedure) The diagnosis or procedure relevant to the encounter
.... use 0..0
.... rank 0..0
... account 0..0
... hospitalization
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... preAdmissionIdentifier 0..0
.... admitSource 0..0
.... reAdmission 0..0
.... dietPreference 0..0
.... specialCourtesy 0..0
.... specialArrangement 0..0
.... 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
.... extension 0..0
.... modifierExtension 0..0
.... status 0..0
.... 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
... serviceProvider 0..1 Reference(PH Organization) The organization (facility) responsible for this encounter
... partOf 0..0

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
.... 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

doco 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 v6.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v6.5
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()

 

Other representations of profile: CSV, Excel, Schematron