NPHCDA Immunization FHIR IG
1.0.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 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

CapabilityStatement: NG-Imm Client CapabilityStatement

Official URL: http://nphcda.gov.ng/ig/immunization/CapabilityStatement/NgImmCapabilityStatementClient Version: 1.0.0
Active as of 2025-08-03 Computable Name:

This CapabilityStatement defines the expected behavior of client systems that interact with NG-IMM FHIR servers in Nigeria’s immunization ecosystem.

Clients must support standard RESTful interactions with NG-IMM-compliant FHIR APIs and use appropriate operations to submit, export, and validate structured data. They are also expected to initiate transformation of logical models (e.g. RegisterClientModel, AdministerVaccine) into formal FHIR resources using $transform.

Use of HTTP Methods:

  • POST: Used by clients to create new Patient, Immunization, or Bundle resources.
  • PUT: Used to fully replace an existing resource with updated data.
  • PATCH: Used to update only specific elements of a resource.

Raw OpenAPI-Swagger Definition file | Download

NG-Imm Client CapabilityStatement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml
  • Supported Patch Formats:
  • Published on: 2025-08-03
  • 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

Client systems consuming NG-IMM immunization APIs must support reading, creating, updating, and transforming immunization-related resources via REST and custom operations.

Summary of System-wide Interactions

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 TypeProfileRSUPCSearches_include_revincludeOperations
Patienthttp://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatientyyyyyidentifier, firstname, lastname, birthdate, gender, state$submit, $export, $validate
Immunizationhttp://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmImmunizationyyyyypatient, status, vaccine-code, date$submit, $export, $validate
Bundlehttp://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmBundleyyyytype, timestamp, identifier$submit, $export, $validate

Resource Conformance: supported Patient

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

Interaction summary
  • Supports read, search-type, create, update, patch.

Documentation

Clients use the NgImmPatient profile to register new patients or update existing records.

  • POST: Create new patient.
  • PUT: Full replacement of a known patient.
  • PATCH: Partial updates (e.g., birthDate, address).

Clients should also submit Provenance to attribute responsibility for updates.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLfirstnamestring
SHALLlastnamestring
SHALLbirthdatedate
SHALLgendertoken
SHALLstatetoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$submit
SHALL$export
SHALL$validate

Resource Conformance: supported Immunization

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

Interaction summary
  • Supports read, search-type, create, update, patch.

Documentation

Clients use NgImmImmunization to record or correct vaccine administration events.

  • POST: Create new immunization record.
  • PUT: Replace an existing immunization resource.
  • PATCH: Targeted update, e.g. status or performer.

Clients may include Provenance if updates are made on behalf of health workers.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
SHALLvaccine-codetoken
SHALLdatedate
 
Extended Operations
ConformanceOperationDocumentation
SHALL$submit
SHALL$export
SHALL$validate

Resource Conformance: supported Bundle

Base System Profile
Nigeria Immunization Bundle
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, create, update.

Documentation

Used by clients for bulk data sync or submission, e.g. client + doses + allergy info.

  • POST: Create and submit new bundled data.
  • PUT: Replace an existing bundle submission.
  • PATCH is not supported for bundles.
Search Parameters
ConformanceParameterTypeDocumentation
SHALLtypetoken
SHALLtimestampdate
SHALLidentifiertoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$submit
SHALL$export
SHALL$validate

Operations

Use