HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR
1.0.0 - STU 1
HL7 Version 2 to FHIR, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2-to-fhir/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/v2mappings/ConceptMap/segment-rxa-to-immunization | Version: 1.0.0 | |||
| Standards status: Informative | Computable Name: SegmentRXAToImmunization | |||
Copyright/Legal: Copyright (c) 2025, HL7 International, Inc., All Rights Reserved. |
||||
This ConceptMap represents a mapping from the HL7 V2 Segment RXA to the FHIR Immunization Resource.
This ConceptMap represents the mapping from the HL7 V2 RXA Segment to the FHIR Immunization Resource. See also the FHIR Shorthand or the CSV Source.
| HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary Mapping (IS, ID, CE, CEN, CWE) | Assignment | |
| 1 | RXA-1 | Give Sub-ID Counter | NM | 1 | 1 | ||||||||||||
| 2 | RXA-2 | Administration Sub-ID Counter | NM | 1 | 1 | ||||||||||||
| 3 | RXA-3 | Date/Time Start of Administration | DTM | 1 | 1 | Immunization.occurrenceDateTime | dateTime | 1 | 1 | ||||||||
| 4 | RXA-4 | Date/Time End of Administration | DTM | 1 | 1 | ||||||||||||
| 5 | RXA-5 | Administered Code | CWE | 1 | 1 | Immunization.vaccineCode | CodeableConcept | 1 | 1 | CWE[CodeableConcept] | |||||||
| 6 | RXA-6 | Administered Amount | NM | 1 | 1 | Immunization.doseQuantity.value | decimal | 0 | 1 | ||||||||
| 7 | RXA-7 | Administered Units | CWE | 0 | 1 | Immunization.doseQuantity | SimpleQuantity | 0 | 1 | CWE[Quantity] | |||||||
| 8 | RXA-8 | Administered Dosage Form | CWE | 0 | 1 | ||||||||||||
| 9 | RXA-9 | Administration Notes | CWE | 0 | -1 | In the US, the CDC Immunization Implementation Guide would map this to Immunizaiton.reportOrigin. Other realms may do this differently. Therefore, we will leave this for implementation guides to resolve. | |||||||||||
| 10 | RXA-10 | Administering Provider | XCN | 0 | -1 | Immunization.performer.actor(Immunization.Practitioner) | Reference(Immunization.Practitioner) | 0 | -1 | XCN[Practitioner] | |||||||
| 10 | RXA-10 | Administering Provider | XCN | 0 | -1 | Immunization.performer.function.coding.code | code | "AP" | |||||||||
| 10 | RXA-10 | Administering Provider | XCN | 0 | -1 | Immunization.performer.function.coding.system | uri | "http://terminology.hl7.org/CodeSystem/v2-0443" | |||||||||
| 11 | RXA-11 | Administered-at Location | LA2 | 0 | 1 | ||||||||||||
| 12 | RXA-12 | Administered Per (Time Unit) | ST | 0 | 1 | ||||||||||||
| 13 | RXA-13 | Administered Strength | NM | 0 | 1 | ||||||||||||
| 14 | RXA-14 | Administered Strength Units | CWE | 0 | 1 | ||||||||||||
| 15 | RXA-15 | Substance Lot Number | ST | 0 | -1 | Immunization.lotNumber | string | 0 | 1 | ||||||||
| 16 | RXA-16 | Substance Expiration Date | DTM | 0 | -1 | Immunization.expirationDate | date | 0 | 1 | ||||||||
| 17 | RXA-17 | Substance Manufacturer Name | CWE | 0 | -1 | Immunization.manufacturer(Immunization.Organization) | Reference(Immunization.Organization) | 0 | 1 | CWE[Organization] | |||||||
| 18 | RXA-18 | Substance/Treatment Refusal Reason | CWE | 0 | -1 | Immunization.statusReason | CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||
| 19 | RXA-19 | Indication | CWE | 0 | -1 | Immunization.reasonCode | CodeableConcept | 0 | -1 | CWE[CodeableConcept] | |||||||
| 20 | RXA-20 | Completion Status | ID | 0 | 1 | IF RXA-21 NOT EQUALS "D" | Immunization.status | code | 1 | 1 | CompletionStatus | ||||||
| 20 | RXA-20 | Completion Status | ID | 0 | 1 | IF NOT VALUED AND RXA-21 NOT EQUALS "D" | Immunization.status | code | 1 | 1 | "completed" | ||||||
| 21 | RXA-21 | Action Code – RXA | ID | 0 | 1 | IF RXA-21 EQUALS "D" | Immunization.status | code | 1 | 1 | "entered-in-error" | ||||||
| 22 | RXA-22 | System Entry Date/Time | DTM | 0 | 1 | IF RXA-21 EQUALS "A" | Immunization.recorded | dateTime | 0 | 1 | |||||||
| 23 | RXA-23 | Administered Drug Strength Volume | NM | 0 | 1 | ||||||||||||
| 24 | RXA-24 | Administered Drug Strength Volume Units | CWE | 0 | 1 | ||||||||||||
| 25 | RXA-25 | Administered Barcode Identifier | CWE | 0 | 1 | ||||||||||||
| 26 | RXA-26 | Pharmacy Order Type | ID | 0 | 1 | ||||||||||||
| 27 | RXA-27 | Administer-at | PL | 0 | 1 | Immunization.location(Immunization.Location) | Reference(Immunization.Location) | 0 | 1 | PL[Location] | |||||||
| 28 | RXA-28 | Administered-at Address | XAD | 0 | 1 | Immunization.location(Immunization.Location.address) | Address | 0 | 1 | XAD[Address] | |||||||
| 29 | RXA-29 | Administered Tag Identifier | EI | 0 | -1 | ||||||||||||
Mapping from (not specified) to (not specified)
Group 1 Mapping from unspecified code system to unspecified code system
| Source Concept Details | Relationship | Target Concept Details | |||
| Codes from | ComputableANTLR | Codes from | |||
| RXA-3 | Date/Time Start of Administration | is equivalent to | occurrenceDateTime | occurrenceDateTime | |
| RXA-5 | Administered Code | is equivalent to | vaccineCode | vaccineCode | |
| RXA-6 | Administered Amount | is equivalent to | doseQuantity.value | doseQuantity.value | |
| RXA-7 | Administered Units | is equivalent to | doseQuantity | doseQuantity | |
| RXA-10 | Administering Provider | is equivalent to | performer.actor(Practitioner) | performer.actor(Practitioner) | |
| RXA-10 | Administering Provider | is equivalent to | performer.function.coding.code | performer.function.coding.code | |
| RXA-10 | Administering Provider | is equivalent to | performer.function.coding.system | performer.function.coding.system | |
| RXA-15 | Substance Lot Number | is equivalent to | lotNumber | lotNumber | |
| RXA-16 | Substance Expiration Date | is equivalent to | expirationDate | expirationDate | |
| RXA-17 | Substance Manufacturer Name | is equivalent to | manufacturer(Organization) | manufacturer(Organization) | |
| RXA-18 | Substance/Treatment Refusal Reason | is equivalent to | statusReason | statusReason | |
| RXA-19 | Indication | is equivalent to | reasonCode | reasonCode | |
| RXA-20 | Completion Status | IF RXA-21 NOT EQUALS "D" | is equivalent to | status | status |
| RXA-20 | Completion Status | IF NOT VALUED AND RXA-21 NOT EQUALS "D" | is equivalent to | status | status |
| RXA-21 | Action Code – RXA | IF RXA-21 EQUALS "D" | is equivalent to | status | status |
| RXA-22 | System Entry Date/Time | IF RXA-21 EQUALS "A" | is equivalent to | recorded | recorded |
| RXA-27 | Administer-at | is equivalent to | location[1](Location) | location[1](Location) | |
| RXA-28 | Administered-at Address | is equivalent to | location[1](Location.address) | location[1](Location.address) | |
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0 based on FHIR 4.0.1. Generated 2025-09-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change