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

Resource Profile: NgImmImmunization - Mappings

Draft as of 2026-10-07

Mappings for the NgImmImmunization resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternHL7 v2 MappingRIM MappingFiveWs Pattern MappingCDA (R2)doco
Immunization
Event
VXU_V04
SubstanceAdministration
Immunization / id
Immunization / meta
Immunization / implicitRules
Immunization / language
Immunization / text
Act.text?
Immunization / contained
N/A
Immunization / Slices for extension
Immunization / Slices for extension / extension:contraindications
Immunization / Slices for extension / extension:contraindicated
Immunization / modifierExtension
N/A
Immunization / identifier
Event.identifier
.id
FiveWs.identifier
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
Immunization / status
Event.status
statusCode
FiveWs.status
Immunization / statusReason
Event.statusReason
  • .inboundRelationship[typeCode=SUBJ].source[classCode=CACT
  • moodCode=EVN].reasonCOde
Immunization / vaccineCode
Event.code
RXA-5
.code
FiveWs.what[x]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
Immunization / patient
Event.subject
PID-3
.partipication[ttypeCode=].role
FiveWs.subject
Immunization / encounter
Event.context
PV1-19
component->EncounterEvent
FiveWs.context
Immunization / occurrence[x]
Event.occurrence[x]
RXA-3
.effectiveTime
FiveWs.done[x]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
Immunization / recorded
.participation[typeCode=AUT].time
FiveWs.recorded
Immunization / primarySource
RXA-9
  • immunization.uncertaintycode (if primary source=false
  • uncertainty=U)
FiveWs.source
Immunization / reportOrigin
RXA-9
.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)
FiveWs.source
Immunization / location
Event.location
  • RXA-27 (or RXA-11
  • deprecated as of v2.7)
.participation[typeCode=LOC].COCT_MT240000UV
FiveWs.where[x]
Immunization / manufacturer
RXA-17
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
Immunization / lotNumber
RXA-15
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
Immunization / expirationDate
RXA-16
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
Immunization / site
RXR-2
observation.targetSiteCode
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
Immunization / route
RXR-1
.routeCode
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
Immunization / doseQuantity
RXA-6 / RXA-7
.doseQuantity
Immunization / performer
Event.performer
ORC-12 / RXA-10
.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
Immunization / performer / id
n/a
Immunization / performer / extension
n/a
Immunization / performer / modifierExtension
N/A
Immunization / performer / function
Event.performer.function
.participation.functionCode
Immunization / performer / actor
Event.performer.actor
.player
FiveWs.actor
Immunization / note
Event.note
OBX-3 = 48767-8
note
Immunization / reasonCode
Event.reasonCode
[actionNegationInd=false].reasonCode
Immunization / reasonReference
Event.reasonReference
N/A
Immunization / isSubpotent
RXA-20 = PA (partial administration)
N/A
Immunization / subpotentReason
N/A
Immunization / education
N/A
Immunization / education / id
n/a
Immunization / education / extension
n/a
Immunization / education / modifierExtension
N/A
Immunization / education / documentType
OBX-3 = 69764-9
N/A
Immunization / education / reference
N/A
Immunization / education / publicationDate
OBX-3 = 29768-9
N/A
Immunization / education / presentationDate
OBX-3 = 29769-7
N/A
Immunization / programEligibility
OBX-3 = 64994-7
N/A
Immunization / fundingSource
N/A
Immunization / reaction
OBX-3
Observation[classCode=obs].code
Immunization / reaction / id
n/a
Immunization / reaction / extension
n/a
Immunization / reaction / modifierExtension
N/A
Immunization / reaction / date
  • OBX-14 (ideally this would be reported in an IAM segment
  • but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
.effectiveTime
Immunization / reaction / detail
OBX-5
.value
Immunization / reaction / reported
(HL7 v2 doesn't seem to provide for this)
.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
Immunization / protocolApplied
N/A
Immunization / protocolApplied / id
n/a
Immunization / protocolApplied / Slices for extension
Immunization / protocolApplied / Slices for extension / extension:nextDoseDate
Immunization / protocolApplied / modifierExtension
N/A
Immunization / protocolApplied / series
N/A
Immunization / protocolApplied / authority
N/A
Immunization / protocolApplied / targetDisease
N/A
Immunization / protocolApplied / doseNumber[x]
N/A
Immunization / protocolApplied / seriesDoses[x]
N/A

doco Documentation for this format