HL7 Version 2 to FHIR
1.0.0 - STU 1

HL7 Version 2 to FHIR - Downloaded Version 1.0.0 See the Directory of published versions

## Segment Maps

Page standards status: Informative

The sections below list the segment mappings defined by this guide. Segment Mapping is driven by CSV files with specific columns. The use of these columns is described in the section on mapping at the bottom of this page.

### Chapter 2 Control

- MSA - Message Acknowledgment to FHIR MessageHeader
- MSH - Message Header to FHIR Bundle
- MSH - Message Header to FHIR Encounter
- MSH - Message Header to FHIR MessageHeader
- MSH[Operator] - Message Header to FHIR Provenance
- MSH[Source] - Message Header to FHIR Provenance
- MSH[Transformation] - Message Header to FHIR Provenance
- NTE - Notes and Comments to FHIR DocumentReference
- NTE - Notes and Comments to FHIR Observation
- NTE - Notes and Comments to FHIR ServiceRequest
- NTE[Comment] - Notes and Comments to FHIR Appointment
- SFT - Software Segment to FHIR Device
- SFT - Software Segment to FHIR MessageHeader

### Chapter 3 Patient Administration

- AL1 - Patient Allergy Information to FHIR AllergyIntolerance
- EVN - Event Type to FHIR Provenance
- IAM - Patient Adverse Reaction Information to FHIR AllergyIntolerance
- MRG - Merge Patient Information to FHIR Account
- NK1 - Next of Kin / Associated Parties to FHIR Patient
- NK1 - Next of Kin / Associated Parties to FHIR RelatedPerson
- PD1 - Patient Additional Demographic to FHIR Patient
- PD1[LivingWill] - Patient Additional Demographic to FHIR Observation
- PID - Patient Identification to FHIR Account
- PID - Patient Identification to FHIR Appointment
- PID - Patient Identification to FHIR Patient
- PID[Patient] - Patient Identification to FHIR Provenance
- PV1 - Patient Visit to FHIR Coverage
- PV1 - Patient Visit to FHIR Encounter
- PV1 - Patient Visit to FHIR Patient
- PV1[EncounterHistory] - Patient Visit to FHIR Basic
- PV2 - Patient Visit - Additional Information to FHIR Encounter

### Chapter 4 Order Entry

- OBR - Observation Request to FHIR DiagnosticReport
- OBR - Observation Request to FHIR ServiceRequest
- OBR - Observation Request to FHIR Specimen
- ORC - Common Order to FHIR DiagnosticReport
- ORC - Common Order to FHIR Immunization
- ORC - Common Order to FHIR MedicationAdministration
- ORC - Common Order to FHIR Provenance
- ORC - Common Order to FHIR ServiceRequest
- TQ1 - Timing/Quantity to FHIR MedicationRequest
- TQ1 - Timing/Quantity to FHIR ServiceRequest

### Chapter 4A Order Entry: Pharmacy/Treatment, Vaccination

- RXA - Pharmacy/Treatment Administration to FHIR Immunization
- RXO - Pharmacy/Treatment Order to FHIR MedicationRequest
- RXR - Pharmacy/Treatment Route to FHIR Immunization
- RXR - Pharmacy/Treatment Route to FHIR MedicationRequest

### Chapter 6 Financial Management

- DG1 - Diagnosis to FHIR Condition
- DG1 - Diagnosis to FHIR Encounter
- DG1 - Diagnosis to FHIR EpisodeOfCare
- IN1 - Insurance to FHIR Coverage
- IN3 - Insurance Additional Information, Certification to FHIR CareTeam
- PR1 - Procedures to FHIR Procedure

### Chapter 7 Observation Reporting

- OBX - Observation/Result to FHIR DocumentReference
- OBX - Observation/Result to FHIR Observation
- OBX[Component] - Observation/Result to FHIR Observation
- PRT - Participation Information to FHIR CareTeam
- PRT - Participation Information to FHIR Device
- PRT - Participation Information to FHIR PractitionerRole
- PRT - Participation Information to FHIR RelatedPerson
- PRT[GeneralPractitioner-PractitionerRole] - Participation Information to FHIR Patient
- PRT[GeneralPractitioner-Practitioner] - Participation Information to FHIR Patient
- PRT[Location] - Participation Information to FHIR Observation
- SPM - Specimen to FHIR Specimen

### Chapter 9 Medical Records/Information Management

- TXA - Transcription Document Header to FHIR DocumentReference
- TXA - Transcription Document Header to FHIR Provenance

### Chapter 10 Scheduling

- AIG - Appointment Information - General Resource to FHIR Appointment
- AIL - Appointment Information - Location Resource to FHIR Appointment
- AIP - Appointment Information - Personnel Resource to FHIR Appointment
- AIS - Appointment Information to FHIR Appointment
- AIS - Appointment Information to FHIR ServiceRequest
- SCH - Scheduling Activity Information to FHIR Appointment
- SCH - Scheduling Activity Information to FHIR Provenance
- SCH - Scheduling Activity Information to FHIR ServiceRequest

### Chapter 15 Personnel Management

- ROL - Role to FHIR CareTeam
- ROL - Role to FHIR RelatedPerson
- ROL[GeneralPractitioner] - Role to FHIR Patient
- ROL[PractitionerRole] - Role to FHIR Encounter

## Mapping

- HL7 v2
  - Sort Order
    - See the General Guidelines
    - If a FHIR attribute is required but there is no v2 element to map from, the sort order is "0".
  - Identifier
    - Contains the formal Segment Name and Field Sequence according to the base standard using "-" as the delimiter.
    - If the Sort Order is “0” the HL7 FHIR element listed in the HL7 FHIR column needs to be updated according to the rest of the mapping instructions in the HL7 FHIR columns, typically an assignment. For example, when OBR is mapped to ServiceRequest, ServiceRequest.intent will always need to be set to "order". There is no specific OBR field that containts the correct value.
  - Name
    - The formal name of the field in the most current published version
  - Data Type
    - The data type of the field in the most current published version if not deprecated
    - Otherwise it is the data type at the time it was deprecated and removed.
  - Cardinality (Min and Max)
    - The cardinality in the most current published version expressed numerically if not deprecated
    - Otherwise it reflects the cardinality at the time it was deprecated and removed.
- Condition
  - See the General Guidelines
- HL7 FHIR
  - FHIR Attribute
    - The first column reflects an existing FHIR attribute in the target FHIR version.
      - The full path to the attribute is derived from the source spreadsheets by combining the resource name in the spreadsheet name (e.g., Immunization in the HL7 Segment - FHIR R4: ORC[Immunization] spreadsheet with the attribute name in column J in the spreadsheet (e.g., identifier) yielindg "Immunization.identifier".
    - When there is not a single attribute to point to, rather a v2 field needs to be mapped to multiple FHIR attribute, e.g., ORC-27 Quantity/Timing where the TQ data type components need to be mapped to multiple ServiceRequest attributes, then the label "$this" is used. Further mapping guidance is then provided in the Data Type mapping column.
    - The second column reflects a proposed extension. It will be expressed with extension-[name] (when suggested as a full extension) or extension??-[name] (when it is open whether to include it in core and pre-adopt, or a full extension). Once approved, the full extension paths will be put in the first column.
    - This approach will enable tooling to already process existing FHIR attributes and not have to create special handling for elements still being proposed.
  - Data Type
    - The FHIR attribute's data type in the target FHIR version.
  - Cardinality (Min and Max)
    - The FHIR attribute's minimum and maximum cardinality in the target FHIR version.
  - Data Type Mapping
    - The URL to the Data Type Map that is to be used for the attribute in this segment.
    - There may be multiple flavors of the data type maps to support different mappings. The flavor is appended to the end of the data type name using [] brackets, e.g., CWE[Coding].
  - Vocabulary Mapping
    - The URL to the Vocabulary Map that is to be used for the coded element for this attribute.
    - If the applicable HL7 v2 table is empty, e.g., user defined tables without examples, this cell will be blank.
    - This is used where the HL7 v2 data type is either CWE, CNE, CF, CE, ID, or IS while the HL7 FHIR data type is code, Coding, Codeable Concept, of boolean.
  - Assignment
    - The value that is to be assigned to the FHIR Attribute referenced.
      - If it is to be set to a particular string, it is uses "string".
      - If it is to be set to a value in a v2 element or FHIR attribute, the identifier for that element/attribute is stated, e.g., PID-3.1 or Patient.identifier.value.
      - If there is no specific string or variable that is to be used, then the instructions are included between // bars, e.g., /instructions/.
    - Note these can be combined if multiple values need to be concatenated together.