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.
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
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 Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|
Patient | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient | | | | | identifier, firstname, lastname, birthdate, createddate, email_mobile, gender, pseudo-id | | | $submit-ngimm-patient |
Immunization | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmImmunization | | | | | patient, status, vaccine-code, date | | | $submit-ngimm-immunization |
Bundle | http://nphcda.gov.ng/ig/immunization/StructureDefinition/ngimm-client-registration-bundle | | | | | patient.identifier, _lastUpdated, vaccine-code, organization-identifier | | | $submit-ngimm-bundle |
Organization | http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-organization | | | | | organization-identifier | | | $submit-ngimm-organization |
Encounter | http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-encounter | | | | | encounter-identifier | | | $submit-ngimm-encounter |
RelatedPerson | http://nphcda.gov.ng/ig/immunization/StructureDefinition/mother-other-children | | | | | relatedperson-identifier | | | $submit-ngimm-relatedperson |
Practitioner | http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPractitioner | | | | | practitioner-identifier, license | | | $submit-ngimm-practitioner |
MeasureReport | http://nphcda.gov.ng/ig/immunization/StructureDefinition/measure-report-profile | | | | | measurereport-identifier | | | $submit-ngimm-measurereport |
Provenance | http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-provenance | | | | | provenance-identifier | | | |
StructureMap | http://hl7.org/fhir/StructureDefinition/StructureMap | | | | | | | | $transform |
Resource Conformance: supported Patient
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | identifier | token | |
SHALL | firstname | string | |
SHALL | lastname | string | |
SHALL | birthdate | date | |
SHALL | createddate | date | |
SHALL | email_mobile | string | |
SHALL | gender | token | |
SHALL | pseudo-id | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-patient | |
Resource Conformance: supported Immunization
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | patient | reference | |
SHALL | status | token | |
SHALL | vaccine-code | token | |
SHALL | date | date | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-immunization | |
Resource Conformance: supported Bundle
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | patient.identifier | token | |
SHALL | _lastUpdated | date | |
SHALL | vaccine-code | token | |
SHALL | organization-identifier | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-bundle | |
Resource Conformance: supported Organization
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | organization-identifier | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-organization | |
Resource Conformance: supported Encounter
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | encounter-identifier | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-encounter | |
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | relatedperson-identifier | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-relatedperson | |
Resource Conformance: supported Practitioner
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | practitioner-identifier | token | |
SHALL | license | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-practitioner | |
Resource Conformance: supported MeasureReport
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | measurereport-identifier | token | |
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $submit-ngimm-measurereport | |
Resource Conformance: supported Provenance
Profile Conformance
SHALL
Reference Policy
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | provenance-identifier | token | |
Resource Conformance: supported StructureMap
Profile Conformance
SHALL
Reference Policy
Extended OperationsConformance | Operation | Documentation |
---|
SHALL | $transform | |