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
Functional requirements describe the capabilities a digital tracking and decision-support system must have to meet end-users’ needs and support tasks within the business process. These requirements define essential system functions such as user management, data collection, patient tracking, decision support, reporting, system integration, and inventory management. They ensure the system facilitates accurate data entry, automates workflows, provides actionable insights, and integrates with relevant healthcare systems for seamless operations.
| Activity ID and name | As a… | I want… | So that… | |
|---|---|---|---|---|
| Business process A: Health Facility Registration | ||||
| IMMZ.FXNREQ.001 | IMMZ.A1.Obtain vaccination location information | State Immunization Officer | The EIR system to be integrated with other existing registries | I will know about new vaccination locations and be informed about any updated information |
| IMMZ.FXNREQ.002 | IMMZ.A2.Update/anew vaccination location | Routine Immunization Service Provider/Medical Records Officer | The system to allow manual insertion of a new vaccination location | I can add and use vaccination locations not in the system |
| IMMZ.FXNREQ.003 | IMMZ.A3.Digitize REW microplans | State Immunization Officer | The system to have digitized REW microplans | Plans can be automatically generated for each outreach session |
| IMMZ.FXNREQ.004 | IMMZ.A4.Verify information for additional data | Routine Immunization Service Provider/Medical Records Officer | The system to verify all required vaccination location information is complete | Any missed fields can be identified |
| IMMZ.FXNREQ.005 | IMMZ.A5.Generate unique location identifier | State Immunization Officer | The system to generate a unique code for each vaccination location | The vaccination location will have a unique identifier in the EIR system |
| IMMZ.FXREQ.006 | IMMZ.A6. Generate Geo coordinates | State Immunization Officer | The system to have geo mapping capabilities | The vaccination locations can be easily identified |
| IMMZ.FXREQ.007 | IMMZ.A7.Obtain Contact information of focal persons | State Immunization Officer | The system to include the phone number and email address of the focal person | I can easily contact the focal person |
| IMMZ.FXREQ.008 | IMMZ.A8.Record vaccination location details | State Immunization Officer | The system to record vaccination dates, type of facility (public, private, secondary, tertiary) and type of site (fixed, outreach) | The exact vaccination location details are captured |
| Business process B: Plan service delivery | ||||
| IMMZ.FXNREQ.009 | IMMZ.B1.Review past vaccination records to estimate vaccines needed | Routine Immunization Service Provider/Medical Records Officer | To identify, by checking the information in the system, all clients that are due (or overdue) for vaccination by the next immunization session date | I can plan my immunization session |
| IMMZ.FXNREQ.010 | IMMZ.B2.Review past vaccination records to estimate vaccines needed | State Immunization Officer | To sort the list of needed vaccines by antigen | I know how much of each vaccine is needed |
| IMMZ.FXNREQ.011 | IMMZ.B3.Record details on planning sheet | State Immunization Officer | To be able to check in the system the available stock at my vaccination location or at the local storage area/warehouse | I can determine the stock available for use |
| Business process C: Client registration | ||||
| IMMZ.FXNREQ.012 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | To search for a client using at least two identifying information | I improve my chances of finding a match and distinguishing between similar records |
| IMMZ.FXNREQ.013 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | To search for the client record given some demographic information | I can find the client record if I do not have the unique ID |
| IMMZ.FXNREQ.014 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | The system to return all potential matches based upon search criteria | I can find the best match |
| IMMZ.FXNREQ.015 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | The ability for searches to include results that look or sound similar to the search term (phonetic search) | I can find something that may be spelt incorrectly |
| IMMZ.FXNREQ.016 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | The system to prompt a search for the client (check if it is already in the system) prior to starting a new record | Duplicates are prevented |
| IMMZ.FXNREQ.017 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | The system to retrieve and display, as a search result, a specific set of data (demographic information/photo/unique ID, etc.) | I can select the correct record |
| IMMZ.FXNREQ.018 | IMMZ.C1.Query client record | Routine Immunization Service Provider/Medical Records Officer | The system to display the most probable matches at the top of the list | I can review them first |
| IMMZ.FXNREQ.019 | IMMZ.C2.Create client record | Routine Immunization Service Provider/Medical Records Officer | The system to enforce a minimal required data set for new registrations | Sufficient data is entered to be able to identify the client |
| IMMZ.FXNREQ.020 | IMMZ.C2.Create client record | Routine Immunization Service Provider/Medical Records Officer | To select the vaccination location of the client from a list of locations | Entry errors are prevented |
| IMMZ.FXNREQ.021 | IMMZ.C2.Create client record | Routine Immunization Service Provider/Medical Records Officer | The system to uniquely identify every client using a system-generated unique identifier or an existing identifier (e.g. national ID, client ID) | The client can be definitively identified using that number |
| IMMZ.FXNREQ.022 | IMMZ.C3.Validate client details | Routine Immunization Service Provider/Medical Records Officer | To be able to modify appropriate client data as needed | The record contains up-to-date information |
| IMMZ.FXNREQ.023 | IMMZ.C3.Validate client details | Routine Immunization Service Provider/Medical Records Officer | The system to track that I have changed an existing record | Accountability for data modification is ensured |
| IMMZ.FXNREQ.024 | IMMZ.C3.Validate client details | Routine Immunization Service Provider/Medical Records Officer | The system to identify changes made to the record for my confirmation before saving | I can have the opportunity to double-check the data to prevent entry errors |
| Business process D: Administer vaccine | ||||
| IMMZ.FXNREQ.025 | IMMZ.D1.Capture or update client history | Routine Immunization Service Provider/Medical Records Officer | The system to provide a history of previous care (including previous vaccination records) | I have access and review client's history |
| IMMZ.FXNREQ.026 | IMMZ.D1.Capture or update client history | Routine Immunization Service Provider/Medical Records Officer | To add client's health history (including previous vaccination records) | I can appropriately determine which vaccinations are required |
| IMMZ.FXNREQ.027 | IMMZ.D2.Determine required vaccination(s) | Routine Immunization Service Provider/Medical Records Officer | The system to display vaccines due according to predefined vaccine protocol | I can assess which vaccines need to be administered |
| IMMZ.FXNREQ.028 | IMMZ.D2.Determine required vaccination(s) | Routine Immunization Service Provider/Medical Records Officer | The system to determine vaccines due for a given client by considering relevant information, such as the age of the client, vaccine products, vaccines already given and predefined vaccine protocol | It helps me with selecting the appropriate vaccines for the client |
| IMMZ.FXNREQ.029 | IMMZ.D3.Determine vaccine(s) to be administered based on contraindications | Routine Immunization Service Provider/Medical Records Officer | To be alerted of any relevant potential contraindications for the vaccine (e.g. based on age, previous allergic reactions, etc.) | I can withhold the vaccine, if contraindicated |
| IMMZ.FXNREQ.030 | IMMZ.D3.Determine vaccine(s) to be administered based on contraindications | Routine Immunization Service Provider/Medical Records Officer | To be able to quickly access information regarding any contraindications by antigen | I can access all information on contraindications in one place |
| IMMZ.FXNREQ.031 | IMMZ.D4.Update client record | Routine Immunization Service Provider/Medical Records Officer | To document why a vaccine was not given | The client has a complete record |
| IMMZ.FXNREQ.032 | IMMZ.D4.Update client record | Routine Immunization Service Provider/Medical Records Officer | To update clients’ vaccination record with all relevant information (i.e. date, dose, batch number, lot number, vaccine type, vaccine vial monitor status) | The client has a complete record, and doses can be traced |
| IMMZ.FXNREQ.033 | IMMZ.D4.Update client record | Routine Immunization Service Provider/Medical Records Officer | The system to associate the context data for each entry (e.g. the vaccination location where the dose was given, the health worker administering it) | The client has a complete record and I can investigate if any issues arise |
| IMMZ.FXNREQ.034 | IMMZ.D4.Update client record | Routine Immunization Service Provider/Medical Records Officer | To record vaccines in the EPI schedule, any vaccines introduced, COVID-19, TD vaccine for pregnant women, campaign vaccines | The client has a complete record |
| IMMZ.FXNREQ.035 | IMMZ.D5.Determine time for next visit (as needed) | Routine Immunization Service Provider/Medical Records Officer | The system to display due date of the next vaccine | I can inform the client when to return for their next vaccination |
| IMMZ.FXREQ.Q036 | IMMZ.D6.Generate digital certificate | Routine Immunization Service Provider/Medical Records Officer | The system to generate a digital certificate with name, age, contact number, QR code and other items as found in the WHO sample certificate | The client can verify they have been vaccinated |
| Business process E; AEFI Monitoring | ||||
| IMMZ.FXNREQ.037 | IMMZ.E1.Monitor adverse reactions in clients | Routine Immunization Service Provider/Medical Records Officer | The AEFI module to be separate | I can record any significant observations that may be specific to the client and treat as appropriate |
| IMMZ.FXREQ.038 | IMMZ.E2.Follow-up clients | Routine Immunization Service Provider/Medical Records Officer | The system to be interoperable with the MedSafety App | I can follow-up vaccine related complications |
| Business process F: Client reminder | ||||
| IMMZ.FXNREQ.039 | IMMZ.F1.Define/evaluate criteria | Routine Immunization Service Provider/Medical Records Officer | To associate a client with a vaccination location to generate a provider-based reminder/recall | Vaccination location specific lists of clients can be generated |
| IMMZ.FXNREQ.040 | IMMZ.F2.Select notification method | Routine Immunization Service Provider/Medical Records Officer | The system to Call/ SMS/WhatsApp a client | Notifications will go through the client’s preferred method |
| IMMZ.FXNREQ.041 | IMMZ.F3.Send notifications | Routine Immunization Service Provider/Medical Records Officer | The system to automatically send reminder notification to caregiver a day before appointment or a day after a missed appointment | They will be alerted of an upcoming or overdue appointment |
| IMMZ.FXNREQ.042 | IMMZ.F3.Send notifications | Routine Immunization Service Provider/Medical Records Officer | The notification to include specific details about upcoming immunization session dates and times or outreach dates and times as appropriate | The client will know specifically when and where to go to receive a vaccination |
| Business process G: Defaulter tracing | ||||
| IMMZ.FXNREQ.043 | IMMZ.G1.Determine if vaccines were missed | Routine Immunization Service Provider/ Medical Records Officer | The system to flag a client as a defaulter after a configured number of reminders are sent | We can identify those who have not come and are overdue, requiring additional intervention |
| IMMZ.FXNREQ.044 | IMMZ.G1.Determine if vaccines were missed | Routine Immunization Service Provider/Medical Records Officer | The system to be linked to eCHIS | CHEWS can do follow-ups in the catchment area of the facility. |
| IMMZ.FXNREQ.045 | IMMZ.G2.Generate list of clients who are due or overdue for vaccination | Routine Immunization Service Provider/Medical Records Officer | To produce a list of clients who missed their vaccine for each antigen, along with their location and personal information | I can plan follow-up activities and contact the clients |
| IMMZ.FXNREQ.046 | IMMZ.G3.Plan for follow-up directly or during outreach | Routine Immunization Service Provider/Medical Records Officer | To display a list of clients due for specific planned outreach and immunization sessions, based on area | The immunization session or outreach will have a targeted list of clients, allowing for prioritization of tasks and workload |
| IMMZ.FXNREQ.047 | IMMZ.G4.Update record to document reason/lost follow-up | Routine Immunization Service Provider/Medical Records Officer | To record reason vaccine was missed | This information can be used for planning and reporting purposes |
| IMMZ.FXNREQ.048 | IMMZ.G4.Update record to document reason/lost follow-up | Routine Immunization Officer/Medical Officer | To update client information such as including change of address (moved permanently or temporarily) | To facilitate the client being contacted or being removed from an immunization session’s list |
| IMMZ.FXREQ.049 | IMMZ.G5.Track zero dose children | State Immunization Officer | The system to automate follow-up on zero-dose children from linkage to the birth register or from coverage calculations | I can follow up and have an idea of the number of zero-dose children and communities where zero-dose children are located. |
| Business process H: Report generation | ||||
| IMMZ.FXNREQ.050 | IMMZ.H1.Define parameters for report | Routine Immunization Service Provider/Medical Records Officer/OIC | To be able to access the health facility’s dashboard | I can access and analyze health facility data |
| IMMZ.FXNREQ.051 | IMMZ.H1.Define parameters for report | LGA M&E | To be able to access LGA and health facility dashboards in my area | I can generate reports specific to my LGA |
| IMMZ.FXNREQ.052 | IMMZ.H1.Define parameters for report | State M&E | To be able to access State, LGA, and Health facility data | I can generate reports specific to my State |
| IMMZ.FXNREQ.053 | IMMZ.H2.View and download | Honourable Minister FMoHSW, DHPRS FMoH, ED, DG NCDC, DDCI, DL&HC, H/RI, RIWG data team, DDPRS, DHIS2 national FP, Head NSCS, EPI Partners | To be able to view and download reports | I can view the immunization status at the national level |
| Business process I; Stock Management | ||||
| IMMZ.FXNREQ.054 | IMMZ.I1. Record stock taken | Cold Chain Officer | To record stock removed from cold storage and taken to immunization session | The count for the cold storage will be accurate, and the immunization session stock will be accounted for |
| IMMZ.FXNREQ.055 | IMMZ.I1. Record stock taken | Cold Chain Officer | The system to maintain a tally of stock available at each location (e.g. stock available in the cold fridge at vaccination location, stock that is out for immunization session) | I can see where all stock is physically located in real time |
| Administrative Data Access Rights and Controls | ||||
| IMMZ.FXREQ.056 | Assign roles | Officer In Charge (OIC) | The system to assign roles | I can assign roles to team members in the facility |
| IMMZ.FXREQ.057 | Support back-end | IT Administrator | Access to back-end | I can offer backend support, troubleshooting, and system maintenance |
| IMMZ.FXREQ.058 | Create Profiles | State M&E | The system to create profiles | I can create user profiles for LGA and health facility |