NPHCDA Immunization FHIR IG
0.9.0 - ci-build
NPHCDA Immunization FHIR IG
0.9.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 0.9.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
| Official URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-imm-provenance | Version: 0.9.0 | |||
| Draft as of 2026-10-07 | Computable Name: NgImmProvenance | |||
A Provenance profile tailored for Nigeria’s Immunization workflows (using FHIR R4.0.1). Captures the origin, responsible party, and context for the creation, modification, or exchange of immunization-related records, including Immunization, AEFI, Defaulter Tracing, and related patient data.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..* | Reference(NG-Imm Immunization | NG-Imm AllergyIntolerance | IMMZ.C.5 Bundle Client Registration | NG-Imm Patient | IMMZ.A Bundle Register Facility | IMMZ.C6 Bundle Update Client | IMMZ.E Bundle ManageReportAEFI | IMMZ.H Bundle GenerateReport) | The record(s) this provenance statement is about | |
  occurred[x] |
0..1 | When the activity occurred | ||
  occurredPeriod |
Period | |||
 occurredDateTime |
dateTime | |||
| recorded |
1..1 | instant | Date/time the event was recorded | |
| policy |
0..* | uri | Policies governing the activity | |
| location |
0..1 | Reference(NG-Imm Location) | Where the activity occurred | |
| reason |
0..* | CodeableConcept | Reason for the action Binding: PurposeOfUse (extensible) | |
| activity |
1..1 | CodeableConcept | Activity that generated or changed the record Binding: ProvenanceActivityType (extensible) | |
| agent |
1..* | BackboneElement | Who was involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
0..* | CodeableConcept | Role of the agent Binding: ParticipationRoleType (extensible) | |
| who |
1..1 | Reference(NG-Imm Practitioner | NG-Imm PractitionerRole | NG-Imm Organization) | practitioner, practitionerRole, or organization responsible | |
| entity |
0..* | BackboneElement | An entity used in this activity | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | code | How the entity was used Binding: ProvenanceEntityRole (required) | |
| what |
1..1 | Reference(DocumentReference | Media | QuestionnaireResponse | Binary) | Source material | |
| signature |
0..* | Signature | Digital signature | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(NG-Imm Immunization | NG-Imm AllergyIntolerance | IMMZ.C.5 Bundle Client Registration | NG-Imm Patient | IMMZ.A Bundle Register Facility | IMMZ.C6 Bundle Update Client | IMMZ.E Bundle ManageReportAEFI | IMMZ.H Bundle GenerateReport) | The record(s) this provenance statement is about | |||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
1..1 | instant | Date/time the event was recorded | |||||
| policy |
0..* | uri | Policies governing the activity | |||||
| location |
0..1 | Reference(NG-Imm Location) | Where the activity occurred | |||||
| reason |
0..* | CodeableConcept | Reason for the action Binding: PurposeOfUse (extensible) | |||||
| activity |
1..1 | CodeableConcept | Activity that generated or changed the record Binding: ProvenanceActivityType (extensible) | |||||
| agent |
1..* | BackboneElement | Who was involved | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |||||
| role |
0..* | CodeableConcept | Role of the agent Binding: ParticipationRoleType (extensible) | |||||
| who |
1..1 | Reference(NG-Imm Practitioner | NG-Imm PractitionerRole | NG-Imm Organization) | practitioner, practitionerRole, or organization responsible | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | code | How the entity was used Binding: ProvenanceEntityRole (required) | |||||
| what |
1..1 | Reference(DocumentReference | Media | QuestionnaireResponse | Binary) | Source material | |||||
 agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Digital signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Summary
Mandatory: 1 element
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..* | Reference(NG-Imm Immunization | NG-Imm AllergyIntolerance | IMMZ.C.5 Bundle Client Registration | NG-Imm Patient | IMMZ.A Bundle Register Facility | IMMZ.C6 Bundle Update Client | IMMZ.E Bundle ManageReportAEFI | IMMZ.H Bundle GenerateReport) | The record(s) this provenance statement is about | |
| occurred[x] |
0..1 | When the activity occurred | ||
| occurredPeriod |
Period | |||
| occurredDateTime |
dateTime | |||
| recorded |
1..1 | instant | Date/time the event was recorded | |
| policy |
0..* | uri | Policies governing the activity | |
| location |
0..1 | Reference(NG-Imm Location) | Where the activity occurred | |
| reason |
0..* | CodeableConcept | Reason for the action Binding: PurposeOfUse (extensible) | |
| activity |
1..1 | CodeableConcept | Activity that generated or changed the record Binding: ProvenanceActivityType (extensible) | |
| agent |
1..* | BackboneElement | Who was involved | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
0..* | CodeableConcept | Role of the agent Binding: ParticipationRoleType (extensible) | |
| who |
1..1 | Reference(NG-Imm Practitioner | NG-Imm PractitionerRole | NG-Imm Organization) | practitioner, practitionerRole, or organization responsible | |
| entity |
0..* | BackboneElement | An entity used in this activity | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | code | How the entity was used Binding: ProvenanceEntityRole (required) | |
| what |
1..1 | Reference(DocumentReference | Media | QuestionnaireResponse | Binary) | Source material | |
| signature |
0..* | Signature | Digital signature | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Provenance
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(NG-Imm Immunization | NG-Imm AllergyIntolerance | IMMZ.C.5 Bundle Client Registration | NG-Imm Patient | IMMZ.A Bundle Register Facility | IMMZ.C6 Bundle Update Client | IMMZ.E Bundle ManageReportAEFI | IMMZ.H Bundle GenerateReport) | The record(s) this provenance statement is about | |||||
| occurred[x] |
0..1 | When the activity occurred | ||||||
| occurredPeriod |
Period | |||||||
| occurredDateTime |
dateTime | |||||||
| recorded |
1..1 | instant | Date/time the event was recorded | |||||
| policy |
0..* | uri | Policies governing the activity | |||||
| location |
0..1 | Reference(NG-Imm Location) | Where the activity occurred | |||||
| reason |
0..* | CodeableConcept | Reason for the action Binding: PurposeOfUse (extensible) | |||||
| activity |
1..1 | CodeableConcept | Activity that generated or changed the record Binding: ProvenanceActivityType (extensible) | |||||
| agent |
1..* | BackboneElement | Who was involved | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | |||||
| role |
0..* | CodeableConcept | Role of the agent Binding: ParticipationRoleType (extensible) | |||||
| who |
1..1 | Reference(NG-Imm Practitioner | NG-Imm PractitionerRole | NG-Imm Organization) | practitioner, practitionerRole, or organization responsible | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity |
0..* | BackboneElement | An entity used in this activity | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | code | How the entity was used Binding: ProvenanceEntityRole (required) | |||||
| what |
1..1 | Reference(DocumentReference | Media | QuestionnaireResponse | Binary) | Source material | |||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Digital signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.4 |
| Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std. |
| Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | extensible | ParticipationRoleType | 📦4.0.1 | FHIR Std. |
| Provenance.entity.role | Base | required | ProvenanceEntityRole | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Provenance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Provenance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Provenance
Summary
Mandatory: 1 element
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron