This page is part of the HL7 Version 2 to FHIR (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Segment Maps

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 MessageHeader
• MSH - Message Header to FHIR Provenance
• NTE - Notes and Comments to FHIR Observation
• NTE - Notes and Comments to FHIR ServiceRequest
• 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
• 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
• PID - Patient Identification to FHIR Account
• PID - Patient Identification to FHIR Patient
• PID[EthnicGroup] - Patient Identification to FHIR Observation
• PID[Mother] - Patient Identification to FHIR RelatedPerson
• PID[Race] - Patient Identification to FHIR Observation
• PV1 - Patient Visit to FHIR Encounter
• PV1 - Patient Visit to FHIR Patient
• PV2 - Patient Visit - Additional Information to FHIR Encounter

Chapter 4 Order Entry

• OBR - Observation Request to FHIR DiagnosticReport
• OBR - Observation Request to FHIR ServiceRequest
• ORC - Common Order to FHIR DiagnosticReport
• ORC - Common Order to FHIR Immunization
• ORC - Common Order to FHIR Provenance
• ORC - Common Order to FHIR ServiceRequest

Chapter 4A Order Entry: Pharmacy/Treatment, Vaccination

• RXA - Pharmacy/Treatment Administration to FHIR Immunization
• RXR - Pharmacy/Treatment Route to FHIR Immunization

Chapter 6 Financial Management

• DG1 - Diagnosis to FHIR Condition
• DG1 - Diagnosis to FHIR Encounter
• DG1 - Diagnosis to FHIR EpisodeOfCare
• PR1 - Procedures to FHIR Procedure

Chapter 7 Observation Reporting

• OBX - Observation/Result to FHIR Observation
• OBX[Component] - Observation/Result to FHIR Observation
• PRT - Participation Information to FHIR Device
• PRT - Participation Information to FHIR PractitionerRole
• PRT - Participation Information to FHIR RelatedPerson
• PRT[Location] - Participation Information to FHIR Observation
• SPM - Specimen to FHIR Specimen

Chapter 15 Personnel Management

• ROL - Role to FHIR RelatedPerson
• ROL[PractitionerRole] - Role to FHIR Encounter
• ROL[PractitionerRole] - Role to FHIR Patient

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” this cell will be set to “Implied”.
  • 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 second column reflects a proposed extension. It will be expressed with #ext-……# around the proposed name. Once approved, the formal name 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.
  • 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. Note these can be combined if multiple values need to be concatenated together.