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
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
.
Raw OpenAPI-Swagger Definition file | Download
xml
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.
client
Client systems consuming NG-IMM immunization APIs must support reading, creating, updating, and transforming immunization-related resources via REST and custom operations.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | P | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
Patient | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient | y | y | y | y | y | identifier, firstname, lastname, birthdate, gender, state | $submit , $export , $validate | ||
Immunization | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmImmunization | y | y | y | y | y | patient, status, vaccine-code, date | $submit , $export , $validate | ||
Bundle | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmBundle | y | y | y | y | type, timestamp, identifier | $submit , $export , $validate |
read
, search-type
, create
, update
, patch
.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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | |
SHALL | firstname | string | |
SHALL | lastname | string | |
SHALL | birthdate | date | |
SHALL | gender | token | |
SHALL | state | token |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $submit | |
SHALL | $export | |
SHALL | $validate |
read
, search-type
, create
, update
, patch
.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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | |
SHALL | status | token | |
SHALL | vaccine-code | token | |
SHALL | date | date |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $submit | |
SHALL | $export | |
SHALL | $validate |
read
, search-type
, create
, update
.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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | type | token | |
SHALL | timestamp | date | |
SHALL | identifier | token |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $submit | |
SHALL | $export | |
SHALL | $validate |