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

Resource Profile: NG-Imm Provenance

Official URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-imm-provenance Version: 0.7.0
Draft as of 2025-10-27 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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 SΣ 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
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Date/time the event was recorded
... policy S 0..* uri Policies governing the activity
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 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 S 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 S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v6.5
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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 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 Period, dateTime When the activity occurred
... recorded S 1..1 instant Date/time the event was recorded
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 1..* BackboneElement Who was involved
.... 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 S 0..* BackboneElement An entity used in this activity
.... role 1..1 code How the entity was used
Binding: ProvenanceEntityRole (required)
.... what 1..1 Reference(DocumentReference | Media | QuestionnaireResponse | Binary) Source material
... signature S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v6.5
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.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 SΣ 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 SΣ 1..1 instant Date/time the event was recorded
... policy S 0..* uri Policies governing the activity
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 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 S 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 S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings

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 v6.5
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.

Constraints

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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 SΣ 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
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Date/time the event was recorded
... policy S 0..* uri Policies governing the activity
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 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 S 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 S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v6.5
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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 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 Period, dateTime When the activity occurred
... recorded S 1..1 instant Date/time the event was recorded
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 1..* BackboneElement Who was involved
.... 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 S 0..* BackboneElement An entity used in this activity
.... role 1..1 code How the entity was used
Binding: ProvenanceEntityRole (required)
.... what 1..1 Reference(DocumentReference | Media | QuestionnaireResponse | Binary) Source material
... signature S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.reason Base extensible PurposeOfUse 📦3.1.0 THO v6.5
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 SΣ 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 SΣ 1..1 instant Date/time the event was recorded
... policy S 0..* uri Policies governing the activity
... location S 0..1 Reference(NG-Imm Location) Where the activity occurred
... reason 0..* CodeableConcept Reason for the action
Binding: PurposeOfUse (extensible)
... activity S 1..1 CodeableConcept Activity that generated or changed the record
Binding: ProvenanceActivityType (extensible)
... agent S 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 S 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 S 0..* Signature Digital signature

doco Documentation for this format

Terminology Bindings

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 v6.5
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.

Constraints

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()

 

Other representations of profile: CSV, Excel, Schematron