Nigeria Immunization FHIR IG
0.1.0 - ci-build
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
<Bundle xmlns="http://hl7.org/fhir">
<id value="ExampleUpdateClientHistoryBundle"/>
<meta>
<profile
value="http://nhin.example.ng/StructureDefinition/immzc1-client-update-bundle"/>
</meta>
<type value="transaction"/>
<entry>
<fullUrl value="urn:uuid:immunization-1"/>
<resource>
<Immunization>
<id value="NEIRImmunizationExample"/>
<meta>
<profile
value="http://nhin.example.ng/StructureDefinition/NEIRImmunization"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Immunization_NEIRImmunizationExample"> </a><p class="res-header-id"><b>Generated Narrative: Immunization NEIRImmunizationExample</b></p><a name="NEIRImmunizationExample"> </a><a name="hcNEIRImmunizationExample"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-NEIRImmunization.html">Immunization Profile - NEIR</a></p></div><p><b>status</b>: Completed</p><p><b>vaccineCode</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/IMMZ.F.DE6 measles}">Measles</span></p><p><b>patient</b>: <a href="Patient-NEIRPatientExample.html">John Doe Male, DoB: 2020-06-18 ( http://moh.nigeria/identifier/nationalID-no#NEIR-12345)</a></p><p><b>occurrence</b>: 2025-07-30 10:30:00+0300</p><p><b>location</b>: <a href="Location/NEIRlocationExample">Location/NEIRlocationExample</a></p><p><b>manufacturer</b>: <a href="Organization/biovax-manufacturer">BioVax Ltd.</a></p><p><b>lotNumber</b>: BATCH-00123</p><p><b>expirationDate</b>: 2026-01-01</p><p><b>site</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/IMMZ.D DE23}">Left Arm</span></p><p><b>route</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/IMMZ.D DE30}">Intramuscular</span></p><p><b>doseQuantity</b>: 0.5 mL<span style="background: LightGoldenRodYellow"> (Details: UCUM codemL = 'mL')</span></p><h3>Performers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Actor</b></td></tr><tr><td style="display: none">*</td><td><a href="Practitioner/NEIRPractitionerExample">Dr. Jane Mugo</a></td></tr></table><h3>ProtocolApplieds</h3><table class="grid"><tr><td style="display: none">-</td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://nhin.example.ng/CodeSystem/IMMZ.F.DE6 measles}">Measles</span></td><td>1</td></tr></table></div>
</text>
<status value="completed"/>
<vaccineCode>
<coding>
<system value="http://nhin.example.ng/CodeSystem/IMMZ.F.DE6"/>
<code value="measles"/>
<display value="Measles"/>
</coding>
</vaccineCode>
<patient>🔗
<reference value="Patient/NEIRPatientExample"/>
</patient>
<occurrenceDateTime value="2025-07-30T10:30:00+03:00"/>
<location>
<reference value="Location/NEIRlocationExample"/>
</location>
<manufacturer>
<reference value="Organization/biovax-manufacturer"/>
<display value="BioVax Ltd."/>
</manufacturer>
<lotNumber value="BATCH-00123"/>
<expirationDate value="2026-01-01"/>
<site>
<coding>
<system value="http://nhin.example.ng/CodeSystem/IMMZ.D"/>
<code value="DE23"/>
<display value="Left Arm"/>
</coding>
</site>
<route>
<coding>
<system value="http://nhin.example.ng/CodeSystem/IMMZ.D"/>
<code value="DE30"/>
<display value="Intramuscular"/>
</coding>
</route>
<doseQuantity>
<value value="0.5"/>
<unit value="mL"/>
<system value="http://unitsofmeasure.org"/>
<code value="mL"/>
</doseQuantity>
<performer>
<actor>
<reference value="Practitioner/NEIRPractitionerExample"/>
<display value="Dr. Jane Mugo"/>
</actor>
</performer>
<protocolApplied>
<targetDisease>
<coding>
<system value="http://nhin.example.ng/CodeSystem/IMMZ.F.DE6"/>
<code value="measles"/>
<display value="Measles"/>
</coding>
</targetDisease>
<doseNumberPositiveInt value="1"/>
</protocolApplied>
</Immunization>
</resource>
<request>
<method value="POST"/>
<url value="NEIRImmunization"/>
</request>
</entry>
<entry>
<fullUrl value="urn:uuid:bcg-vaccine-stock-1"/>
<resource>
<Observation>
<id value="ExampleBCGVaccineStockObservation"/>
<meta>
<profile
value="http://nhin.example.ng/StructureDefinition/immz-vaccine-stock-observation"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Observation_ExampleBCGVaccineStockObservation"> </a><p class="res-header-id"><b>Generated Narrative: Observation ExampleBCGVaccineStockObservation</b></p><a name="ExampleBCGVaccineStockObservation"> </a><a name="hcExampleBCGVaccineStockObservation"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-immz-vaccine-stock-observation.html">Vaccine Stock Observation</a></p></div><p><b>status</b>: Final</p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes IMMZ.I.DE1}">BCG Vaccines</span></p><p><b>encounter</b>: <a href="Encounter-NEIREncounterExample.html">Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach</a></p><p><b>effective</b>: 2025-08-07</p><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes opening-balance}">Opening balance</span></p><p><b>value</b>: 100 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes received}">Doses received</span></p><p><b>value</b>: 50 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes doses-opened}">Doses opened</span></p><p><b>value</b>: 60 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes ending-balance}">Ending balance</span></p><p><b>value</b>: 90 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes returned}">Quantity returned</span></p><p><b>value</b>: 2 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://nhin.example.ng/CodeSystem/VaccineStockCodes empty-vials}">Empty vials returned</span></p><p><b>value</b>: 58 vial<span style="background: LightGoldenRodYellow"> (Details: UCUM codevial = 'vial')</span></p></blockquote></div>
</text>
<status value="final"/>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="IMMZ.I.DE1"/>
<display value="BCG Vaccines"/>
</coding>
</code>
<encounter>🔗
<reference value="Encounter/NEIREncounterExample"/>
</encounter>
<effectiveDateTime value="2025-08-07"/>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="opening-balance"/>
<display value="Opening balance"/>
</coding>
</code>
<valueQuantity>
<value value="100"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="received"/>
<display value="Doses received"/>
</coding>
</code>
<valueQuantity>
<value value="50"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="doses-opened"/>
<display value="Doses opened"/>
</coding>
</code>
<valueQuantity>
<value value="60"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="ending-balance"/>
<display value="Ending balance"/>
</coding>
</code>
<valueQuantity>
<value value="90"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="returned"/>
<display value="Quantity returned"/>
</coding>
</code>
<valueQuantity>
<value value="2"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
<component>
<code>
<coding>
<system
value="http://nhin.example.ng/CodeSystem/VaccineStockCodes"/>
<code value="empty-vials"/>
<display value="Empty vials returned"/>
</coding>
</code>
<valueQuantity>
<value value="58"/>
<system value="http://unitsofmeasure.org"/>
<code value="vial"/>
</valueQuantity>
</component>
</Observation>
</resource>
<request>
<method value="POST"/>
<url value="VaccineStockObservation"/>
</request>
</entry>
<entry>
<fullUrl value="urn:uuid:observation-1"/>
<resource>
<Observation>
<id value="ExampleNEIRUpdateClientHistoryObservation"/>
<meta>
<profile
value="http://nhin.example.ng/StructureDefinition/NEIRUpdateClientHistoryObservation"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Observation_ExampleNEIRUpdateClientHistoryObservation"> </a><p class="res-header-id"><b>Generated Narrative: Observation ExampleNEIRUpdateClientHistoryObservation</b></p><a name="ExampleNEIRUpdateClientHistoryObservation"> </a><a name="hcExampleNEIRUpdateClientHistoryObservation"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-NEIRUpdateClientHistoryObservation.html">Observations - NEIR Update Client History</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 123456}">NEIR Update Client History Observations</span></p><p><b>subject</b>: <a href="Patient-NEIRPatientExample.html">John Doe Male, DoB: 2020-06-18 ( http://moh.nigeria/identifier/nationalID-no#NEIR-12345)</a></p><p><b>encounter</b>: <a href="Encounter-NEIREncounterExample.html">Encounter: status = in-progress; class = home health (ActCode#HH); type = Outreach</a></p><p><b>effective</b>: 2025-08-07 10:00:00+0300</p><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11323-3}">Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen.</span></p><p><b>value</b>: true</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://loinc.org 55284-4}">HIV status</span></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 86406008}">HIV negative</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11323-31}"> </span></p><p><b>value</b>: Test State</p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11323-391}"> </span></p><p><b>value</b>: Test Comment</p></blockquote></div>
</text>
<status value="final"/>
<category>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/observation-category"/>
<code value="social-history"/>
</coding>
</category>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="123456"/>
<display value="NEIR Update Client History Observations"/>
</coding>
</code>
<subject>🔗
<reference value="Patient/NEIRPatientExample"/>
</subject>
<encounter>🔗
<reference value="Encounter/NEIREncounterExample"/>
</encounter>
<effectiveDateTime value="2025-08-07T10:00:00+03:00"/>
<component>
<code>
<coding>
<system value="http://loinc.org"/>
<code value="11323-3"/>
<display
value="Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen."/>
</coding>
</code>
<valueBoolean value="true"/>
</component>
<component>
<code>
<coding>
<system value="http://loinc.org"/>
<code value="55284-4"/>
<display value="HIV status"/>
</coding>
</code>
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct"/>
<code value="86406008"/>
<display value="HIV negative"/>
</coding>
</valueCodeableConcept>
</component>
<component>
<code>
<coding>
<system value="http://loinc.org"/>
<code value="11323-31"/>
<display value=" "/>
</coding>
</code>
<valueString value="Test State"/>
</component>
<component>
<code>
<coding>
<system value="http://loinc.org"/>
<code value="11323-391"/>
<display value=" "/>
</coding>
</code>
<valueString value="Test Comment"/>
</component>
</Observation>
</resource>
<request>
<method value="POST"/>
<url value="NEIRUpdateClientHistoryObservation"/>
</request>
</entry>
<signature>
<type>
<system value="urn:iso-astm:E1762-95:2013"/>
<code value="1.2.840.10065.1.12.1.1"/>
<display value="Author's Signature"/>
</type>
<when value="2025-08-07T10:00:00Z"/>
<who>🔗
<reference value="Practitioner/practitioner-example"/>
</who>
<targetFormat value="application/fhir+json"/>
<sigFormat value="application/signature+xml"/>
<data value="dGhpcyBpcyBhIHNpZ25hdHVyZQ=="/>
</signature>
</Bundle>