Module health.hl7v2.utils.v2tofhirr4

ballerinax/health.hl7v2.utils.v2tofhirr4 Ballerina library

1.0.2

Module for HL7v2.x to FHIR R4 pre-built mapping functionalities.

HL7v2 to FHIR Package

Module Overview

This module implements the HL7 version 2 to FHIR implementation guide (https://build.fhir.org/ig/HL7/v2-to-fhir/branches/master/datatype_maps.html).

Usage

To use the package add following import to your Ballerina program.


import ballerinax/health.hl7v2.utils.v2tofhirr4

Sample: This sample showcase how you can pass a HL7 version 2 message and get a FHIR R4 Bundle in return. In addition to that, we are demonstrating how you could use the library to transform HL7 segments to FHIR.


import ballerina/io;
import ballerinax/health.hl7v2.utils.v2tofhirr4;
import ballerinax/health.hl7v2 as hl7;
import ballerinax/health.hl7v23;
import ballerinax/health.fhir.r4 as r4;

final string msg = "MSH|^~\\&|ADT1|GOOD HEALTH HOSPITAL|GHH LAB, INC.|GOOD HEALTH" +
"HOSPITAL|198808181126|SECURITY|ADT^A01^ADT_A01|MSG00001|P|2.3||\rEVN|A01|" +
"200708181123||\rPID|1||PATID1234^5^M11^ADT1^MR^GOOD HEALTH"+
"HOSPITAL~123456789^^^USSSA^SS||" +
"BATMAN^ADAM^A^III||19610615|M||C|2222 HOME STREET^^GREENSBORO^NC^27401-1020|GL|" +
"(555)555-2004|(555)555-2004||S||PATID12345001^2^M10^ADT1^AN^A|444333333|987654^NC|" +
"\rNK1|1|NUCLEAR^NELDA^W|SPO^SPOUSE||||NK^NEXT OF KIN$\rPV1|1|I|2000^2012^01||||" +
"004777^ATTEND^AARON^A|||SUR||||ADM|A0|";

public function main() returns error? {
    // Transform HL7v2 message to FHIR R4.
    // You can pass a HL7v2 message and get a FHIR R4 Bundle based on
    // the mappings defined at
    // https://build.fhir.org/ig/HL7/v2-to-fhir/branches/master/datatype_maps.html.
    json v2tofhirResult = check v2tofhirr4:v2ToFhir(msg);
    io:println("Transformed FHIR message: ", v2tofhirResult.toString());
    io:println("------------------------------------------------------------------");
    hl7:Message hl7msg = check v2tofhirr4:stringToHl7(msg);
    if (hl7msg is hl7v23:ADT_A01) {
        // v2tofhirr4 library exposes these low level functions as well,
        // if you want to work with HL7v2 segments directly.
        // Transform HL7v2 PID to FHIR R4 Patient Name.
        r4:HumanName[] patientName = v2tofhirr4:pidToPatientName(hl7msg.pid.pid5,
        hl7msg.pid.pid9);
        io:println("HL7v23 PID Patient Name: ", patientName[0].toString());
    }
}

Functions

al1ToAllerygyIntolerance

function al1ToAllerygyIntolerance(Al1 al1) returns AllergyIntolerance

Parameters

al1 Al1 -

ceToCode

function ceToCode(Ce ce) returns code

Parameters

ce Ce -

ceToCodeableConcept

function ceToCodeableConcept(Ce ce) returns CodeableConcept

Parameters

ce Ce -

ceToCodeableConcepts

function ceToCodeableConcepts(Ce|CWE ce) returns CodeableConcept[]

Parameters

ce Ce|CWE -

ceToCoding

function ceToCoding(Ce ce) returns Coding

Parameters

ce Ce -

ceToCodings

function ceToCodings(Ce ce) returns Coding[]

Parameters

ce Ce -

ceToUri

function ceToUri(Ce ce) returns uri

Parameters

ce Ce -

cweToCode

function cweToCode(Cwe cwe) returns code

Parameters

cwe Cwe -

cweToCodeableConcept

function cweToCodeableConcept(Cwe cwe) returns CodeableConcept

Parameters

cwe Cwe -

cweToCoding

function cweToCoding(Cwe cwe) returns Coding

Parameters

cwe Cwe -

cweToCodings

function cweToCodings(Cwe ce) returns Coding[]

Parameters

ce Cwe -

cweToUri

function cweToUri(Cwe cwe) returns uri

Parameters

cwe Cwe -

dg1ToCondition

function dg1ToCondition(Dg1 dg1) returns Condition

Parameters

dg1 Dg1 -

dtmToDateTime

function dtmToDateTime(Dtm ts) returns dateTime

Parameters

ts Dtm -

dtmToInstant

function dtmToInstant(Dtm ts) returns instant

Parameters

ts Dtm -

eiToCoding

function eiToCoding(Ei ei) returns Coding

Parameters

ei Ei -

eiToIdentifier

function eiToIdentifier(Ei ei) returns Identifier

Parameters

ei Ei -

evnToProvenance

function evnToProvenance(Evn evn) returns Provenance

Parameters

evn Evn -

hdToMessageHeaderDestination

function hdToMessageHeaderDestination(Hd hd) returns MessageHeaderDestination

Parameters

hd Hd -

hdToMessageHeaderSource

function hdToMessageHeaderSource(Hd hd) returns MessageHeaderSource

Parameters

hd Hd -

idToAddressType

function idToAddressType(Id id) returns AddressType

Parameters

id Id -

idToAddressUse

function idToAddressUse(Id id) returns AddressUse?

Parameters

id Id -

idToCodeableConcept

function idToCodeableConcept(ID id) returns CodeableConcept

Parameters

id ID -

idToCodeableConceptArray

function idToCodeableConceptArray(Id id) returns CodeableConcept[]

Parameters

id Id -

idToCoding

function idToCoding(ID id) returns Coding

Parameters

id ID -

idToContactPointSystem

function idToContactPointSystem(Id id) returns ContactPointSystem

Parameters

id Id -

idToContactPointUse

function idToContactPointUse(Id id) returns ContactPointUse

Parameters

id Id -

idToDiagnosticReportStatus

function idToDiagnosticReportStatus(ID id) returns DiagnosticReportStatus

Parameters

id ID -

idToHumanNameUse

function idToHumanNameUse(Id id) returns HumanNameUse

Parameters

id Id -

idToServiceRequestPriority

function idToServiceRequestPriority(ID id) returns ServiceRequestPriority

Parameters

id ID -

isToAllergyIntoleranceCategory

function isToAllergyIntoleranceCategory(Is 'is) returns AllergyIntoleranceCategory

Parameters

'is Is -

isToAllergyIntoleranceCriticality

function isToAllergyIntoleranceCriticality(Is 'is) returns AllergyIntoleranceCriticality

Parameters

'is Is -

isToAllergyIntoleranceType

function isToAllergyIntoleranceType(string 'is) returns AllergyIntoleranceType

Parameters

'is string -

msgToCoding

function msgToCoding(CM_MSG msg) returns Coding

Parameters

msg CM_MSG -

mshToMessageHeader

function mshToMessageHeader(Msh msh) returns MessageHeader

Parameters

msh Msh -

nameToServiceRequestIntent

function nameToServiceRequestIntent(string name) returns ServiceRequestIntent

Parameters

name string -

nk1ToContact

function nk1ToContact(Nk12 nk12, Nk14 nk14, Nk15 nk15, Nk16 nk16, Nk17 nk17, Nk18 nk18, Nk19 nk19, Nk113 nk113, Nk115 nk115, Nk130 nk130, Nk131 nk131, Nk132 nk132) returns PatientContact[]

Parameters

nk12 Nk12 -

nk14 Nk14 -

nk15 Nk15 -

nk16 Nk16 -

nk17 Nk17 -

nk18 Nk18 -

nk19 Nk19 -

nk113 Nk113 -

nk115 Nk115 -

nk130 Nk130 -

nk131 Nk131 -

nk132 Nk132 -

nk1ToPatient

function nk1ToPatient(Nk1 nk1) returns Patient

Parameters

nk1 Nk1 -

obrToDiagnosticReport

function obrToDiagnosticReport(Obr obr) returns DiagnosticReport

Parameters

obr Obr -

obrToServiceRequest

function obrToServiceRequest(Obr obr) returns ServiceRequest

Parameters

obr Obr -

obxToObservation

function obxToObservation(Obx obx) returns Observation

Parameters

obx Obx -

orcToDiagnosticReport

function orcToDiagnosticReport(Orc orc) returns DiagnosticReport

Parameters

orc Orc -

orcToImmunization

function orcToImmunization(Orc orc) returns Immunization

Parameters

orc Orc -

pd1ToExtension

function pd1ToExtension(string pd16) returns Extension[]

Parameters

pd16 string -

pd1ToGeneralPractitioner

function pd1ToGeneralPractitioner(Pd13 pd13, Pd14 pd14) returns Reference[]

Parameters

pd13 Pd13 -

pd14 Pd14 -

pd1ToPatient

function pd1ToPatient(Pd1 pd1) returns Patient

Parameters

pd1 Pd1 -

pidToAddress

function pidToAddress(string pid12, Pid11 pid11) returns Address[]

Parameters

pid12 string -

pid11 Pid11 -

pidToAdministrativeSex

function pidToAdministrativeSex(string pid8) returns PatientGender

Parameters

pid8 string -

pidToBirthOrder

function pidToBirthOrder(float|string pid25) returns int

Parameters

pid25 float|string -

pidToBirthPlace

function pidToBirthPlace(string pid23) returns Extension[]

Parameters

pid23 string -

pidToMaritalStatus

function pidToMaritalStatus(Pid16 pid16) returns Coding[]

Parameters

pid16 Pid16 -

pidToMultipleBirthIndicator

function pidToMultipleBirthIndicator(string pid24) returns boolean

Parameters

pid24 string -

pidToPatient

function pidToPatient(Pid pid) returns Patient

Parameters

pid Pid -

pidToPatientDeathIndicator

function pidToPatientDeathIndicator(string pid30) returns boolean

Parameters

pid30 string -

pidToPatientName

function pidToPatientName(Pid5 pid5, Pid9 pid9) returns HumanName[]

Parameters

pid5 Pid5 -

pid9 Pid9 -

pidToPhoneNumber

function pidToPhoneNumber(Pid13 pid13, Pid14 pid14) returns ContactPoint[]

Parameters

pid13 Pid13 -

pid14 Pid14 -

pidToPrimaryLanguage

function pidToPrimaryLanguage(Pid15 pid15) returns PatientCommunication[]

Parameters

pid15 Pid15 -

pidToSsnNumberIdentifier

function pidToSsnNumberIdentifier(string pid19) returns Identifier[]

Parameters

pid19 string -

ptToMeta

function ptToMeta(Pt pt) returns Meta

Parameters

pt Pt -

pv1ToEncounter

function pv1ToEncounter(Pv1 pv1) returns Encounter

Parameters

pv1 Pv1 -

pv1ToExtension

function pv1ToExtension(string pv116) returns Extension[]

Parameters

pv116 string -

pv1ToPatient

function pv1ToPatient(Pv1 pv1) returns Patient

Parameters

pv1 Pv1 -

pv2ToEncounter

function pv2ToEncounter(Pv2 pv2) returns Encounter

Parameters

pv2 Pv2 -

segmentToFhir

function segmentToFhir(string segmentName, Segment segment) returns BundleEntry[]

Transform an HL7 segment to FHIR.

Parameters

segmentName string - Name of the HL7 segment

segment Segment - HL7 segment

Return Type

BundleEntry[] - FHIR Bundle

stringToHl7

function stringToHl7(string msg) returns Message|error

Parse a string to an HL7 message.

Parameters

msg string - HL7 message as a string

Return Type

Message|error - hl7v2:Message

tsToDateTime

function tsToDateTime(Ts ts) returns dateTime

Parameters

ts Ts -

tsToInstant

function tsToInstant(Ts ts) returns instant

Parameters

ts Ts -

v2ToFhir

function v2ToFhir(string|Message hl7) returns json|error

Transform an HL7 message to FHIR.

Parameters

hl7 string|Message - HL7 message as a string or an hl7v2:Message

Return Type

json|error - FHIR Bundle as a json

xadToAddress

function xadToAddress(Xad xad) returns Address

Parameters

xad Xad -

xcnToCodeableConcept

function xcnToCodeableConcept(Xcn xcn) returns CodeableConcept

Parameters

xcn Xcn -

xcnToReference

function xcnToReference(Xcn xcn) returns Reference

Parameters

xcn Xcn -

xonToOrganization

function xonToOrganization(Xon xon) returns Organization

Parameters

xon Xon -

xpnToHumanName

function xpnToHumanName(Xpn xpn) returns HumanName

Parameters

xpn Xpn -

xtnToContactPoint

function xtnToContactPoint(Xtn xtn) returns ContactPoint

Parameters

xtn Xtn -

Union types

health.hl7v2.utils.v2tofhirr4: Al1

AL1|AL1|AL1|AL1|AL1|AL1|AL1|AL1

Al1

Union type for holding patient allergy information segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Ce

CE|CE|CE|CE|CE

Union type for CE data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Cwe

CWE|CWE|CWE|CWE|CWE|CWE|CWE

Cwe

Union type for CWE data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Dg1

DG1|DG1|DG1|DG1|DG1|DG1|DG1|DG1

Dg1

Union type for holding patient visit segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Dtm

DTM|DTM|DTM|DTM

Dtm

Union type for DTM data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Ei

EI|EI|EI|EI|EI|EI|EI|EI

Union type for EI data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Evn

EVN|EVN|EVN|EVN|EVN|EVN|EVN|EVN

Evn

Union type for holding event type segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Hd

HD|HD|HD|HD|HD|HD|HD|HD

Union type for HD data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Id

ID|ID|ID|ID|ID|ID|ID|ID

Union type for ID data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Is

IS|IS|IS

Union type for IS data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Msh

MSH|MSH|MSH|MSH|MSH|MSH|MSH|MSH

Msh

Union types for holding hl7 segments for supported hl7 versions.

######################################################################## Union type for holding message header segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk1

NK1|NK1|NK1|NK1|NK1|NK1|NK1|NK1

Nk1

Union type for holding next of kin segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk113

XON[]|XON[]|XON[]|XON[]|XON[]|XON[]|XON[]

Nk113

Union type for patient's extended person's organization name for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk115

IS|IS|IS|IS|IS|IS|CWE

Nk115

Union type for patient's extended person's gender for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk12

XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]

Nk12

Union type for patient's extended person's name for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk130

XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]

Nk130

Union type for patient's extended person's contact person name for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk131

XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]

Nk131

Union type for patient's extended person's contact person phone number for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk132

XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]

Nk132

Union type for patient's extended person's contact person address for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk14

XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]

Nk14

Union type for patient's extended person's address for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk15

XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]

Nk15

Union type for patient's extended person's home phone number for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk16

XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]

Nk16

Union type for patient's extended person's business phone number for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk17

CE|CE|CE|CE|CE|CWE|CWE

Nk17

Union type for patient's extended person's contact role for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk18

DT|DT|DT|DT|DT|DT|DT

Nk18

Union type for patient's extended person's start date for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Nk19

DT|DT|DT|DT|DT|DT|DT

Nk19

Union type for patient's extended person's end date for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Obr

OBR|OBR|OBR|OBR|OBR|OBR|OBR|OBR

Obr

Union type for holding observation request segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Obx

OBX|OBX|OBX|OBX|OBX|OBX|OBX|OBX

Obx

Union type for holding observation segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Orc

ORC|ORC|ORC|ORC|ORC|ORC|ORC|ORC

Orc

Union type for holding common order segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pd1

PD1|PD1|PD1|PD1|PD1|PD1|PD1|PD1

Pd1

Union type for holding patient identification segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pd13

XON[]|XON[]|XON[]|XON[]|XON[]|XON[]|XON[]

Pd13

Union type for patient primary facility for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pd14

XCN[]|XCN[]|XCN[]|XCN[]|XCN[]|XCN[]|ST

Pd14

Union type for patient primary care provider for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid

PID|PID|PID|PID|PID|PID|PID|PID

Pid

Union type for holding patient identification segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid11

XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]

Pid11

Union type for holding patient address for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid13

XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]

Pid13

Union type for holding patient home phone number for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid14

XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]

Pid14

Union type for holding patient business phone number for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid15

CE|CE|CE|CE|CE|CWE

Pid15

Union type for holding patient primary language for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid16

string|CE|CE|CE|CE|CE|CWE

Pid16

Union type for holding patient marital status for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid5

XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]

Pid5

Union types defined for data types for supported hl7 versions.

###################################################################### Union type for holding patient name for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pid9

XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|ST|ST

Pid9

Union type for holding patient alias name for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pt

PT|PT|PT|PT|PT|PT|PT|PT

Union type for PT data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pv1

PV1|PV1|PV1|PV1|PV1|PV1|PV1|PV1

Pv1

Union type for holding patient visit segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Pv2

PV2|PV2|PV2|PV2|PV2|PV2|PV2|PV2

Pv2

Union type for holding patient visit additional information segment for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Ts

TS|TS|TS|TS|TS

Union type for TS data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Xad

XAD|XAD|XAD|XAD|XAD|XAD|XAD|XAD

Xad

Union type for XAD data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Xcn

XCN|XCN|XCN|XCN|XCN|XCN|XCN|XCN

Xcn

Union type for XCN data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Xon

XON|XON|XON|XON|XON|XON|XON|XON

Xon

Union type for XON data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Xpn

XPN|XPN|XPN|XPN|XPN|XPN|XPN|XPN

Xpn

Union type for XPN data type for all supported hl7 versions.

health.hl7v2.utils.v2tofhirr4: Xtn

XTN|XTN|XTN|XTN|XTN|XTN|XTN|XTN

Xtn

Union type for XTN data type for all supported hl7 versions.

Import

import ballerinax/health.hl7v2.utils.v2tofhirr4;

Metadata

Released date: over 1 year ago

Version: 1.0.2

Compatibility

Platform: any

Ballerina version: 2201.5.0

GraalVM compatible: Yes

Pull count

Total: 868

Current verison: 36

Weekly downloads

Source repository

Keywords

Healthcare

HL7

FHIR

Contributors

Other versions

3.1.1 3.1.0 3.0.1 2.2.3 2.2.1

Dependencies

ballerinax/health.fhir.r4/1.0.3 ballerina/log/2.7.1 ballerinax/health.hl7v2/1.0.5

Cookie policy

Delete policy

functions

unionTypes

ballerinax/health.hl7v2.utils.v2tofhirr4 Ballerina library

HL7v2 to FHIR Package

Module Overview

Usage

Functions

al1ToAllerygyIntolerance

Parameters

ceToCode

Parameters

ceToCodeableConcept

Parameters

ceToCodeableConcepts

Parameters

ceToCoding

Parameters

ceToCodings

Parameters

ceToUri

Parameters

cweToCode

Parameters

cweToCodeableConcept

Parameters

cweToCoding

Parameters

cweToCodings

Parameters

cweToUri

Parameters

dg1ToCondition

Parameters

dtmToDateTime

Parameters

dtmToInstant

Parameters

eiToCoding

Parameters

eiToIdentifier

Parameters

evnToProvenance

Parameters

hdToMessageHeaderDestination

Parameters

hdToMessageHeaderSource

Parameters

idToAddressType

Parameters

idToAddressUse

Parameters

idToCodeableConcept

Parameters

idToCodeableConceptArray

Parameters

idToCoding

Parameters

idToContactPointSystem

Parameters

idToContactPointUse

Parameters

idToDiagnosticReportStatus

Parameters

idToHumanNameUse

Parameters

idToServiceRequestPriority

Parameters

isToAllergyIntoleranceCategory

Parameters

isToAllergyIntoleranceCriticality

Parameters

isToAllergyIntoleranceType

Parameters

msgToCoding

Parameters

mshToMessageHeader

Parameters

nameToServiceRequestIntent

Parameters

nk1ToContact