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 Specification

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: doco
Immunization 0..* Immunization Immunization event information
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient This element is included in summaries. 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.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 v7.4
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 v7.4

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: doco
Immunization 0..* Immunization Immunization event information
Immunization.meta
Immunization.meta.Slices for extension Content/Rules for all slices
Immunization.meta.Slices for extension.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
Immunization.meta.Slices for extension.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
Immunization.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Immunization.implicitRules 0..0 A set of rules under which this content was created
Immunization.language 0..0 Language of the resource content
Immunization.text 0..0 Text summary of the resource, for human interpretation
Immunization.contained 0..0 Contained, inline Resources
Immunization.extension 0..0 Extension
Immunization.modifierExtension 0..0 Extension
Immunization.status 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.primarySource 0..0 Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.location 0..0 Where immunization occurred
Immunization.manufacturer 0..0 Vaccine manufacturer
Immunization.lotNumber 0..0 Vaccine lot number
Immunization.expirationDate 0..0 Vaccine expiration date
Immunization.site 0..0 Body site vaccine was administered
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.performer
Immunization.performer.extension 0..0 Extension
Immunization.performer.modifierExtension 0..0 Extension
Immunization.performer.function 0..0 What type of performance was done
Immunization.performer.actor 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
Immunization.reasonReference 0..0 Why immunization occurred
Immunization.isSubpotent 0..0 Dose potency
Immunization.subpotentReason 0..0 Reason for being subpotent
Immunization.education 0..0 Educational material presented to patient
Immunization.programEligibility 0..0 Patient eligibility for a vaccination program
Immunization.fundingSource 0..0 Funding source for the vaccine
Immunization.reaction
Immunization.reaction.id 0..0 Unique id for inter-element referencing
Immunization.reaction.extension 0..0 Extension
Immunization.reaction.modifierExtension 0..0 Extension
Immunization.reaction.detail 0..1 Reference(PH Observation) Additional information on reaction
Immunization.protocolApplied 0..0 Protocol followed by the provider

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 v7.4
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 v7.4
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.meta.id 0..1 string Unique id for inter-element referencing
Immunization.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.meta.Slices for extension.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
Immunization.meta.Slices for extension.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
Immunization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Immunization.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Immunization.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Immunization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Immunization.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.meta.tag This element is included in summaries. 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".
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient This element is included in summaries. 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.actor This element is included in summaries. 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(PH Observation) Additional information on reaction
Immunization.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 v7.4
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 v7.4
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()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient This element is included in summaries. 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.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 v7.4
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 v7.4

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: doco
Immunization 0..* Immunization Immunization event information
Immunization.meta
Immunization.meta.Slices for extension Content/Rules for all slices
Immunization.meta.Slices for extension.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
Immunization.meta.Slices for extension.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
Immunization.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Immunization.implicitRules 0..0 A set of rules under which this content was created
Immunization.language 0..0 Language of the resource content
Immunization.text 0..0 Text summary of the resource, for human interpretation
Immunization.contained 0..0 Contained, inline Resources
Immunization.extension 0..0 Extension
Immunization.modifierExtension 0..0 Extension
Immunization.status 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.primarySource 0..0 Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.location 0..0 Where immunization occurred
Immunization.manufacturer 0..0 Vaccine manufacturer
Immunization.lotNumber 0..0 Vaccine lot number
Immunization.expirationDate 0..0 Vaccine expiration date
Immunization.site 0..0 Body site vaccine was administered
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.performer
Immunization.performer.extension 0..0 Extension
Immunization.performer.modifierExtension 0..0 Extension
Immunization.performer.function 0..0 What type of performance was done
Immunization.performer.actor 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
Immunization.reasonReference 0..0 Why immunization occurred
Immunization.isSubpotent 0..0 Dose potency
Immunization.subpotentReason 0..0 Reason for being subpotent
Immunization.education 0..0 Educational material presented to patient
Immunization.programEligibility 0..0 Patient eligibility for a vaccination program
Immunization.fundingSource 0..0 Funding source for the vaccine
Immunization.reaction
Immunization.reaction.id 0..0 Unique id for inter-element referencing
Immunization.reaction.extension 0..0 Extension
Immunization.reaction.modifierExtension 0..0 Extension
Immunization.reaction.detail 0..1 Reference(PH Observation) Additional information on reaction
Immunization.protocolApplied 0..0 Protocol followed by the provider

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 v7.4
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 v7.4

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.meta.id 0..1 string Unique id for inter-element referencing
Immunization.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.meta.Slices for extension.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
Immunization.meta.Slices for extension.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
Immunization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Immunization.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Immunization.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Immunization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Immunization.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.meta.tag This element is included in summaries. 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".
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: ActNoImmunizationReason (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Drug Codes (required)
Immunization.patient This element is included in summaries. 1..1 Reference(PH Patient) Who was immunized
Immunization.encounter 0..1 Reference(PH Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (required)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (required)
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.actor This element is included in summaries. 1..1 Reference(PH Practitioner | PH PractitionerRole | PH Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ActNoImmunizationReason (required)
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(PH Observation) Additional information on reaction
Immunization.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 v7.4
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 v7.4
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()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron