This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.1: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Mappings for the DDCCImmunization resource profile.
DDCCImmunization |
Immunization | VXU_V04 |
vaccineCode | CE/CNE/CWE |
coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
patient | PID-3 |
encounter | PV1-19 |
occurrence[x] | RXA-3 |
primarySource | RXA-9 |
reportOrigin | RXA-9 |
location | RXA-27 (or RXA-11, deprecated as of v2.7) |
manufacturer | RXA-17 |
lotNumber | RXA-15 |
expirationDate | RXA-16 |
site | CE/CNE/CWE |
route | CE/CNE/CWE |
doseQuantity | RXA-6 / RXA-7 |
performer | ORC-12 / RXA-10 |
note | OBX-5 : OBX-3 = 48767-8 |
isSubpotent | RXA-20 = PA (partial administration) |
education | |
documentType | OBX-5 : OBX-3 = 69764-9 |
publicationDate | OBX-5 : OBX-3 = 29768-9 |
presentationDate | OBX-5 : OBX-3 = 29769-7 |
programEligibility | OBX-5 : OBX-3 = 64994-7 |
reaction | OBX-3 |
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) |
detail | OBX-5 |
reported | (HL7 v2 doesn't seem to provide for this) |
DDCCImmunization |
Immunization | Entity. Role, or Act, SubstanceAdministration |
text | Act.text? |
contained | N/A |
modifierExtension | N/A |
identifier | .id |
status | statusCode |
statusReason | .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde |
vaccineCode | n/a, CD |
id | n/a |
extension | n/a |
coding | n/a, CV |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
extension (translation) | ST.translation |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
patient | .partipication[ttypeCode=].role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
encounter | component->EncounterEvent |
occurrence[x] | .effectiveTime |
id | n/a |
extension | n/a |
extension (data-absent-reason) | ANY.nullFlavor |
recorded | .participation[typeCode=AUT].time |
primarySource | immunization.uncertaintycode (if primary source=false, uncertainty=U) |
reportOrigin | .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) |
location | .participation[typeCode=LOC].COCT_MT240000UV |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
manufacturer | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] |
lotNumber | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id |
expirationDate | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime |
site | n/a, CD |
route | n/a, CD |
doseQuantity | .doseQuantity |
performer | .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
function | .participation.functionCode |
actor | .player |
note | note |
reasonCode | [actionNegationInd=false].reasonCode |
reasonReference | N/A |
isSubpotent | N/A |
subpotentReason | N/A |
education | N/A |
id | n/a |
extension | n/a |
modifierExtension | N/A |
documentType | N/A |
reference | N/A |
publicationDate | N/A |
presentationDate | N/A |
programEligibility | N/A |
fundingSource | N/A |
reaction | Observation[classCode=obs].code |
id | n/a |
extension | n/a |
modifierExtension | N/A |
date | .effectiveTime |
detail | .value |
reported | .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true) |
protocolApplied | N/A |
id | n/a |
extension | n/a |
modifierExtension | N/A |
series | N/A |
authority | N/A |
targetDisease | N/A |
doseNumber[x] | N/A |
seriesDoses[x] | N/A |
protocolApplied (protocolAppliedAuthority) | N/A |
id | n/a |
extension | n/a |
modifierExtension | N/A |
series | N/A |
authority | N/A |
targetDisease | N/A |
doseNumber[x] | N/A |
seriesDoses[x] | N/A |