NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
| Draft as of 2025-10-27 |
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 |
| Short | NG-Imm-D AdministerVaccine |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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. |
| Short | Name of health facility |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Facility type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGFacilityTypeVS |
| 6. AdministerVaccine.sessionType | |
| Definition | Type of immunization session. Uses the IMMZ.D CodeSystem. |
| Short | Session type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGSessionTypeVS |
| 8. AdministerVaccine.vaccineType | |
| Definition | Type of vaccine administered. Uses IMMZ.F Vaccine Library codes. |
| Short | Vaccine type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGVaccineLibraryVS |
| 10. AdministerVaccine.contraindicated | |
| Definition | Immunization not recommended due to contraindications. |
| Short | Contraindicated |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This 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. |
| Short | Contraindications to immunization |
| Control | 0..* |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGContraindicationVS |
| 14. AdministerVaccine.vaccinationDateTime | |
| Definition | The date and time the vaccine was administered. |
| Short | Date and time of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. AdministerVaccine.vaccineAdministeringCenter | |
| Definition | Facility where vaccine was administered. |
| Short | Vaccine Administering Center |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. AdministerVaccine.vaccineBatchNumber | |
| Definition | Batch or lot number of vaccine. |
| Short | Vaccine batch number |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Expiration date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This 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. |
| Short | Site administered |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationSiteVS |
| 24. AdministerVaccine.routeOfAdministration | |
| Definition | Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem. |
| Short | Route of administration |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationRouteVS |
| 26. AdministerVaccine.doseQuantity | |
| Definition | Quantity of vaccine product administered. |
| Short | Dose quantity |
| Control | 1..1 |
| Type | Quantity |
| 28. AdministerVaccine.healthWorkerIdentifier | |
| Definition | Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry. |
| Short | Health worker identifier |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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 |
| Short | NG-Imm-D AdministerVaccine |
| Logical Model | Instances 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. |
| Short | Name of health facility |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Facility type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGFacilityTypeVS |
| 6. AdministerVaccine.sessionType | |
| Definition | Type of immunization session. Uses the IMMZ.D CodeSystem. |
| Short | Session type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGSessionTypeVS |
| 8. AdministerVaccine.vaccineType | |
| Definition | Type of vaccine administered. Uses IMMZ.F Vaccine Library codes. |
| Short | Vaccine type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGVaccineLibraryVS |
| 10. AdministerVaccine.contraindicated | |
| Definition | Immunization not recommended due to contraindications. |
| Short | Contraindicated |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This 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. |
| Short | Contraindications to immunization |
| Control | 0..* |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGContraindicationVS |
| 14. AdministerVaccine.vaccinationDateTime | |
| Definition | The date and time the vaccine was administered. |
| Short | Date and time of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. AdministerVaccine.vaccineAdministeringCenter | |
| Definition | Facility where vaccine was administered. |
| Short | Vaccine Administering Center |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. AdministerVaccine.vaccineBatchNumber | |
| Definition | Batch or lot number of vaccine. |
| Short | Vaccine batch number |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Expiration date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This 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. |
| Short | Site administered |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationSiteVS |
| 24. AdministerVaccine.routeOfAdministration | |
| Definition | Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem. |
| Short | Route of administration |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationRouteVS |
| 26. AdministerVaccine.doseQuantity | |
| Definition | Quantity of vaccine product administered. |
| Short | Dose quantity |
| Control | 1..1 |
| Type | Quantity |
| 28. AdministerVaccine.healthWorkerIdentifier | |
| Definition | Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry. |
| Short | Health worker identifier |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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 |
| Short | NG-Imm-D AdministerVaccine |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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. |
| Short | Name of health facility |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Facility type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGFacilityTypeVS |
| 6. AdministerVaccine.sessionType | |
| Definition | Type of immunization session. Uses the IMMZ.D CodeSystem. |
| Short | Session type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGSessionTypeVS |
| 8. AdministerVaccine.vaccineType | |
| Definition | Type of vaccine administered. Uses IMMZ.F Vaccine Library codes. |
| Short | Vaccine type |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGVaccineLibraryVS |
| 10. AdministerVaccine.contraindicated | |
| Definition | Immunization not recommended due to contraindications. |
| Short | Contraindicated |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This 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. |
| Short | Contraindications to immunization |
| Control | 0..* |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGContraindicationVS |
| 14. AdministerVaccine.vaccinationDateTime | |
| Definition | The date and time the vaccine was administered. |
| Short | Date and time of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. AdministerVaccine.vaccineAdministeringCenter | |
| Definition | Facility where vaccine was administered. |
| Short | Vaccine Administering Center |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. AdministerVaccine.vaccineBatchNumber | |
| Definition | Batch or lot number of vaccine. |
| Short | Vaccine batch number |
| Control | 1..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Expiration date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This 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. |
| Short | Site administered |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationSiteVS |
| 24. AdministerVaccine.routeOfAdministration | |
| Definition | Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem. |
| Short | Route of administration |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGImmunizationRouteVS |
| 26. AdministerVaccine.doseQuantity | |
| Definition | Quantity of vaccine product administered. |
| Short | Dose quantity |
| Control | 1..1 |
| Type | Quantity |
| 28. AdministerVaccine.healthWorkerIdentifier | |
| Definition | Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry. |
| Short | Health worker identifier |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |