NPHCDA Immunization FHIR IG
1.0.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/ImmunizationIG/ and changes regularly. See the Directory of published versions

Logical Model: AdministerVaccine - Detailed Descriptions

Draft as of 2025-08-04

Definitions for the AdministerVaccine logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. AdministerVaccine
Definition

IMMZ.D - A logical model for capturing vaccine administration details

ShortNG-Imm-D AdministerVaccine
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AdministerVaccine.nameOfHealthFacility
Definition

Name of the facility where the vaccination is taking place.

ShortName of health facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. AdministerVaccine.facilityType
Definition

The type of health facility. Uses the IMMZ.D CodeSystem.

ShortFacility type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGFacilityTypeVS
6. AdministerVaccine.sessionType
Definition

Type of immunization session. Uses the IMMZ.D CodeSystem.

ShortSession type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGSessionTypeVS
8. AdministerVaccine.vaccineType
Definition

Type of vaccine administered. Uses IMMZ.F Vaccine Library codes.

ShortVaccine type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGVaccineLibraryVS
10. AdministerVaccine.contraindicated
Definition

Immunization not recommended due to contraindications.

ShortContraindicated
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. AdministerVaccine.contraindications
Definition

Specific situations where certain vaccines should not be administered. Uses the IMMZ.D CodeSystem.

ShortContraindications to immunization
Control0..*
TypeCodeableConcept
Definitional Codes[not stated] NGContraindicationVS
14. AdministerVaccine.vaccinationDateTime
Definition

The date and time the vaccine was administered.

ShortDate and time of vaccination
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. AdministerVaccine.vaccineAdministeringCenter
Definition

Facility where vaccine was administered.

ShortVaccine Administering Center
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. AdministerVaccine.vaccineBatchNumber
Definition

Batch or lot number of vaccine.

ShortVaccine batch number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. AdministerVaccine.expirationDate
Definition

Expiration date of the vaccine. Use last day of the month if only month is given.

ShortExpiration date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. AdministerVaccine.siteAdministered
Definition

Body site where vaccine was administered. Uses the IMMZ.D CodeSystem.

ShortSite administered
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationSiteVS
24. AdministerVaccine.routeOfAdministration
Definition

Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem.

ShortRoute of administration
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationRouteVS
26. AdministerVaccine.doseQuantity
Definition

Quantity of vaccine product administered.

ShortDose quantity
Control1..1
TypeQuantity
28. AdministerVaccine.healthWorkerIdentifier
Definition

Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry.

ShortHealth worker identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. AdministerVaccine
Definition

IMMZ.D - A logical model for capturing vaccine administration details

ShortNG-Imm-D AdministerVaccine
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AdministerVaccine.nameOfHealthFacility
Definition

Name of the facility where the vaccination is taking place.

ShortName of health facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. AdministerVaccine.facilityType
Definition

The type of health facility. Uses the IMMZ.D CodeSystem.

ShortFacility type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGFacilityTypeVS
6. AdministerVaccine.sessionType
Definition

Type of immunization session. Uses the IMMZ.D CodeSystem.

ShortSession type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGSessionTypeVS
8. AdministerVaccine.vaccineType
Definition

Type of vaccine administered. Uses IMMZ.F Vaccine Library codes.

ShortVaccine type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGVaccineLibraryVS
10. AdministerVaccine.contraindicated
Definition

Immunization not recommended due to contraindications.

ShortContraindicated
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. AdministerVaccine.contraindications
Definition

Specific situations where certain vaccines should not be administered. Uses the IMMZ.D CodeSystem.

ShortContraindications to immunization
Control0..*
TypeCodeableConcept
Definitional Codes[not stated] NGContraindicationVS
14. AdministerVaccine.vaccinationDateTime
Definition

The date and time the vaccine was administered.

ShortDate and time of vaccination
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. AdministerVaccine.vaccineAdministeringCenter
Definition

Facility where vaccine was administered.

ShortVaccine Administering Center
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. AdministerVaccine.vaccineBatchNumber
Definition

Batch or lot number of vaccine.

ShortVaccine batch number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. AdministerVaccine.expirationDate
Definition

Expiration date of the vaccine. Use last day of the month if only month is given.

ShortExpiration date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. AdministerVaccine.siteAdministered
Definition

Body site where vaccine was administered. Uses the IMMZ.D CodeSystem.

ShortSite administered
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationSiteVS
24. AdministerVaccine.routeOfAdministration
Definition

Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem.

ShortRoute of administration
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationRouteVS
26. AdministerVaccine.doseQuantity
Definition

Quantity of vaccine product administered.

ShortDose quantity
Control1..1
TypeQuantity
28. AdministerVaccine.healthWorkerIdentifier
Definition

Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry.

ShortHealth worker identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. AdministerVaccine
Definition

IMMZ.D - A logical model for capturing vaccine administration details

ShortNG-Imm-D AdministerVaccine
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AdministerVaccine.nameOfHealthFacility
Definition

Name of the facility where the vaccination is taking place.

ShortName of health facility
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. AdministerVaccine.facilityType
Definition

The type of health facility. Uses the IMMZ.D CodeSystem.

ShortFacility type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGFacilityTypeVS
6. AdministerVaccine.sessionType
Definition

Type of immunization session. Uses the IMMZ.D CodeSystem.

ShortSession type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGSessionTypeVS
8. AdministerVaccine.vaccineType
Definition

Type of vaccine administered. Uses IMMZ.F Vaccine Library codes.

ShortVaccine type
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGVaccineLibraryVS
10. AdministerVaccine.contraindicated
Definition

Immunization not recommended due to contraindications.

ShortContraindicated
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. AdministerVaccine.contraindications
Definition

Specific situations where certain vaccines should not be administered. Uses the IMMZ.D CodeSystem.

ShortContraindications to immunization
Control0..*
TypeCodeableConcept
Definitional Codes[not stated] NGContraindicationVS
14. AdministerVaccine.vaccinationDateTime
Definition

The date and time the vaccine was administered.

ShortDate and time of vaccination
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. AdministerVaccine.vaccineAdministeringCenter
Definition

Facility where vaccine was administered.

ShortVaccine Administering Center
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. AdministerVaccine.vaccineBatchNumber
Definition

Batch or lot number of vaccine.

ShortVaccine batch number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. AdministerVaccine.expirationDate
Definition

Expiration date of the vaccine. Use last day of the month if only month is given.

ShortExpiration date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. AdministerVaccine.siteAdministered
Definition

Body site where vaccine was administered. Uses the IMMZ.D CodeSystem.

ShortSite administered
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationSiteVS
24. AdministerVaccine.routeOfAdministration
Definition

Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem.

ShortRoute of administration
Control1..1
TypeCodeableConcept
Definitional Codes[not stated] NGImmunizationRouteVS
26. AdministerVaccine.doseQuantity
Definition

Quantity of vaccine product administered.

ShortDose quantity
Control1..1
TypeQuantity
28. AdministerVaccine.healthWorkerIdentifier
Definition

Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry.

ShortHealth worker identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension