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 of a Vaccine Administration Bundle - JSON Representation

Raw json | Download

{
  "resourceType" : "Bundle",
  "id" : "ExampleAdministerVaccineTransactionBundle",
  "meta" : {
    "profile" : [
      🔗 "http://nhin.example.ng/StructureDefinition/AdministerVaccineTransactionBundle"
    ]
  },
  "type" : "transaction",
  "entry" : [
    {
      "fullUrl" : "urn:uuid:encounter-1",
      "resource" : {
        "resourceType" : "Location",
        "id" : "NEIRLocationExample",
        "meta" : {
          "profile" : [
            🔗 "http://nhin.example.ng/StructureDefinition/NEIRLocation"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Location_NEIRLocationExample\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Location NEIRLocationExample</b></p><a name=\"NEIRLocationExample\"> </a><a name=\"hcNEIRLocationExample\"> </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-NEIRLocation.html\">NEIRLocation Profile</a></p></div><p><b>status</b>: Active</p><p><b>name</b>: Kofar Dukayuwa PHC</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode AMB}\">Ambulance</span></p><p><b>telecom</b>: <a href=\"tel:+2348012345678\">+2348012345678</a></p><p><b>address</b>: Kofar Dukayuwa PHC, Kano, Nigeria</p></div>"
        },
        "status" : "active",
        "name" : "Kofar Dukayuwa PHC",
        "type" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code" : "AMB",
                "display" : "Ambulance"
              }
            ]
          }
        ],
        "telecom" : [
          {
            "system" : "phone",
            "value" : "+2348012345678",
            "use" : "work"
          }
        ],
        "address" : {
          "text" : "Kofar Dukayuwa PHC, Kano, Nigeria",
          "city" : "Kano",
          "country" : "NG"
        }
      },
      "request" : {
        "method" : "POST",
        "url" : "Encounter"
      }
    },
    {
      "fullUrl" : "urn:uuid:encounter-1",
      "resource" : {
        "resourceType" : "Encounter",
        "id" : "NEIREncounterExample",
        "meta" : {
          "profile" : [
            🔗 "http://nhin.example.ng/StructureDefinition/NEIREncounter"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Encounter_NEIREncounterExample\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Encounter NEIREncounterExample</b></p><a name=\"NEIREncounterExample\"> </a><a name=\"hcNEIREncounterExample\"> </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-NEIREncounter.html\">Encounter Profile - NEIR</a></p></div><p><b>status</b>: In Progress</p><p><b>class</b>: <a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-ActCode.html#v3-ActCode-HH\">ActCode HH</a>: home health</p><p><b>type</b>: <span title=\"Codes:{http://moh.nigeria/sessionType DE8}\">Outreach</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><h3>Participants</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Individual</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Practitioner-practitioner-example.html\">Practitioner John Doe </a></td></tr></table><h3>Locations</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Location</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Location-NEIRLocationExample.html\">Location Kofar Dukayuwa PHC</a></td></tr></table><p><b>serviceProvider</b>: <a href=\"Organization-NEIROrganizationExample.html\">Organization NEIR Lagos Clinic</a></p></div>"
        },
        "status" : "in-progress",
        "class" : {
          "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code" : "HH"
        },
        "type" : [
          {
            "coding" : [
              {
                "system" : "http://moh.nigeria/sessionType",
                "code" : "DE8",
                "display" : "Outreach"
              }
            ]
          }
        ],
        "subject" : {
          🔗 "reference" : "Patient/NEIRPatientExample"
        },
        "participant" : [
          {
            "individual" : {
              🔗 "reference" : "Practitioner/practitioner-example"
            }
          }
        ],
        "location" : [
          {
            "location" : {
              🔗 "reference" : "Location/NEIRLocationExample"
            }
          }
        ],
        "serviceProvider" : {
          🔗 "reference" : "Organization/NEIROrganizationExample"
        }
      },
      "request" : {
        "method" : "POST",
        "url" : "Encounter"
      }
    },
    {
      "fullUrl" : "urn:uuid:immunization-1",
      "resource" : {
        "resourceType" : "Immunization",
        "id" : "NEIRImmunizationExample",
        "meta" : {
          "profile" : [
            🔗 "http://nhin.example.ng/StructureDefinition/NEIRImmunization"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<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>"
        },
        "status" : "completed",
        "vaccineCode" : {
          "coding" : [
            {
              "system" : "http://nhin.example.ng/CodeSystem/IMMZ.F.DE6",
              "code" : "measles",
              "display" : "Measles"
            }
          ]
        },
        "patient" : {
          🔗 "reference" : "Patient/NEIRPatientExample"
        },
        "occurrenceDateTime" : "2025-07-30T10:30:00+03:00",
        "location" : {
          "reference" : "Location/NEIRlocationExample"
        },
        "manufacturer" : {
          "reference" : "Organization/biovax-manufacturer",
          "display" : "BioVax Ltd."
        },
        "lotNumber" : "BATCH-00123",
        "expirationDate" : "2026-01-01",
        "site" : {
          "coding" : [
            {
              "system" : "http://nhin.example.ng/CodeSystem/IMMZ.D",
              "code" : "DE23",
              "display" : "Left Arm"
            }
          ]
        },
        "route" : {
          "coding" : [
            {
              "system" : "http://nhin.example.ng/CodeSystem/IMMZ.D",
              "code" : "DE30",
              "display" : "Intramuscular"
            }
          ]
        },
        "doseQuantity" : {
          "value" : 0.5,
          "unit" : "mL",
          "system" : "http://unitsofmeasure.org",
          "code" : "mL"
        },
        "performer" : [
          {
            "actor" : {
              "reference" : "Practitioner/NEIRPractitionerExample",
              "display" : "Dr. Jane Mugo"
            }
          }
        ],
        "protocolApplied" : [
          {
            "targetDisease" : [
              {
                "coding" : [
                  {
                    "system" : "http://nhin.example.ng/CodeSystem/IMMZ.F.DE6",
                    "code" : "measles",
                    "display" : "Measles"
                  }
                ]
              }
            ],
            "doseNumberPositiveInt" : 1
          }
        ]
      },
      "request" : {
        "method" : "POST",
        "url" : "Immunization"
      }
    },
    {
      "fullUrl" : "urn:uuid:immunization-1",
      "resource" : {
        "resourceType" : "DetectedIssue",
        "id" : "NEIRDetectedIssueExample",
        "meta" : {
          "profile" : [
            🔗 "http://nhin.example.ng/StructureDefinition/NEIRDetectedIssue"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"DetectedIssue_NEIRDetectedIssueExample\"> </a><p class=\"res-header-id\"><b>Generated Narrative: DetectedIssue NEIRDetectedIssueExample</b></p><a name=\"NEIRDetectedIssueExample\"> </a><a name=\"hcNEIRDetectedIssueExample\"> </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-NEIRDetectedIssue.html\">DetectedIssue Profile - NEIR</a></p></div><p><b>identifier</b>: <code>http://neir.nigeria.gov/detectedissue</code>/DI-20250807-001</p><p><b>status</b>: Final</p><p><b>code</b>: <span title=\"Codes:\">Allergy to vaccine component</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></div>"
        },
        "identifier" : [
          {
            "system" : "http://neir.nigeria.gov/detectedissue",
            "value" : "DI-20250807-001"
          }
        ],
        "status" : "final",
        "code" : {
          "coding" : [
            {
              "code" : "DE13",
              "display" : "Allergy to vaccine component"
            }
          ]
        },
        "patient" : {
          🔗 "reference" : "Patient/NEIRPatientExample"
        }
      },
      "request" : {
        "method" : "POST",
        "url" : "DetectedIssue"
      }
    }
  ]
}