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

Example Bundle: Example - Stock Management Bundle

Bundle ExampleStockManagementTransactionBundle of type transaction


Entry 1 - fullUrl = urn:uuid:encounter-1

Resource Location:

status: Active

name: Kofar Dukayuwa PHC

type: Ambulance

address: Kofar Dukayuwa PHC, Kano, Nigeria

Request:

POST Encounter

Entry 2 - fullUrl = urn:uuid:bcg-diluent-stock-1

Resource Observation:

status: Final

code: BCG Diluents

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 80 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 40 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 70 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 48 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 3 - fullUrl = urn:uuid:hepB-vaccine-stock-1

Resource Observation:

status: Final

code: Hep B vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 120 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 30 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 40 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 110 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 1 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 39 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 4 - fullUrl = urn:uuid:opv-vaccine-stock-1

Resource Observation:

status: Final

code: OPV Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 20 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 25 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 85 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 3 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 22 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 5 - fullUrl = urn:uuid:penta-vaccine-stock-1

Resource Observation:

status: Final

code: PENTA Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 140 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 60 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 70 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 130 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 4 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 66 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 6 - fullUrl = urn:uuid:pcv-vaccine-stock-1

Resource Observation:

status: Final

code: PCV Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 110 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 45 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 105 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 48 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 7 - fullUrl = urn:uuid:ipv-vaccine-stock-1

Resource Observation:

status: Final

code: IPV Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 60 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 5 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 55 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 8 - fullUrl = urn:uuid:rotavirus-vaccine-stock-1

Resource Observation:

status: Final

code: Rotavirus Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 130 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 70 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 80 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 120 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 3 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 77 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 9 - fullUrl = urn:uuid:measles-vaccine-stock-1

Resource Observation:

status: Final

code: Measles Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 60 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 58 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 10 - fullUrl = urn:uuid:measles-diluent-stock-1

Resource Observation:

status: Final

code: Measles Diluents

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 95 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 40 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 55 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 80 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 1 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 54 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 11 - fullUrl = urn:uuid:yellowfever-vaccine-stock-1

Resource Observation:

status: Final

code: Yellow Fever Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 60 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 70 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 68 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 12 - fullUrl = urn:uuid:yellowfever-diluent-stock-1

Resource Observation:

status: Final

code: Yellow Fever Diluent

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 85 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 30 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 40 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 75 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 1 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 39 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 13 - fullUrl = urn:uuid:mena-vaccine-stock-1

Resource Observation:

status: Final

code: Men A Vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 115 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 55 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 110 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 3 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 52 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 14 - fullUrl = urn:uuid:mena-diluent-stock-1

Resource Observation:

status: Final

code: Men A Diluents

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 40 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 45 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 95 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 1 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 44 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 15 - fullUrl = urn:uuid:hpv-vaccine-stock-1

Resource Observation:

status: Final

code: HPV vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 105 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 30 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 35 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 1 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 33 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 16 - fullUrl = urn:uuid:td-vaccine-stock-1

Resource Observation:

status: Final

code: Td vaccine

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 55 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 95 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 53 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation

Entry 17 - fullUrl = urn:uuid:td-device-stock-1

Resource Observation:

status: Final

code: BCG syringes

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Quantity received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Quantity used

value: 20 vial (Details: UCUM codevial = 'vial')

component

code: Closing balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Functional

value: Functional

component

code: Functional devices

value: 58 vial (Details: UCUM codevial = 'vial')

component

code: Non-functional devices

value: 8 vial (Details: UCUM codevial = 'vial')

Request:

POST DeviceMaterialObservation

Entry 18 - fullUrl = urn:uuid:bcg-vaccine-stock-1

Resource Observation:

status: Final

code: BCG Vaccines

encounter: Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach

effective: 2025-08-07

component

code: Opening balance

value: 100 vial (Details: UCUM codevial = 'vial')

component

code: Doses received

value: 50 vial (Details: UCUM codevial = 'vial')

component

code: Doses opened

value: 60 vial (Details: UCUM codevial = 'vial')

component

code: Ending balance

value: 90 vial (Details: UCUM codevial = 'vial')

component

code: Quantity returned

value: 2 vial (Details: UCUM codevial = 'vial')

component

code: Empty vials returned

value: 58 vial (Details: UCUM codevial = 'vial')

Request:

POST VaccineStockObservation