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
The decision-support logic component of the adaptation kit provides the decision-support logic and algorithms, as well as the scheduling of services, in accordance with WHO guidelines. In this DAK, the decision logic and algorithms deconstruct the recommendations within the immunization guidelines and guidance into a format that clearly labels the inputs and outputs that would be operationalized in a digital decision-support system.
The table below provides an overview of the decision-support tables and algorithms for the different business processes in an Immunization system. The structure of the decision-support tables is based on an adaptation of the Decision Model and Notation (DMN), an industry standard for modeling and executing decision logic. These decision-support tables detail the business rules, data inputs, and outputs to support IIS business processes.
Table 7: Decision Support Logic Overview
Activity ID & Activity Name | Tab | Decision Table ID | Decision Table Description | Reference/Source |
---|---|---|---|---|
IMMZ.D2 Determine required vaccinations | BCG Vaccine | IMMZ.DT.01 | Recommended vaccinations for Bacille Calmette-Guerin (BCG) as per recommendations by WHO and Nigeria | Nigeria National Immunization policy draft WHO Recommendations on Routine Immunization |
Hepatitis B Vaccine | IMMZ.DT.02 | Recommended vaccinations for Hepatitis B as per Nigeria recommendations | ||
Polio Vaccine | IMMZ.DT.03 | Recommended vaccinations for Polio as per Nigeria recommendations | ||
DTP+HepB+Hib (Pentavalent) Vaccine | IMMZ.DT.04 | Recommended vaccinations for Diphtheria, Pertussis, and Tetanus (DPT)-containing vaccines + HepB + Hib (Penta) as per Nigeria recommendations | ||
Pneumococcal Vaccine | IMMZ.DT.06 | Recommended vaccinations for pneumococcal as per Nigeria recommendations | ||
Rota virus Vaccine | IMMZ.DT.07 | Recommended vaccinations for Rota virus as per Nigeria recommendations | ||
Measles Vaccine | IMMZ.DT.08 | Recommended vaccinations for measles as per Nigeria recommendations | ||
Malaria Vaccine | IMMZ.DT.09 | Recommended vaccinations for Malaria as per Nigeria recommendations | ||
Human Papilloma Vaccine | IMMZ.DT.10 | Recommended vaccinations for HPV as per Nigeria recommendations | ||
Yellow fever Vaccine | IMMZ.DT.11 | Recommended vaccinations for Yellow fever as per Nigeria recommendations | ||
Meningococcal Vaccine | IMMZ.DT.13 | Recommended vaccinations for Meningococcal as per Nigeria recommendations | ||
Vitamin A supplementation | IMMZ.DT.14 | Recommended Vitamin A supplementation as per Nigeria recommendations |
Each of the decision logic above have been elaborated on in decision support tables. Below we have highlighted an example of what each component of the decision support table means and highlighted an example of the Yellow fever vaccine decision support table.
Decision ID | The name of the “decision” describing what algorithm or logic is represented (e.g. pre-eclampsia risk counselling). The Decision ID should correspond to the number in the overview table on "overview" tab | |||
---|---|---|---|---|
Business Rule | The description of the decision that needs to be made based on IF/THEN statements with the appropriate data element name for the variables. The rule should demonstrate the relationship between the input variables and the expected outputs and actions within the decision-support logic – e.g. if blood pressure is higher than 140 SBP/90 DBP, then the client should be flagged as a high-risk pregnancy. | |||
Trigger | The event that would indicate when this decision-support logic should appear within the workflow, such as the activity that would trigger this decision to be made. | |||
Inputs | Output | Action | Annotations | |
These are the variables or conditions that need to be considered to determine the consequent actions or outputs. | If there are multiple input entries on the same row (such as here), these different inputs are considered as “AND” – conditions that need to be in place at the same time. | The resulting action or decision based on the combination of input entries. This is the statement that immediately follows the “THEN”. Examples of outputs may include a diagnosis, alerts/prompts for referral, or a recommendation to vaccinate. | Concrete measures to be taken based on the output (refer, provide treatment and/or counselling, conduct test, etc.). In some cases, output and action may be the same. | Additional explanations or descriptions, including possible pop-up alert messages and relevant background information. This section can also include the written content which would appear in the pop-up messages notifying the health worker on the appropriate next steps, which can include counselling, case management approach, or referral. |
Inputs placed on different rows are considered as “OR” conditions that can be considered independently of the inputs on other rows. |
Table 9 . Example decision logic table for Yellow Fever vaccination
Decision ID | IMMZ.DT.06.Yellow Fever | ||||
---|---|---|---|---|---|
Business Rule | If child or person has not been vaccinated, give Yellow Fever vaccine between age 9-12 months | ||||
Trigger | IMMZ.D2 Determine Required Vaccinations if any | ||||
Inputs | Output | Action | Annotations | Reference(s) | |
"Number of doses administered" = 0 | "Age in Months" >= 9 | Client vaccinated for Yellow Fever - No Doses | Should vaccinate Client for Yellow Fever because Client received no doses on a 1 dose scheme | Provide Yellow Fever immunizations – using the "Yellow Fever vaccine immunization – NO PREVIOUS" schedule (1 dose scheme)
Note: This dose is applicable if the following scenarios are met: - The country has a Yellow Fever endemic - The individual is travelling to a Yellow Fever endemic area - The child is 9 months old. |
WHO Recommendations for Routine Immunization Nigeria National Immunization Policy Draft |
Decision ID | IMMZ.DT.01.BCG | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Business Rule | If child or person has not been vaccinated, give BCG vaccine as soon as possible after birth | |||||||||
Trigger | IMMZ.D2 Determine Required Vaccinations if any | |||||||||
Inputs | Output | Action | Annotations and Reference(s) | |||||||
Number of BCG primary series doses administered Count of vaccines administered (where "Vaccine type" = "BCG vaccines" and "Type of dose" = "Primary series") | Client's age Today's date − "Date of birth" | Client's HIV status | Client's antiretroviral therapy (ART) status | Is client immunologically stable | Client's tuberculosis (TB) infection test result | Is client clinically well | ||||
No BCG primary series dose was administered Count of vaccines administered (where "Vaccine type" = "BCG vaccines" and "Type of dose" = "Primary series") = 0 | Client's age is less than or equal to 28 days Today's date − "Date of birth" ≤ 28 days (Neonate) | Client's HIV status is negative or unknown "HIV status" ≠ "HIV-positive" | - | - | - | - | Client is due for BCG vaccination "Immunization recommendation status" = "Due" | Vaccinate client with first BCG dose as no BCG dose was administered, client is within age range, and HIV status is not positive Check for contraindications. | WHO Recommendation: Neonates born to women of unknown HIV status should be vaccinated as the benefits of BCG vaccination outweigh the risks. Neonates of unknown HIV status born to HIV-infected women should be vaccinated if they have no clinical evidence suggestive of HIV infection. WHO recommendations for routine immunization - summary tables: https://www.who.int/teams/immunization-vaccines-and-biologicals/policies/who-recommendations-for-routine-immunization---summary-tables |
|
Client's HIV status is positive "HIV status" = "HIV-positive" | Client is currently receiving antiretroviral therapy "Currently on ART" = TRUE | Client is immunologically stable "Immunologically stable" = TRUE | - | - | Client is due for BCG vaccination "Immunization recommendation status" = "Due" | Vaccinate client with first BCG dose as no BCG dose was administered, and client is immunologically stable. Check for contraindications. | WHO Recommendation: For neonates with HIV infection confirmed by early virological testing, BCG vaccination should be delayed until ART has been started and the infant confirmed to be immunologically stable (CD4 > 25%). Moderate-to-late preterm infants (gestational age > 31 weeks) and low-birth-weight infants (< 2500 g) who are healthy and clinically stable can receive BCG vaccination at birth, or at the latest, upon discharge. | |||
Client is not immunologically stable "Immunologically stable"= FALSE | - | - | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Do not vaccinate client with first BCG dose as client is not immunologically stable. Check for any vaccines due and inform the caregiver of when to come back for the first BCG dose. | WHO Recommendation: For neonates with HIV infection confirmed by early virological testing, BCG vaccination should be delayed until ART has been started and the infant confirmed to be immunologically stable (CD4 > 25%). | |||||
Client is currently not receiving antiretroviral therapy "Currently on ART" = FALSE | - | - | - | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Should not vaccinate client with first BCG dose as client is not currently receiving ART. Check for any vaccines due and inform the caregiver of when to come back for the first BCG dose. | |||||
Client's age is between 28 days and 11 months | Client's HIV status is negative or unknown "HIV status" ≠ "HIV-positive" | - | - | Client's TB infection test result is negative "TB infection test result" = "Negative" | - | Client is due for BCG vaccination "Immunization recommendation status" = "Due" | Should vaccinate client with first BCG dose as no BCG dose was administered, and client's TB test result is negative. Check for contraindications. | |||
- | - | Client's TB infection test result is unknown (test not done or no result yet) "TB infection test result" IS NULL | - | Clinical judgement is required. Create clinical note."Immunization recommendation status" = "Further evaluation needed" | Recommend the client to perform TB infection testing. Re-evaluate client once the test result is available. | |||||
- | - | Client's TB infection test result is positive "TB infection test result" = "Positive" | - | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Should not vaccinate client with first BCG dose as client's TB infection test result is positive. Consider evaluating for TB disease or for TB preventive treatment (TPT) eligibility (once TB disease is ruled out). | |||||
"Client's HIV status is positive ""HIV status"" = ""HIV-positive""" | Client is currently receiving antiretroviral therapy "Currently on ART" = TRUE | Client is immunologically stable "Immunologically stable" = TRUE | * | Client is clinically well "Clinically well" = TRUE | Client is due for BCG vaccination "Immunization recommendation status" = "Due" | Vaccinate client with first BCG dose as no BCG dose was administered, client is receiving ART, clinically well and immunologically stable. Check for contraindications. | WHO Recommendation: If children infected with HIV are receiving ART and are clinically well and immunologically stable (CD4% > 25% for children aged under 5 years), they should be vaccinated with BCG. | |||
Client is not immunologically stable "Immunologically stable" = FALSE | * | Client is not clinically well "Clinically well" = FALSE | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Should not vaccinate client with first BCG dose as client is not clinically well and/or immunologically stable. Check for any vaccines due, and inform the caregiver of when to come back for the first BCG dose. | ||||||
Client is currently not receiving antiretroviral therapy "Currently on ART" = FALSE |
- | - | * | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" |
Should not vaccinate client with first BCG dose as client is not currently receiving ART. Check for any vaccines due and inform the caregiver of when to come back for the first BCG dose. |
|||||
Client's age is more than 11months Today's date − ""Date of birth"" ≥ 11months | Client's HIV status is negative or unknown "HIV status" ≠ "HIV-positive" | - | - | Client's TB infection test result is negative "TB infection test result" = "Negative" | Client is overdue for BCG vaccination | Should not vaccinate client with BCG dose as the Nigeria Immunization schedule has a limit of 11 months for BCG | WHO Recommendation: BCG vaccination is also recommended for unvaccinated older children, adolescents and adults negative for TST or IGRA who are in settings with high incidence of TB and/or high leprosy burden, those moving from low-to-high TB incidence/leprosy burden settings and persons at risk of occupational exposure in low and high TB incidence areas (e.g. health workers, laboratory workers, medical students, prison workers, other individuals with occupational exposure) | |||
- | - | Client's TB infection test result is unknown (test not done or no result yet) "TB infection test result"" IS NULL | - | Clinical judgement is required. Create clinical note. "Immunization recommendation status" = "Further evaluation needed" | Should not vaccinate client with first BCG dose as client's TB infection test result is positive. Consider evaluating for TB disease or for TB preventive treatment (TPT) eligibility (once TB disease is ruled out). | |||||
- | - | Client's TB infection test result is positive "TB infection test result" = "Positive" | - | Client is overdue for BCG vaccination "Immunization recommendation status" = "Not Administered" | ||||||
Client's HIV status is positive "HIV status" = "HIV-positive" | Client is currently receiving antiretroviral therapy "Currently on ART" = TRUE | Client is immunologically stable "Immunologically stable" = TRUE | * | Client is clinically well "Clinically well" = TRUE | Client is overdue for BCG vaccination "Immunization recommendation status" = "Overdue" | No BCG dose is administered, client is receiving ART, clinically well and immunologically stable. | ||||
Client is not immunologically stable "Immunologically stable" = FALSE | * | Client is not clinically well "Clinically well" = FALSE | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Should not vaccinate client with first BCG dose as client is not clinically well and/or immunologically stable and is overdue for first BCG dose | ||||||
Client is currently not receiving antiretroviral therapy "Currently on ART" = FALSE | - | * | - | Client is not due for BCG vaccination "Immunization recommendation status" = "Not Administered" | Should not vaccinate client with first BCG dose as client is not currently receiving ART and is overdue for first BCG dose |
Decision ID | IMMZ.D5.DT.BCG contraindications | ||||
---|---|---|---|---|---|
Business Rule | Check for contraindications before administering the vaccine(s) due | ||||
Trigger | IMMZ.D5 Determine vaccine(s) to be administered based on contraindications | ||||
Potential contraindications | Output | Action | Annotations | Reference(s) | |
The client is pregnant "Potential contraindications" = "Currently pregnant" |
– | BCG vaccination is contraindicated "Immunization recommendation status" = "Contraindicated" |
Do not vaccinate client with BCG as BCG vaccination is not recommended during pregnancy | – | WHO recommendations for routine immunization – summary tables (January 2025) (1) |
The client has history of severe allergic reactions "Potential contraindications" = "Severe allergic reactions" |
– | BCG vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. "Immunization recommendation status" = "Further evaluation needed" |
Do not vaccinate client with BCG if the client had previous allergic reaction to any component of the vaccine | – | BCG vaccines: WHO position paper (February 2018) (2) |
The client has immunodeficiency syndromes "Potential contraindications" = "Immunodeficiency syndromes" |
– | BCG vaccination is contraindicated "Immunization recommendation status" = "Contraindicated" |
Do not vaccinate client with BCG as BCG vaccination is contraindicated for clients with immunodeficiency syndromes | WHO Recommendation: BCG vaccination is contraindicated for persons with congenital cell-mediated or severe combined immunodeficiency, immunodeficiency syndromes (e.g. HIV/AIDS, known or suspected congenital immunodeficiency, leukaemia, lymphoma or other malignant disease) | |
The client is exposed to immunosuppressive treatment "Potential contraindications" = "Exposed to immunosuppressive treatment" |
Client's age is less than 1 year "Age" < 1 year |
BCG vaccination is contraindicated "Immunization recommendation status" = "Contraindicated" |
Do not vaccinate client with BCG as BCG vaccination is contraindicated for clients undergoing immunosuppressive treatment | WHO Recommendation: BCG vaccination is contraindicated for patients undergoing immunosuppressive treatment (e.g. corticosteroids, alkylating agents, biological response modifiers, antimetabolites, radiation). Infants exposed to immunosuppressive treatment in utero or via breastfeeding should not receive BCG vaccination | |
BCG vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. "Immunization recommendation status" = "Further evaluation needed" |
Do not vaccinate client with BCG if client is exposed to or receives immunosuppressive treatment | ||||
Note: While vaccines are universally recommended, some clients may have contraindications to particular vaccines. Additional contraindications may be included in WHO position paper for the vaccine – BCG vaccines: WHO position paper (February 2018) (2). |
Schedule ID | IMMZ.D18.S.BCG schedule | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Business Rule | |||||||||||
Service name | Service description | Trigger event | Trigger date | Create condition | Due date | Overdue | Expiration | Completion | Comments | Reference(s) | |
The name of the service for which the schedule is relevant | Description of the service (to provide clarity) | What event signals the start of the service schedule? | What is the date of the signalling event that will be used to determine a service’s due date? | Are there any conditions that specify when a service should be given? | How is the due date of the service calculated? | When does the service become overdue? | When does the service expire? | How does the health worker complete the service? | Any additional comments | Source of recommendation (eg.Nigeria draft National Immunisation Policy 2024)? |
Polio, Yellow Fever, Measles, Pneumococcal, DPT Hep B-Hib, Rotavirus, HPV, Vitamin A, Malaria, Covid 19, Meningococcal, Td for pregnant women.