Skip to content

Latest commit

 

History

History

v2-to-fhirr4-service

README.md

HL7V2 to FHIR R4 Service

Introduction

This service transforms HL7v2 messages to FHIR resources. Data transformation conditions are taken from the official HL7v2 to FHIR mappings page (https://build.fhir.org/ig/HL7/v2-to-fhir/) and based on the feedback received from the users.

You do not have to write code from scratch but reuse these existing services when implementing your FHIR services. You can deploy the pre-built service on your own environment or deploy on Choreo as a standard Ballerina service.

Supported HL7v2 message versions are 2.3, 2.3.1, 2.4, 2.5, 2.5.1, 2.6, 2.7, 2.7.1, 2.8.

Supported FHIR version is 4.0.1.

Setup and run

1.Clone this repository to your local machine and navigate to the pre-built service on v2-to-fhirr4-service.

  1. Run the project.

    bal run

  2. Invoke the API.

    Sample request format:

    curl 'http://<host>:<port>/transform' \
--data-raw 'MSH|^~\&|EPIC|EPICADT|SMS|SMSADT|202211031408|CHARRIS|ADT^A01|1817457|D|2.8'

Customization

You can customize the v2 segments to FHIR transformation logic by implementing a service with custom mappings and configuring the v2-to-fhirr4-service to invoke the custom service. This custom service can be implemented in Ballerina by using the provided template, or you can use the OAS definition (resources/custom-mapping-service-openapi.yaml) to implement your service using any other technology. The following is the command to initiate the Ballerina template to implement the custom logic:

bal new <service_name> -t ballerinax/health.fhir.templates.r4.v2tofhircustomsvc

You can configure the v2-to-fhir-service in Config.toml file to point to your custom service to invoke the mapping endpoints. The following is a sample configuration structure to invoke a custom service.

[customMapper]
baseUrl = "http://localhost:9091/v2tofhir"

[customMapper.segmentMappings]
NK1 = "/segment/nk1"
PID = "/segment/pid"
Table Field Description
customMapper baseUrl The base URL of the custom service.
customMapper.segmentMappings <segmentName> The path of the custom service endpoint against the each customized segment name.

Note: If you deploy this to Choreo, you can apply configurations through the config editor in the Choreo console. For more information, see Deploy in Choreo.

[Optional] Deploy in Choreo

WSO2’s Choreo (https://wso2.com/choreo/) is an internal developer platform that redefines how you create digital experiences. Choreo empowers you to seamlessly design, develop, deploy, and govern your cloud native applications, unlocking innovation while reducing time-to-market. You can deploy the healthcare prebuilt services in Choreo as explained below.

Prerequisites

If you are signing in to the Choreo Console for the first time, create an organization as follows:

  1. Go to https://console.choreo.dev/, and sign in using your preferred method.
  2. Enter a unique organization name. For example, Stark Industries.
  3. Read and accept the privacy policy and terms of use.
  4. Click Create. This creates the organization and opens the Project Home page of the default project created for you.

Steps to Deploy HL7 v2 to FHIR prebuilt service in Choreo

  1. Create Service Component

  2. Build and Deploy Follow the official documentation to deploy the HL7v2 to FHIR service to your organization https://wso2.com/choreo/docs/develop-components/develop-services/develop-a-ballerina-rest-api/#step-2-build-and-deploy.