NPHCDA Immunization FHIR IG
0.7.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions

CapabilityStatement: NG-Imm Client CapabilityStatement

Official URL: https://nphcda.gov.ng/ig/CapabilityStatement/NgImmCapabilityStatementClient Version: 0.7.0
Active as of 2025-08-07 Computable Name:

This CapabilityStatement describes the expected behavior of an offline-first client (e.g., mobile Immunization POC health facility system), FHIR-capable systems implementing Nigeria's Immunization Implementation Guide.

Raw OpenAPI-Swagger Definition file | Download

NG-Imm Client CapabilityStatement

  • Implementation Guide Version: 0.7.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2025-08-07
  • Published by: https://nphcda.gov.ng

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patienthttps://nphcda.gov.ng/ig/StructureDefinition/NgImmPatientidentifier, firstname, lastname, birthdate, createddate, email_mobile, gender, pseudo-id$submit-ngimm-patient
Immunizationhttps://nphcda.gov.ng/ig/StructureDefinition/NgImmImmunizationpatient, status, vaccine-code, date$submit-ngimm-immunization
Bundlehttps://nphcda.gov.ng/ig/StructureDefinition/ngimm-client-registration-bundlepatient.identifier, _lastUpdated, vaccine-code, organization-identifier$submit-ngimm-bundle
Organizationhttps://nphcda.gov.ng/ig/StructureDefinition/ng-imm-organizationorganization-identifier$submit-ngimm-organization
Encounterhttps://nphcda.gov.ng/ig/StructureDefinition/ng-imm-encounterencounter-identifier$submit-ngimm-encounter
RelatedPersonhttps://nphcda.gov.ng/ig/StructureDefinition/mother-other-childrenrelatedperson-identifier$submit-ngimm-relatedperson
Practitionerhttps://nphcda.gov.ng/ig/StructureDefinition/NgImmPractitionerpractitioner-identifier, license$submit-ngimm-practitioner
MeasureReporthttps://nphcda.gov.ng/ig/StructureDefinition/measure-report-profilemeasurereport-identifier$submit-ngimm-measurereport
Provenancehttps://nphcda.gov.ng/ig/StructureDefinition/ng-imm-provenanceprovenance-identifier
StructureMaphttp://hl7.org/fhir/StructureDefinition/StructureMap$transform

Resource Conformance: supported Patient

Base System Profile
NG-Imm Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLidentifiertoken
    SHALLfirstnamestring
    SHALLlastnamestring
    SHALLbirthdatedate
    SHALLcreateddatedate
    SHALLemail_mobilestring
    SHALLgendertoken
    SHALLpseudo-idtoken
     
    Extended Operations
    ConformanceOperationDocumentation
    SHALL$submit-ngimm-patient

    Resource Conformance: supported Immunization

    Base System Profile
    NG-Imm Immunization
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference
      SHALLstatustoken
      SHALLvaccine-codetoken
      SHALLdatedate
       
      Extended Operations
      ConformanceOperationDocumentation
      SHALL$submit-ngimm-immunization

      Resource Conformance: supported Bundle

      Base System Profile
      IMMZ.C.5 Bundle Client Registration
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Search Parameters
        ConformanceParameterTypeDocumentation
        SHALLpatient.identifiertoken
        SHALL_lastUpdateddate
        SHALLvaccine-codetoken
        SHALLorganization-identifiertoken
         
        Extended Operations
        ConformanceOperationDocumentation
        SHALL$submit-ngimm-bundle

        Resource Conformance: supported Organization

        Base System Profile
        NG-Imm Organization
        Profile Conformance
        SHALL
        Reference Policy

        Interaction summary

          Search Parameters
          ConformanceParameterTypeDocumentation
          SHALLorganization-identifiertoken
           
          Extended Operations
          ConformanceOperationDocumentation
          SHALL$submit-ngimm-organization

          Resource Conformance: supported Encounter

          Base System Profile
          NG-Imm Encounter
          Profile Conformance
          SHALL
          Reference Policy

          Interaction summary

            Search Parameters
            ConformanceParameterTypeDocumentation
            SHALLencounter-identifiertoken
             
            Extended Operations
            ConformanceOperationDocumentation
            SHALL$submit-ngimm-encounter

            Resource Conformance: supported RelatedPerson

            Base System Profile
            NG-Imm RelatedPerson
            Profile Conformance
            SHALL
            Reference Policy

            Interaction summary

              Search Parameters
              ConformanceParameterTypeDocumentation
              SHALLrelatedperson-identifiertoken
               
              Extended Operations
              ConformanceOperationDocumentation
              SHALL$submit-ngimm-relatedperson

              Resource Conformance: supported Practitioner

              Base System Profile
              NG-Imm Practitioner
              Profile Conformance
              SHALL
              Reference Policy

              Interaction summary

                Search Parameters
                ConformanceParameterTypeDocumentation
                SHALLpractitioner-identifiertoken
                SHALLlicensetoken
                 
                Extended Operations
                ConformanceOperationDocumentation
                SHALL$submit-ngimm-practitioner

                Resource Conformance: supported MeasureReport

                Base System Profile
                NG-Imm MeasureReport
                Profile Conformance
                SHALL
                Reference Policy

                Interaction summary

                  Search Parameters
                  ConformanceParameterTypeDocumentation
                  SHALLmeasurereport-identifiertoken
                   
                  Extended Operations
                  ConformanceOperationDocumentation
                  SHALL$submit-ngimm-measurereport

                  Resource Conformance: supported Provenance

                  Base System Profile
                  NG-Imm Provenance
                  Profile Conformance
                  SHALL
                  Reference Policy

                  Interaction summary

                    Search Parameters
                    ConformanceParameterTypeDocumentation
                    SHALLprovenance-identifiertoken
                     

                    Resource Conformance: supported StructureMap

                    Base System Profile
                    StructureMap
                    Profile Conformance
                    SHALL
                    Reference Policy

                    Interaction summary

                      Extended Operations
                      ConformanceOperationDocumentation
                      SHALL$transform