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
<Bundle xmlns="http://hl7.org/fhir">
<id value="NgImmExampleBundle"/>
<meta>
<lastUpdated value="2025-07-04T08:30:00+01:00"/>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmBundle"/>
</meta>
<type value="collection"/>
<entry>
<fullUrl value="urn:uuid:patient-001"/>
<resource>
<Patient>
<id value="NgImmExamplePatient"/>
<meta>
<lastUpdated value="2025-07-04T08:30:00+01:00"/>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Patient_NgImmExamplePatient"> </a><p class="res-header-id"><b>Generated Narrative: Patient NgImmExamplePatient</b></p><a name="NgImmExamplePatient"> </a><a name="hcNgImmExamplePatient"> </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">Last updated: 2025-07-04 08:30:00+0100</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-NgImmPatient.html">NG-Imm Patient</a></p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">Zainab Abdulraheem Female, DoB: 2024-02-20 ( https://nimc.gov.ng#NIN98765432100)</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Record is active">Active:</td><td colspan="3">true</td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Detail</td><td colspan="3">No. 10, Igalamela Compound, Ankpa Ankpa KO </td></tr><tr><td style="background-color: #f3f5da" title="Language spoken">Language:</td><td colspan="3"><span title="Codes:">Igbo</span></td></tr><tr><td style="background-color: #f3f5da" title="Nominated Contact: ">:</td><td colspan="3"><ul><li>Aisha Abdulraheem </li><li>No. 10, Igalamela Compound Ankpa KO </li><li><a href="tel:+2348031234567">+2348031234567</a></li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Age of the Immunization Client recorded in years"><a href="StructureDefinition-age-in-years.html">NG-Imm Client Age in Years</a></td><td colspan="3">0</td></tr><tr><td style="background-color: #f3f5da" title="Age of the Immunization Client recorded in weeks"><a href="StructureDefinition-age-in-weeks.html">NG-Imm Client Age in Weeks</a></td><td colspan="3">20</td></tr><tr><td style="background-color: #f3f5da" title="Age of the Immunization Client recorded in months"><a href="StructureDefinition-age-in-months.html">NG-Imm Client Age in Months</a></td><td colspan="3">5</td></tr><tr><td style="background-color: #f3f5da" title="The Pregnancy status (pregnant or not-pregnant) of the Immunization Client"><a href="StructureDefinition-pregnancy-status.html">NG-Imm Client's Pregnancy status</a></td><td colspan="3"><span title="Codes:">Not Pregnant</span></td></tr><tr><td style="background-color: #f3f5da" title="Weight of the Immunization Client at birth"><a href="StructureDefinition-birth-weight.html">NG-Imm Weight at birth</a></td><td colspan="3">3.1</td></tr></table></div>
</text>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/birth-weight">
<valueDecimal value="3.1"/>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/pregnancy-status">
<valueCodeableConcept>
<coding>
<code value="notpregnant"/>
<display value="Not Pregnant"/>
</coding>
</valueCodeableConcept>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-weeks">
<valueInteger value="20"/>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-months">
<valueInteger value="5"/>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/age-in-years">
<valueInteger value="0"/>
</extension>
<identifier>
<system value="https://nimc.gov.ng"/>
<value value="NIN98765432100"/>
</identifier>
<active value="true"/>
<name>
<family value="Abdulraheem"/>
<given value="Zainab"/>
</name>
<gender value="female"/>
<birthDate value="2024-02-20"/>
<address>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward">
<valueCodeableConcept>
<coding>
<code value="amac-01"/>
<display value="Enjema"/>
</coding>
</valueCodeableConcept>
</extension>
<line value="No. 10, Igalamela Compound, Ankpa"/>
<city value="Ankpa"/>
<district value="ko-ankpa"/>
<state value="KO"/>
</address>
<photo>
<url
value="https://personal_server.org/photos/zainab-abdulraheem.jpg"/>
</photo>
<contact>
<relationship>
<text value="mother"/>
</relationship>
<name>
<family value="Abdulraheem"/>
<given value="Aisha"/>
</name>
<telecom>
<system value="phone"/>
<value value="+2348031234567"/>
</telecom>
<address>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/nigeria-administrative-ward">
<valueCodeableConcept>
<coding>
<code value="KO0802"/>
<display value="Enjema"/>
</coding>
</valueCodeableConcept>
</extension>
<line value="No. 10, Igalamela Compound"/>
<city value="Ankpa"/>
<district value="ko-ankpa"/>
<state value="KO"/>
</address>
</contact>
<communication>
<language>
<coding>
<code value="ibo"/>
<display value="Igbo"/>
</coding>
</language>
</communication>
</Patient>
</resource>
<search>
<mode value="match"/>
</search>
<request>
<method value="POST"/>
<url value="Patient"/>
</request>
<response>
<status value="201 Created"/>
</response>
</entry>
<entry>
<fullUrl value="urn:uuid:imm-001"/>
<resource>
<Immunization>
<id value="NgImmExampleImmunization"/>
<meta>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmImmunization"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Immunization_NgImmExampleImmunization"> </a><p class="res-header-id"><b>Generated Narrative: Immunization NgImmExampleImmunization</b></p><a name="NgImmExampleImmunization"> </a><a name="hcNgImmExampleImmunization"> </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-NgImmImmunization.html">NG-Imm Immunization</a></p></div><p><b>NG-Imm Digital Signature</b>: Digitally signed by Nurse Joy (ID: PRAC001)</p><p><b>NG-Imm Session Type</b>: <span title="Codes:">Outreach</span></p><p><b>NG-Imm Vaccine Contraindications</b>: <span title="Codes:">Previous adverse reaction to similar vaccine</span></p><p><b>NG-Imm Immunization Contraindicated</b>: false</p><p><b>identifier</b>: <code>https://nphcda.gov.ng/vaccine/ids</code>/IMMUN123456</p><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title="Codes:">Immunity</span></p><p><b>vaccineCode</b>: <span title="Codes:">BCG Vaccine</span></p><p><b>patient</b>: <a href="Bundle-NgImmExampleBundle.html#urn-uuid-patient-001">Bundle: type = collection</a></p><p><b>occurrence</b>: 2025-06-20 09:30:00+0100</p><p><b>manufacturer</b>: <a href="Bundle-NgImmExampleBundle.html#urn-uuid-org-001">Bundle: type = collection</a></p><p><b>lotNumber</b>: BCG2025A</p><p><b>expirationDate</b>: 2025-12-31</p><p><b>site</b>: <span title="Codes:">Left Arm</span></p><p><b>route</b>: <span title="Codes:">Intramuscular injection</span></p><p><b>doseQuantity</b>: 0.05 mL</p><h3>Performers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Function</b></td><td><b>Actor</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:">Administering Provider</span></td><td><code>urn:uuid:prac-001</code></td></tr></table><h3>Reactions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Date</b></td><td><b>Detail</b></td><td><b>Reported</b></td></tr><tr><td style="display: none">*</td><td>2025-06-21</td><td><code>urn:uuid:reaction-obs-001</code></td><td>true</td></tr></table><h3>ProtocolApplieds</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Series</b></td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td style="display: none">*</td><td>Childhood Routine Immunization</td><td><span title="Codes:">Tuberculosis</span></td><td>1</td></tr></table></div>
</text>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/signature">
<valueString value="Digitally signed by Nurse Joy (ID: PRAC001)"/>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/session-type">
<valueCodeableConcept>
<coding>
<code value="outreach"/>
<display value="Outreach"/>
</coding>
</valueCodeableConcept>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/contraindications">
<valueCodeableConcept>
<coding>
<code value="headache"/>
<display value="Previous adverse reaction to similar vaccine"/>
</coding>
</valueCodeableConcept>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/contraindicated">
<valueBoolean value="false"/>
</extension>
<identifier>
<system value="https://nphcda.gov.ng/vaccine/ids"/>
<value value="IMMUN123456"/>
</identifier>
<status value="completed"/>
<statusReason>
<coding>
<code value="immune"/>
<display value="Immunity"/>
</coding>
</statusReason>
<vaccineCode>
<coding>
<code value="bcg"/>
<display value="BCG Vaccine"/>
</coding>
</vaccineCode>
<patient>
<reference value="urn:uuid:patient-001"/>
</patient>
<occurrenceDateTime value="2025-06-20T09:30:00+01:00"/>
<manufacturer>
<reference value="urn:uuid:org-001"/>
</manufacturer>
<lotNumber value="BCG2025A"/>
<expirationDate value="2025-12-31"/>
<site>
<coding>
<code value="LA"/>
<display value="Left Arm"/>
</coding>
</site>
<route>
<coding>
<code value="IM"/>
<display value="Intramuscular injection"/>
</coding>
</route>
<doseQuantity>
<value value="0.05"/>
<unit value="mL"/>
</doseQuantity>
<performer>
<function>
<coding>
<code value="administering-provider"/>
<display value="Administering Provider"/>
</coding>
</function>
<actor>
<reference value="urn:uuid:prac-001"/>
</actor>
</performer>
<reaction>
<date value="2025-06-21"/>
<detail>
<reference value="urn:uuid:reaction-obs-001"/>
</detail>
<reported value="true"/>
</reaction>
<protocolApplied>
<series value="Childhood Routine Immunization"/>
<targetDisease>
<coding>
<code value="18853004"/>
<display value="Tuberculosis"/>
</coding>
</targetDisease>
<doseNumberPositiveInt value="1"/>
</protocolApplied>
</Immunization>
</resource>
<search>
<mode value="include"/>
</search>
<request>
<method value="POST"/>
<url value="Immunization"/>
</request>
<response>
<status value="201 Created"/>
</response>
</entry>
<entry>
<fullUrl value="urn:uuid:allergy-001"/>
<resource>
<AllergyIntolerance>
<id value="NgImmExampleAllergyIntolerance"/>
<meta>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-intolerance-profile"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="AllergyIntolerance_NgImmExampleAllergyIntolerance"> </a><p class="res-header-id"><b>Generated Narrative: AllergyIntolerance NgImmExampleAllergyIntolerance</b></p><a name="NgImmExampleAllergyIntolerance"> </a><a name="hcNgImmExampleAllergyIntolerance"> </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-allergy-intolerance-profile.html">NG-Imm AllergyIntolerance</a></p></div><p><b>NG-Imm Allergy Dose Number</b>: 1</p><p><b>NG-Imm Dose Series</b>: Childhood Routine Series</p><p><b>clinicalStatus</b>: <span title="Codes:{http://nphcda.gov.ng/ig/CodeSystem/clinical-status active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:">confirmed</span></p><p><b>type</b>: Allergy</p><p><b>category</b>: Medication</p><p><b>criticality</b>: High Risk</p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 91936005}">Allergy to penicillin</span></p><p><b>patient</b>: <a href="Bundle-NgImmExampleBundle.html#urn-uuid-patient-001">Bundle: type = collection</a></p><p><b>encounter</b>: <code>urn:uuid:encounter-001</code></p><p><b>onset</b>: 2024-10-05</p><p><b>recordedDate</b>: 2024-10-06</p><p><b>recorder</b>: Nurse Musa</p><p><b>lastOccurrence</b>: 2024-10-07</p><h3>Reactions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Substance</b></td><td><b>Manifestation</b></td><td><b>Description</b></td><td><b>Onset</b></td><td><b>Severity</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://snomed.info/sct 372729009}">Penicillin</span></td><td><span title="Codes:{http://snomed.info/sct 271807003}">Rash</span></td><td>Patient developed widespread rash within 12 hours of vaccination</td><td>2024-10-05 22:00:00+0100</td><td>Moderate</td></tr></table></div>
</text>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number">
<valueInteger value="1"/>
</extension>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-series">
<valueString value="Childhood Routine Series"/>
</extension>
<clinicalStatus>
<coding>
<system
value="http://nphcda.gov.ng/ig/CodeSystem/clinical-status"/>
<code value="active"/>
<display value="Active"/>
</coding>
</clinicalStatus>
<verificationStatus>
<coding>
<code value="confirmed"/>
</coding>
</verificationStatus>
<type value="allergy"/>
<category value="medication"/>
<criticality value="high"/>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="91936005"/>
<display value="Allergy to penicillin"/>
</coding>
</code>
<patient>
<reference value="urn:uuid:patient-001"/>
</patient>
<encounter>
<reference value="urn:uuid:encounter-001"/>
</encounter>
<onsetDateTime value="2024-10-05"/>
<recordedDate value="2024-10-06"/>
<recorder>
<display value="Nurse Musa"/>
</recorder>
<lastOccurrence value="2024-10-07"/>
<reaction>
<substance>
<coding>
<system value="http://snomed.info/sct"/>
<code value="372729009"/>
<display value="Penicillin"/>
</coding>
</substance>
<manifestation>
<coding>
<system value="http://snomed.info/sct"/>
<code value="271807003"/>
<display value="Rash"/>
</coding>
</manifestation>
<description
value="Patient developed widespread rash within 12 hours of vaccination"/>
<onset value="2024-10-05T22:00:00+01:00"/>
<severity value="moderate"/>
</reaction>
</AllergyIntolerance>
</resource>
<search>
<mode value="include"/>
</search>
<request>
<method value="POST"/>
<url value="AllergyIntolerance"/>
</request>
<response>
<status value="201 Created"/>
</response>
</entry>
<entry>
<fullUrl value="urn:uuid:sibling-001"/>
<resource>
<RelatedPerson>
<id value="NgImmExampleSiblingRelatedPerson"/>
<meta>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/mother-other-children"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_NgImmExampleSiblingRelatedPerson"> </a><p class="res-header-id"><b>Generated Narrative: RelatedPerson NgImmExampleSiblingRelatedPerson</b></p><a name="NgImmExampleSiblingRelatedPerson"> </a><a name="hcNgImmExampleSiblingRelatedPerson"> </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-mother-other-children.html">NG-Imm RelatedPerson</a></p></div><p><b>NG-Imm Sibling's health status</b>: <span title="Codes:">Healthy</span></p><p><b>patient</b>: <a href="Bundle-NgImmExampleBundle.html#urn-uuid-patient-001">Bundle: type = collection</a></p><p><b>relationship</b>: <span title="Codes:">brother</span></p><p><b>name</b>: Suleiman Ayodele Abdulraheem </p><p><b>gender</b>: Male</p><p><b>birthDate</b>: 2020-03-10</p></div>
</text>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/sibling-health-status">
<valueCodeableConcept>
<coding>
<code value="healthy"/>
<display value="Healthy"/>
</coding>
</valueCodeableConcept>
</extension>
<patient>
<reference value="urn:uuid:patient-001"/>
</patient>
<relationship>
<text value="brother"/>
</relationship>
<name>
<family value="Abdulraheem"/>
<given value="Suleiman"/>
<given value="Ayodele"/>
</name>
<gender value="male"/>
<birthDate value="2020-03-10"/>
</RelatedPerson>
</resource>
<search>
<mode value="include"/>
</search>
<request>
<method value="POST"/>
<url value="RelatedPerson"/>
</request>
<response>
<status value="201 Created"/>
</response>
</entry>
<entry>
<fullUrl value="urn:uuid:org-001"/>
<resource>
<Organization>
<id value="NgImmExampleOrganization"/>
<meta>
<profile
value="http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-organization"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Organization_NgImmExampleOrganization"> </a><p class="res-header-id"><b>Generated Narrative: Organization NgImmExampleOrganization</b></p><a name="NgImmExampleOrganization"> </a><a name="hcNgImmExampleOrganization"> </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-ng-imm-organization.html">NG-Imm Organization</a></p></div><p><b>NG-Imm owner of health institution</b>: <span title="Codes:">Kogi State Primary Health Care Board</span></p><p><b>identifier</b>: <code>https://herfama.kogistate.gov.ng</code>/KOHF-00123</p><p><b>active</b>: true</p><p><b>type</b>: <span title="Codes:">General Hospital</span></p><p><b>name</b>: Ankpa General Hospital</p><p><b>telecom</b>: <a href="tel:+2348031122334">+2348031122334</a></p><p><b>address</b>: Old Otukpo Road, Opp. Ankpa Market Ankpa KO </p></div>
</text>
<extension
url="http://nphcda.gov.ng/ig/immunization/StructureDefinition/organozation-owner">
<valueCodeableConcept>
<coding>
<code value="public"/>
<display value="Kogi State Primary Health Care Board"/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value="https://herfama.kogistate.gov.ng"/>
<value value="KOHF-00123"/>
</identifier>
<active value="true"/>
<type>
<coding>
<code value="hospital"/>
<display value="General Hospital"/>
</coding>
</type>
<name value="Ankpa General Hospital"/>
<telecom>
<system value="phone"/>
<value value="+2348031122334"/>
</telecom>
<address>
<line value="Old Otukpo Road, Opp. Ankpa Market"/>
<city value="Ankpa"/>
<district value="ko-ankpa"/>
<state value="KO"/>
</address>
</Organization>
</resource>
<search>
<mode value="include"/>
</search>
<request>
<method value="POST"/>
<url value="Organization"/>
</request>
<response>
<status value="201 Created"/>
</response>
</entry>
</Bundle>