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 Immunization

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Immunization Version: 0.1.0
Standards status: Draft Computable Name: PH_Immunization

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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
.. Immunization 0..* Immunization Immunization event information
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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 Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... status 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... patient 1..1 Reference(PH Patient) Who was immunized
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... primarySource 0..0
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... location 0..0
... manufacturer 0..0
... lotNumber 0..0
... expirationDate 0..0
... site 0..0
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... performer
.... extension 0..0
.... modifierExtension 0..0
.... function 0..0
.... actor 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... detail 0..1 Reference(PH Observation) Additional information on reaction
... protocolApplied 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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".
... identifier 0..* Identifier Business identifier
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... patient Σ 1..1 Reference(PH Patient) Who was immunized
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... actor Σ 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(PH Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Immunization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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
.. Immunization 0..* Immunization Immunization event information
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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 Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... status 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... patient 1..1 Reference(PH Patient) Who was immunized
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... primarySource 0..0
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... location 0..0
... manufacturer 0..0
... lotNumber 0..0
... expirationDate 0..0
... site 0..0
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... performer
.... extension 0..0
.... modifierExtension 0..0
.... function 0..0
.... actor 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... detail 0..1 Reference(PH Observation) Additional information on reaction
... protocolApplied 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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".
... identifier 0..* Identifier Business identifier
... statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
... patient Σ 1..1 Reference(PH Patient) Who was immunized
... encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... actor Σ 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(PH Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Immunization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.vaccineCode Base required Drug Codes 📦0.1.0 This IG
Immunization.reportOrigin Base required Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.route Base required Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base required ActNoImmunizationReason 📦3.0.0 THO v6.5
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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