NPHCDA Immunization FHIR IG
1.0.0 - ci-build
NPHCDA Immunization FHIR IG
1.0.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 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
| Draft as of 2025-08-04 |
Definitions for the manage-aefi logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. manage-aefi | |
| Definition | IMMZ.E - A logical model for recording and managing AEFI treatment. |
| Short | NG-Imm-E Manage & ReportAEFI |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. manage-aefi.reactionDate | |
| Definition | The date when the adverse event or reaction started. |
| Short | Reaction Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. manage-aefi.observationId | |
| Definition | A reference to the observation that recorded the reaction. |
| Short | Reaction Observation ID |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. manage-aefi.complaint | |
| Definition | The symptom or concern reported by the patient. |
| Short | Complaint |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. manage-aefi.manifestation | |
| Definition | The observed clinical manifestations of the reaction. |
| Short | Reaction Manifestation |
| Control | 0..* |
| Type | CodeableConcept |
| 10. manage-aefi.severity | |
| Definition | The severity classification of the adverse event. |
| Short | Reaction Severity |
| Control | 1..1 |
| Type | CodeableConcept |
| 12. manage-aefi.outcome | |
| Definition | The outcome of the reaction such as death, hospitalization, or recovery. |
| Short | Reaction Outcome |
| Control | 1..1 |
| Type | CodeableConcept |
| 14. manage-aefi.treatmentGiven | |
| Definition | Description of treatments or interventions administered. |
| Short | Treatment Given |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. manage-aefi.doseNumber | |
| Definition | The vaccine dose number within the series. |
| Short | Dose Number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. manage-aefi.totalDoses | |
| Definition | The recommended number of doses for immunity according to national protocol. |
| Short | Total Doses in Series |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. manage-aefi.diseaseTargeted | |
| Definition | The vaccine-preventable disease being targeted. |
| Short | Disease Targeted |
| Control | 1..1 |
| Type | CodeableConcept |
| 22. manage-aefi.nextDoseDueDate | |
| Definition | The date on which the next vaccination should be administered, if applicable. |
| Short | Due Date of Next Dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. manage-aefi.digitalCertificateNeeded | |
| Definition | Indicates if a digital certificate is required. |
| Short | Digital Certificate Needed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. manage-aefi.certificateIssuer | |
| Definition | The authority or organization that issued the vaccination certificate. |
| Short | Certificate Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. manage-aefi.healthCertificateId | |
| Definition | Unique identifier used to associate the immunization event with its digital representation(s). |
| Short | Health Certificate Identifier (HCID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. manage-aefi.certificateValidFrom | |
| Definition | The date the immunization certificate became valid. |
| Short | Certificate Valid From |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. manage-aefi.certificateValidUntil | |
| Definition | The last date the immunization certificate remains valid. |
| Short | Certificate Valid Until |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. manage-aefi.certificateSchemeVersion | |
| Definition | Version of the core data set and HL7 FHIR Implementation Guide used. |
| Short | Certificate Scheme Version |
| Control | 0..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. manage-aefi | |
| Definition | IMMZ.E - A logical model for recording and managing AEFI treatment. |
| Short | NG-Imm-E Manage & ReportAEFI |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. manage-aefi.reactionDate | |
| Definition | The date when the adverse event or reaction started. |
| Short | Reaction Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. manage-aefi.observationId | |
| Definition | A reference to the observation that recorded the reaction. |
| Short | Reaction Observation ID |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. manage-aefi.complaint | |
| Definition | The symptom or concern reported by the patient. |
| Short | Complaint |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. manage-aefi.manifestation | |
| Definition | The observed clinical manifestations of the reaction. |
| Short | Reaction Manifestation |
| Control | 0..* |
| Type | CodeableConcept |
| 10. manage-aefi.severity | |
| Definition | The severity classification of the adverse event. |
| Short | Reaction Severity |
| Control | 1..1 |
| Type | CodeableConcept |
| 12. manage-aefi.outcome | |
| Definition | The outcome of the reaction such as death, hospitalization, or recovery. |
| Short | Reaction Outcome |
| Control | 1..1 |
| Type | CodeableConcept |
| 14. manage-aefi.treatmentGiven | |
| Definition | Description of treatments or interventions administered. |
| Short | Treatment Given |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. manage-aefi.doseNumber | |
| Definition | The vaccine dose number within the series. |
| Short | Dose Number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. manage-aefi.totalDoses | |
| Definition | The recommended number of doses for immunity according to national protocol. |
| Short | Total Doses in Series |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. manage-aefi.diseaseTargeted | |
| Definition | The vaccine-preventable disease being targeted. |
| Short | Disease Targeted |
| Control | 1..1 |
| Type | CodeableConcept |
| 22. manage-aefi.nextDoseDueDate | |
| Definition | The date on which the next vaccination should be administered, if applicable. |
| Short | Due Date of Next Dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. manage-aefi.digitalCertificateNeeded | |
| Definition | Indicates if a digital certificate is required. |
| Short | Digital Certificate Needed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. manage-aefi.certificateIssuer | |
| Definition | The authority or organization that issued the vaccination certificate. |
| Short | Certificate Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. manage-aefi.healthCertificateId | |
| Definition | Unique identifier used to associate the immunization event with its digital representation(s). |
| Short | Health Certificate Identifier (HCID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. manage-aefi.certificateValidFrom | |
| Definition | The date the immunization certificate became valid. |
| Short | Certificate Valid From |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. manage-aefi.certificateValidUntil | |
| Definition | The last date the immunization certificate remains valid. |
| Short | Certificate Valid Until |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. manage-aefi.certificateSchemeVersion | |
| Definition | Version of the core data set and HL7 FHIR Implementation Guide used. |
| Short | Certificate Scheme Version |
| Control | 0..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. manage-aefi | |
| Definition | IMMZ.E - A logical model for recording and managing AEFI treatment. |
| Short | NG-Imm-E Manage & ReportAEFI |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. manage-aefi.reactionDate | |
| Definition | The date when the adverse event or reaction started. |
| Short | Reaction Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. manage-aefi.observationId | |
| Definition | A reference to the observation that recorded the reaction. |
| Short | Reaction Observation ID |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. manage-aefi.complaint | |
| Definition | The symptom or concern reported by the patient. |
| Short | Complaint |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. manage-aefi.manifestation | |
| Definition | The observed clinical manifestations of the reaction. |
| Short | Reaction Manifestation |
| Control | 0..* |
| Type | CodeableConcept |
| 10. manage-aefi.severity | |
| Definition | The severity classification of the adverse event. |
| Short | Reaction Severity |
| Control | 1..1 |
| Type | CodeableConcept |
| 12. manage-aefi.outcome | |
| Definition | The outcome of the reaction such as death, hospitalization, or recovery. |
| Short | Reaction Outcome |
| Control | 1..1 |
| Type | CodeableConcept |
| 14. manage-aefi.treatmentGiven | |
| Definition | Description of treatments or interventions administered. |
| Short | Treatment Given |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. manage-aefi.doseNumber | |
| Definition | The vaccine dose number within the series. |
| Short | Dose Number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. manage-aefi.totalDoses | |
| Definition | The recommended number of doses for immunity according to national protocol. |
| Short | Total Doses in Series |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. manage-aefi.diseaseTargeted | |
| Definition | The vaccine-preventable disease being targeted. |
| Short | Disease Targeted |
| Control | 1..1 |
| Type | CodeableConcept |
| 22. manage-aefi.nextDoseDueDate | |
| Definition | The date on which the next vaccination should be administered, if applicable. |
| Short | Due Date of Next Dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. manage-aefi.digitalCertificateNeeded | |
| Definition | Indicates if a digital certificate is required. |
| Short | Digital Certificate Needed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. manage-aefi.certificateIssuer | |
| Definition | The authority or organization that issued the vaccination certificate. |
| Short | Certificate Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. manage-aefi.healthCertificateId | |
| Definition | Unique identifier used to associate the immunization event with its digital representation(s). |
| Short | Health Certificate Identifier (HCID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. manage-aefi.certificateValidFrom | |
| Definition | The date the immunization certificate became valid. |
| Short | Certificate Valid From |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. manage-aefi.certificateValidUntil | |
| Definition | The last date the immunization certificate remains valid. |
| Short | Certificate Valid Until |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. manage-aefi.certificateSchemeVersion | |
| Definition | Version of the core data set and HL7 FHIR Implementation Guide used. |
| Short | Certificate Scheme Version |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |