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 Server CapabilityStatement

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

This CapabilityStatement describes the expected behavior of FHIR servers implementing Nigeria’s Immunization Implementation Guide (NG-IMM).

It includes full RESTful support for key profiles (NgImmPatient, NgImmImmunization, and NgImmBundle) and logical model transformations. The server also supports data submission, export, and validation via custom operations, as well as tracking updates through Provenance.

Use of HTTP Methods:

  • POST: Used to create a new resource. The server assigns the resource ID.
  • PUT: Used to fully replace an existing resource identified by a known ID.
  • PATCH: Used for partial updates to existing resources.

Provenance:

Clients MUST include a Provenance resource when performing GET, PUT, or PATCH on Server Resources (NgImmPatient, NgImmImmunization, and NgImmBundle) to ensure traceability and support audit trails.

Raw OpenAPI-Swagger Definition file | Download

NG-Imm Server 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: server

The server supports RESTful create, read, update, and search for immunization-related records using the Nigeria Immunization Implementation Guide (NG-IMM).

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
Provenance yyytarget

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

The NgImmPatient profile is used for managing client demographic data.

  • POST: Creates a new patient record.
  • PUT: Replaces an existing patient record.
  • PATCH: Updates specific fields.

Clients MUST include a corresponding Provenance resource with updates for audit and traceability.

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

The NgImmImmunization profile is used to record administered vaccine doses.

  • POST: Submits a new immunization event.
  • PUT: Replaces an existing record, e.g. to correct a mistake.
  • PATCH: Updates specific fields such as status or encounter.

Provenance SHOULD be included for automated or third-party updates.

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

The NgImmBundle profile is used to group Patient, Immunization, and related resources into a single package.

  • POST: Submits a new Bundle (e.g. during mobile sync).
  • PUT: Replaces the entire bundle for corrected batch uploads.

PATCH is not supported on Bundles.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtypetoken
SHALLtimestampdate
SHALLidentifiertoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$submit
SHALL$export
SHALL$validate

Resource Conformance: supported Provenance

Core FHIR Resource
Provenance
Reference Policy
Interaction summary
  • Supports create, read, search-type.

Documentation

Used to track and audit updates made to Patient or Immunization resources. Clients are expected to include this when submitting PUT or PATCH requests for sensitive records.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtargetreference
 

Operations

Use