Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. 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/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: ManageAEFI - Detailed Descriptions

Draft as of 2025-08-11

Definitions for the ManageAEFI logical model.

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

0. ManageAEFI
Definition

A logical model for recording and managing AEFI treatment.

ShortIMMZ.E Manage AEFI
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ManageAEFI.reactionDate
Definition

The date when the adverse event or reaction started.

ShortReaction Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. ManageAEFI.observationId
Definition

A reference to the observation that recorded the reaction.

ShortReaction Observation ID
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ManageAEFI.complaint
Definition

The symptom or concern reported by the patient.

ShortComplaint
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ManageAEFI.manifestation
Definition

The observed clinical manifestations of the reaction.

ShortReaction Manifestation
Control0..*
TypeCodeableConcept
10. ManageAEFI.severity
Definition

The severity classification of the adverse event.

ShortReaction Severity
Control1..1
TypeCodeableConcept
12. ManageAEFI.outcome
Definition

The outcome of the reaction such as death, hospitalization, or recovery.

ShortReaction Outcome
Control1..1
TypeCodeableConcept
14. ManageAEFI.treatmentGiven
Definition

Description of treatments or interventions administered.

ShortTreatment Given
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. ManageAEFI.doseNumber
Definition

The vaccine dose number within the series.

ShortDose Number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. ManageAEFI.totalDoses
Definition

The recommended number of doses for immunity according to national protocol.

ShortTotal Doses in Series
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ManageAEFI.diseaseTargeted
Definition

The vaccine-preventable disease being targeted.

ShortDisease Targeted
Control1..1
TypeCodeableConcept
22. ManageAEFI.nextDoseDueDate
Definition

The date on which the next vaccination should be administered, if applicable.

ShortDue Date of Next Dose
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. ManageAEFI.digitalCertificateNeeded
Definition

Indicates if a digital certificate is required.

ShortDigital Certificate Needed
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. ManageAEFI.certificateIssuer
Definition

The authority or organization that issued the vaccination certificate.

ShortCertificate Issuer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. ManageAEFI.healthCertificateId
Definition

Unique identifier used to associate the immunization event with its digital representation(s).

ShortHealth Certificate Identifier (HCID)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. ManageAEFI.certificateValidFrom
Definition

The date the immunization certificate became valid.

ShortCertificate Valid From
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. ManageAEFI.certificateValidUntil
Definition

The last date the immunization certificate remains valid.

ShortCertificate Valid Until
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. ManageAEFI.certificateSchemeVersion
Definition

Version of the core data set and HL7 FHIR Implementation Guide used.

ShortCertificate Scheme Version
Control0..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. ManageAEFI
Definition

A logical model for recording and managing AEFI treatment.

ShortIMMZ.E Manage AEFI
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ManageAEFI.reactionDate
Definition

The date when the adverse event or reaction started.

ShortReaction Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. ManageAEFI.observationId
Definition

A reference to the observation that recorded the reaction.

ShortReaction Observation ID
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ManageAEFI.complaint
Definition

The symptom or concern reported by the patient.

ShortComplaint
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ManageAEFI.manifestation
Definition

The observed clinical manifestations of the reaction.

ShortReaction Manifestation
Control0..*
TypeCodeableConcept
10. ManageAEFI.severity
Definition

The severity classification of the adverse event.

ShortReaction Severity
Control1..1
TypeCodeableConcept
12. ManageAEFI.outcome
Definition

The outcome of the reaction such as death, hospitalization, or recovery.

ShortReaction Outcome
Control1..1
TypeCodeableConcept
14. ManageAEFI.treatmentGiven
Definition

Description of treatments or interventions administered.

ShortTreatment Given
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. ManageAEFI.doseNumber
Definition

The vaccine dose number within the series.

ShortDose Number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. ManageAEFI.totalDoses
Definition

The recommended number of doses for immunity according to national protocol.

ShortTotal Doses in Series
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ManageAEFI.diseaseTargeted
Definition

The vaccine-preventable disease being targeted.

ShortDisease Targeted
Control1..1
TypeCodeableConcept
22. ManageAEFI.nextDoseDueDate
Definition

The date on which the next vaccination should be administered, if applicable.

ShortDue Date of Next Dose
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. ManageAEFI.digitalCertificateNeeded
Definition

Indicates if a digital certificate is required.

ShortDigital Certificate Needed
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. ManageAEFI.certificateIssuer
Definition

The authority or organization that issued the vaccination certificate.

ShortCertificate Issuer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. ManageAEFI.healthCertificateId
Definition

Unique identifier used to associate the immunization event with its digital representation(s).

ShortHealth Certificate Identifier (HCID)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. ManageAEFI.certificateValidFrom
Definition

The date the immunization certificate became valid.

ShortCertificate Valid From
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. ManageAEFI.certificateValidUntil
Definition

The last date the immunization certificate remains valid.

ShortCertificate Valid Until
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. ManageAEFI.certificateSchemeVersion
Definition

Version of the core data set and HL7 FHIR Implementation Guide used.

ShortCertificate Scheme Version
Control0..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. ManageAEFI
Definition

A logical model for recording and managing AEFI treatment.

ShortIMMZ.E Manage AEFI
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ManageAEFI.reactionDate
Definition

The date when the adverse event or reaction started.

ShortReaction Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. ManageAEFI.observationId
Definition

A reference to the observation that recorded the reaction.

ShortReaction Observation ID
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ManageAEFI.complaint
Definition

The symptom or concern reported by the patient.

ShortComplaint
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ManageAEFI.manifestation
Definition

The observed clinical manifestations of the reaction.

ShortReaction Manifestation
Control0..*
TypeCodeableConcept
10. ManageAEFI.severity
Definition

The severity classification of the adverse event.

ShortReaction Severity
Control1..1
TypeCodeableConcept
12. ManageAEFI.outcome
Definition

The outcome of the reaction such as death, hospitalization, or recovery.

ShortReaction Outcome
Control1..1
TypeCodeableConcept
14. ManageAEFI.treatmentGiven
Definition

Description of treatments or interventions administered.

ShortTreatment Given
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. ManageAEFI.doseNumber
Definition

The vaccine dose number within the series.

ShortDose Number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. ManageAEFI.totalDoses
Definition

The recommended number of doses for immunity according to national protocol.

ShortTotal Doses in Series
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ManageAEFI.diseaseTargeted
Definition

The vaccine-preventable disease being targeted.

ShortDisease Targeted
Control1..1
TypeCodeableConcept
22. ManageAEFI.nextDoseDueDate
Definition

The date on which the next vaccination should be administered, if applicable.

ShortDue Date of Next Dose
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. ManageAEFI.digitalCertificateNeeded
Definition

Indicates if a digital certificate is required.

ShortDigital Certificate Needed
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. ManageAEFI.certificateIssuer
Definition

The authority or organization that issued the vaccination certificate.

ShortCertificate Issuer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. ManageAEFI.healthCertificateId
Definition

Unique identifier used to associate the immunization event with its digital representation(s).

ShortHealth Certificate Identifier (HCID)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. ManageAEFI.certificateValidFrom
Definition

The date the immunization certificate became valid.

ShortCertificate Valid From
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. ManageAEFI.certificateValidUntil
Definition

The last date the immunization certificate remains valid.

ShortCertificate Valid Until
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. ManageAEFI.certificateSchemeVersion
Definition

Version of the core data set and HL7 FHIR Implementation Guide used.

ShortCertificate Scheme Version
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension