C-CDA on FHIR
1.2.0-ballot - CI Build United States of America flag

This page is part of the C-CDA on FHIR Implementation Guide (v1.2.0-ballot: STU 1 Ballot 4) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

C-CDA to FHIR Immunizations

This page provides a mapping from CDA to FHIR. For the FHIR to CDA mapping, please refer to Immunizations FHIR → CDA. For guidance on how to read the table below, see Reading the C-CDA ↔ FHIR Mapping Pages



C-CDA to FHIR

C-CDA¹
Immunization Activity substanceAdministration		 FHIR
Immunization		 Transform Steps
@negationInd=”true” set status=”not-done”  
/id identifier CDA id ↔ FHIR identifier
/statusCode status CDA statusCode → FHIR status
/effectiveTime occurrenceDateTime CDA ↔ FHIR Time/Dates
/repeatNumber protocolApplied.doseNumberPositiveInt  
/routeCode route CDA coding ↔ FHIR CodeableConcept
/approachSiteCode .site FHIR site → CDA approachSiteCode
/doseQuantity doseQuantity  
/consumable/manufacturedProduct/manufacturedMaterial/code .vaccineCode CDA coding ↔ FHIR CodeableConcept
/consumable/manufacturedMaterial/lotNumberText .lotNumber  
/author Provenance CDA ↔ FHIR Provenance
/performer .performer
&
set performer.function="AP"		  
Immunization Refusal Reason
entryRelationship@typeCode="RSON"
/entryRelationship/observation/code		 statusReason CDA refusal → FHIR statusReason
Comment Activity
entryRelationship/act/code@code="48767-8"
/entryRelationship/act/text		 Annotation
.note		  
Reaction
entryRelationship@typeCode="MFST"
/entryRelationship/observation		 .reaction It is recommended that reaction observation value be mapped to reaction detail (Observation) valueCodeable concept. Comments are welcome on how this may be best implemented.

1. XPath abbrievated for C-CDA Immunization Activity as:
ClinicalDocument/component/structuredBody/component/section[(@code="11369-6")]/entry/substanceAdministration

Illustrative example

An illustrative example with higlighting is shown above based on the consensus of mapping and guidance. Not all possible elements in CDA or FHIR may be represented. To access the content for the above example, click on the links below.


Links to example content

The consensus mapping example developed through multiple vendors are available below:

Prior work and Expanded Spreadsheets

As reviewed in the methodology, a more comprehensive review was performed via spreadsheets. These spreadsheets have been consolidated and further revised in the tables above but are provided for reference here