HL7 Version 2 to FHIR
1.0.0-ballot - ballot International flag

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-ballot 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

V2 to FHIR

Official URL: http://hl7.org/fhir/uv/v2mappings/ImplementationGuide/hl7.fhir.uv.v2mappings Version: 1.0.0-ballot
Active as of 2023-12-20 Computable Name: HL7Version2toFHIR

Review Note:
The focus of this first HL7 v2-to-FHIR STU Ballot is on an initial set of messages, segments, data types, and vocabulary to establish the foundation on which to expand and cover the full range of HL7 v2 messages in actual use. The purpose is primarily to solicit feedback on the accuracy of the proposed mappings. Secondary is to solicit feedback on structure and navigation. Suggestions on additional messages, segments, data types, and vocabulary to prioritize supporting real-world use are welcome as well and should be marked as A-S in the ballot spreadsheet. Lastly, specific questions are provided [here](questions.html).

The following are known JIRAs waiting for resolution. Feedback and voting on these as part of the ballot can further guide appropriate resolution and inclusion:

  • [FHIR-33007] Aligning Appointment.servicetype and .basedOn
  • [FHIR-33036] Observation needs type and subtype extension
  • [FHIR-33037] Observation Location extension needed
  • [FHIR-33041] Clarify "in process" as part Observation.status="registered" or create a separate status
  • [FHIR-33042] Include Observation.status "appended"
  • [FHIR-33043] Clarify "not asked" as part Observation.status="final" or create a separate status
  • [FHIR-34194] Add businessEvent extension
  • [FHIR-43298] Attachment.data only supports binary64
  • [UPS-217] Add "sender-application" to http://terminology.hl7.org/CodeSystem/provenance-participant-type

The following have been resolved but were not applied, or need clarification that was not provided before this ballot round. We aim to still be applied before publication and would either be reviewed in a targeted peer review or as part of a ballot round if another is necessary before publication.
  • [FHIR-33038] Observation needs a subID extension
  • [FHIR-33077] Add "sender" as a Provenance.agent.role or .type
  • [FHIR-36650] Create Temporary Location Extension

The following JIRAs have been dispositioned and will be applied before publication as they are formatting issues:
  • [V2-5] Duplicate information
  • [V2-25538] MSH[MessageHeader] is presented in Message Table format, not Segment Table Format
  • [V2-25632] Segment Mapping Headers out of sync
  • [FHIR-V2-25633] Data Type Mapping table columns out of sync
The build still included errors that do not prevent the reviewer to review and comment on the proposed mappings. That may require different navigation where the link is still broken. Please use the following guidance
  • Links to a number of segment and data type maps are not working when accessed directly from the Segment Map or Data Type Map pages. However, when accessed when navigating from the Message to the relevant Segment Map or from the Segment to the Data Type map they do work.
  • The links to the diagnostic report status and allergey intolerance criticality do not work when you click on them, however, when you copy them into your browser they do.

The combination of the updates resulting from the above and the ballot comments another reviewe will be necessary, but we will determine based on substantivity whether that will involve a focused ballot round or a peer review as permitted for STU content.

The HL7 V2 to FHIR Implementation Guide supports the mapping of HL7 Version 2 messages segments, datatypes and vocabulary to HL7 FHIR Release 4.0 Bundles, Resources, Data Types and Coding Systems.

This implementation guide provides the Concept Maps and references to the Spreadsheets used to generate them, as well as additional information and material to support validation and testing of implementations.

This guide is organized into three main sections:

  1. Introduction
    This section provides an overview of the project, and explains how mapping is performed. You can also find questions to address in this ballot, the glossary and acknowledgements.

  2. Mapping Guidelines
    This section provides the rules and guidelines used to document the mappings such as identification of each HL7 v2 element with a mapping, the conditions under which the HL7 v2 element may map to one or more HL7 FHIR components, as well references to more specific mappings considering context, e.g., when to map PID data to Patient vs. RelatedPerson, or a CWE encoded element to either CodeableConcept, Coding, or code.

  3. Mappings
    This section provides an index to the mappings produced by this project, organized by message, segment,datatype, or vocabulary mapping.

  4. Implementation and Use
    This section covers implementation considerations, validation, and provides example test conversions.

  5. Profiles
    This section provides the profiles for the HL7 FHIR ConceptMap that describes the data maintained in Concept Maps for each of the message, segment, data type, and vocabulary mapping, as well as a profile for HL7 FHIR Bundle that establishes the basic structure/content of a HL7 FHIR message resulting from an HL7 v2 message.

Click on any of the links above, head on over the table of contents, or if you are looking for a specific artifact, check out the index.

You can also download:

The source code for this Implementation Guide can be found on GitHub.

You can also find references and links to implementations.