Ballerina library

health.hl7v2.utils.v2tofhirr4

Module health.hl7v2.utils.v2tofhirr4

Module OverviewUsage

API

al1ToAllerygyIntolerance
ceToCode
ceToCodeableConcept
ceToCodeableConcepts
ceToCoding
ceToCodings
ceToUri
cweToCode
cweToCodeableConcept
cweToCoding
cweToUri
dg1ToCondition
dtmToDateTime
dtmToInstant
eiToCoding
eiToIdentifier
evnToProvenance
hdToMessageHeaderDestination
hdToMessageHeaderSource
idToAddressType
idToAddressUse
idToCodeableConcept
idToCodeableConceptArray
idToCoding
idToContactPointSystem
idToContactPointUse
idToDiagnosticReportStatus
idToHumanNameUse
idToServiceRequestPriority
isToAllergyIntoleranceCategory
isToAllergyIntoleranceCriticality
isToAllergyIntoleranceType
msgToCoding
mshToMessageHeader
nameToServiceRequestIntent
nk1ToContact
nk1ToPatient
obrToDiagnosticReport
obrToServiceRequest
obxToObservation
orcToDiagnosticReport
orcToImmunization
pd1ToExtension
pd1ToGeneralPractitioner
pd1ToPatient
pidToAddress
pidToAdministrativeSex
pidToBirthOrder
pidToBirthPlace
pidToMaritalStatus
pidToMultipleBirthIndicator
pidToPatient
pidToPatientDeathIndicator
pidToPatientName
pidToPhoneNumber
pidToPrimaryLanguage
pidToSsnNumberIdentifier
ptToMeta
pv1ToEncounter
pv1ToExtension
pv1ToPatient
pv2ToEncounter
segmentToFhir
stringToHl7
tsToDateTime
tsToInstant
v2ToFhir
xadToAddress
xcnToCodeableConcept
xcnToReference
xonToOrganization
xpnToHumanName
xtnToContactPoint

Declarations

ComparisonOperator
LogicalOperator

Definitions

ANTLR

ballerinax/health.hl7v2.utils.v2tofhirr4 Ballerina library

1.0.0

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.

Copy
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.

Copy
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 = string `MSH|^~\\&|ADT1|GOOD HEALTH HOSPITAL|GHH LAB, INC.|GOOD HEALTH HOSPITAL|
198808181126|SECURITY|ADT^A01^ADT_A01|MSG00001|P|2.3||${"\r"}EVN|A01|200708181123||
${"\r"}PID|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|
${"\r"}NK1|1|NUCLEAR^NELDA^W|SPO^SPOUSE||||NK^NEXT OF KIN${"\r"}PV1|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|AL1|AL1|AL1|AL1|AL1|AL1 al1) returns AllergyIntolerance
Parameters

ceToCode

function ceToCode(CE|CE|CE|CE|CE ce) returns code
Parameters

ceToCodeableConcept

function ceToCodeableConcept(CE|CE|CE|CE|CE ce) returns CodeableConcept
Parameters

ceToCodeableConcepts

function ceToCodeableConcepts(CE|CE|CE|CE|CE|CWE ce) returns CodeableConcept[]
Parameters

ceToCoding

function ceToCoding(CE|CE|CE|CE|CE ce) returns Coding
Parameters

ceToCodings

function ceToCodings(CE|CE|CE|CE|CE|CWE|CWE|CWE ce) returns Coding[]
Parameters

ceToUri

function ceToUri(CE|CE|CE|CE|CE ce) returns uri
Parameters

cweToCode

function cweToCode(CWE|CWE|CWE cwe) returns code
Parameters

cweToCodeableConcept

function cweToCodeableConcept(CWE|CWE|CWE|CWE|CWE|CWE|CWE cwe) returns CodeableConcept
Parameters

cweToCoding

function cweToCoding(CWE|CWE|CWE|CWE|CWE|CWE|CWE cwe) returns Coding
Parameters

cweToUri

function cweToUri(CWE|CWE|CWE|CWE|CWE|CWE|CWE cwe) returns uri
Parameters

dg1ToCondition

function dg1ToCondition(DG1|DG1|DG1|DG1|DG1|DG1|DG1|DG1 dg1) returns Condition
Parameters

dtmToDateTime

function dtmToDateTime(DTM|DTM|DTM|DTM ts) returns dateTime
Parameters

dtmToInstant

function dtmToInstant(DTM|DTM|DTM|DTM ts) returns instant
Parameters

eiToCoding

function eiToCoding(EI|EI|EI|EI|EI|EI|EI|EI ei) returns Coding
Parameters

eiToIdentifier

function eiToIdentifier(EI|EI|EI|EI|EI|EI|EI|EI ei) returns Identifier
Parameters

evnToProvenance

function evnToProvenance(EVN|EVN|EVN|EVN|EVN|EVN|EVN|EVN evn) returns Provenance
Parameters

hdToMessageHeaderDestination

function hdToMessageHeaderDestination(HD|HD|HD|HD|HD|HD|HD|HD hd) returns MessageHeaderDestination
Parameters

hdToMessageHeaderSource

function hdToMessageHeaderSource(HD|HD|HD|HD|HD|HD|HD|HD hd) returns MessageHeaderSource
Parameters

idToAddressType

function idToAddressType(ID|ID|ID id) returns AddressType
Parameters

idToAddressUse

function idToAddressUse(ID|ID|ID id) returns AddressUse?
Parameters

idToCodeableConcept

function idToCodeableConcept(ID id) returns CodeableConcept
Parameters

idToCodeableConceptArray

function idToCodeableConceptArray(ID|ID|ID|ID|ID|ID|ID|ID id) returns CodeableConcept[]
Parameters

idToCoding

function idToCoding(ID id) returns Coding
Parameters

idToContactPointSystem

function idToContactPointSystem(ID|ID|ID id) returns ContactPointSystem
Parameters

idToContactPointUse

function idToContactPointUse(ID|ID|ID id) returns ContactPointUse
Parameters

idToDiagnosticReportStatus

function idToDiagnosticReportStatus(ID id) returns DiagnosticReportStatus
Parameters

idToHumanNameUse

function idToHumanNameUse(ID|ID|ID id) returns HumanNameUse
Parameters

idToServiceRequestPriority

function idToServiceRequestPriority(ID id) returns ServiceRequestPriority
Parameters

isToAllergyIntoleranceCategory

function isToAllergyIntoleranceCategory(IS|IS|IS 'is) returns AllergyIntoleranceCategory
Parameters

isToAllergyIntoleranceCriticality

function isToAllergyIntoleranceCriticality(IS|IS|IS 'is) returns AllergyIntoleranceCriticality
Parameters

isToAllergyIntoleranceType

function isToAllergyIntoleranceType(string 'is) returns AllergyIntoleranceType
Parameters

msgToCoding

function msgToCoding(CM_MSG msg) returns Coding
Parameters

mshToMessageHeader

function mshToMessageHeader(MSH|MSH|MSH|MSH|MSH|MSH|MSH|MSH msh) returns MessageHeader
Parameters

nameToServiceRequestIntent

function nameToServiceRequestIntent(string name) returns ServiceRequestIntent
Parameters

nk1ToContact

function nk1ToContact(XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[] nk12, XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[] nk14, XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[] nk15, XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[] nk16, CE|CE|CE|CE|CE|CWE|CWE nk17, DT|DT|DT|DT|DT|DT|DT nk18, DT|DT|DT|DT|DT|DT|DT nk19, XON[]|XON[]|XON[]|XON[]|XON[]|XON[]|XON[] nk113, IS|IS|IS|IS|IS|IS|CWE nk115, XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[] nk130, XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[] nk131, XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[] nk132) returns PatientContact[]
Parameters

nk1ToPatient

function nk1ToPatient(NK1|NK1|NK1|NK1|NK1|NK1|NK1|NK1 nk1) returns Patient
Parameters

obrToDiagnosticReport

function obrToDiagnosticReport(OBR|OBR|OBR|OBR|OBR|OBR|OBR|OBR obr) returns DiagnosticReport
Parameters

obrToServiceRequest

function obrToServiceRequest(OBR|OBR|OBR|OBR|OBR|OBR|OBR|OBR obr) returns ServiceRequest
Parameters

obxToObservation

function obxToObservation(OBX|OBX|OBX|OBX|OBX|OBX|OBX|OBX obx) returns Observation
Parameters

orcToDiagnosticReport

function orcToDiagnosticReport(ORC|ORC|ORC|ORC|ORC|ORC|ORC|ORC orc) returns DiagnosticReport
Parameters

orcToImmunization

function orcToImmunization(ORC|ORC|ORC|ORC|ORC|ORC|ORC|ORC orc) returns Immunization
Parameters

pd1ToExtension

function pd1ToExtension(string pd16) returns Extension[]
Parameters

pd1ToGeneralPractitioner

function pd1ToGeneralPractitioner(XON[]|XON[]|XON[]|XON[]|XON[]|XON[]|XON[] pd13, XCN[]|XCN[]|XCN[]|XCN[]|XCN[]|XCN[]|ST pd14) returns Reference[]
Parameters

pd1ToPatient

function pd1ToPatient(PD1|PD1|PD1|PD1|PD1|PD1|PD1|PD1 pd1) returns Patient
Parameters

pidToAddress

function pidToAddress(string pid12, XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[]|XAD[] pid11) returns Address[]
Parameters

pidToAdministrativeSex

function pidToAdministrativeSex(string pid8) returns PatientGender
Parameters

pidToBirthOrder

function pidToBirthOrder(float|string pid25) returns int
Parameters

pidToBirthPlace

function pidToBirthPlace(string pid23) returns Extension[]
Parameters

pidToMaritalStatus

function pidToMaritalStatus(string|CE|CE|CE|CE|CE|CWE pid16) returns Coding[]
Parameters

pidToMultipleBirthIndicator

function pidToMultipleBirthIndicator(string pid24) returns boolean
Parameters

pidToPatient

function pidToPatient(PID|PID|PID|PID|PID|PID|PID|PID pid) returns Patient
Parameters

pidToPatientDeathIndicator

function pidToPatientDeathIndicator(string pid30) returns boolean
Parameters

pidToPatientName

function pidToPatientName(XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[] pid5, XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[]|XPN[] pid9) returns HumanName[]
Parameters

pidToPhoneNumber

function pidToPhoneNumber(XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[] pid13, XTN[]|XTN[]|XTN[]|XTN[]|XTN[]|XTN[] pid14) returns ContactPoint[]
Parameters

pidToPrimaryLanguage

function pidToPrimaryLanguage(CE|CE|CE|CE|CE|CWE pid15) returns PatientCommunication[]
Parameters

pidToSsnNumberIdentifier

function pidToSsnNumberIdentifier(string pid19) returns Identifier[]
Parameters

ptToMeta

function ptToMeta(PT|PT|PT|PT|PT|PT|PT|PT pt) returns Meta
Parameters

pv1ToEncounter

function pv1ToEncounter(PV1|PV1|PV1|PV1|PV1|PV1|PV1|PV1 pv1) returns Encounter
Parameters

pv1ToExtension

function pv1ToExtension(string pv116) returns Extension[]
Parameters

pv1ToPatient

function pv1ToPatient(PV1|PV1|PV1|PV1|PV1|PV1|PV1|PV1 pv1) returns Patient
Parameters

pv2ToEncounter

function pv2ToEncounter(PV2|PV2|PV2|PV2|PV2|PV2|PV2|PV2 pv2) returns Encounter
Parameters

segmentToFhir

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

Transform an HL7 segment to FHIR.

Parameters
  • segmentName string - Name of the HL7 segment
Return Type

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

tsToDateTime

function tsToDateTime(TS|TS|TS|TS|TS ts) returns dateTime
Parameters

tsToInstant

function tsToInstant(TS|TS|TS|TS|TS ts) returns instant
Parameters

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|XAD|XAD|XAD|XAD|XAD|XAD xad) returns Address
Parameters

xcnToCodeableConcept

function xcnToCodeableConcept(XCN|XCN|XCN|XCN|XCN|XCN|XCN|XCN xcn) returns CodeableConcept
Parameters

xcnToReference

function xcnToReference(XCN|XCN|XCN|XCN|XCN|XCN|XCN|XCN xcn) returns Reference
Parameters

xonToOrganization

function xonToOrganization(XON|XON|XON|XON|XON|XON|XON|XON xon) returns Organization
Parameters

xpnToHumanName

function xpnToHumanName(XPN|XPN|XPN|XPN|XPN|XPN|XPN|XPN xpn) returns HumanName
Parameters

xtnToContactPoint

function xtnToContactPoint(XTN|XTN|XTN|XTN|XTN|XTN|XTN|XTN xtn) returns ContactPoint
Parameters

Enums

health.hl7v2.utils.v2tofhirr4: ComparisonOperator

Members

EQ
GT
GTE
IN
LT
LTE
NE
NIN

health.hl7v2.utils.v2tofhirr4: LogicalOperator

Members

AND
NOT
NOR
OR

Records

health.hl7v2.utils.v2tofhirr4: ANTLR

Closed record

Standard ANTLR Record Definition

Fields
  • identifier string - HL7 v2 Identifier(ID)
  • comparisonOperator ComparisonOperator - [EQ, GT, GTE, IN, LT, LTE, NE, NIN] - Comparison logic
  • valueList string[] - Values to be applied with the logic to compare identifier

Import

import ballerinax/health.hl7v2.utils.v2tofhirr4;Copy

Metadata

Released date: about 1 year ago

Version: 1.0.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 27

Current verison: 0

Weekly downloads

Source repository

Keywords

Healthcare

HL7

FHIR

Contributors

Other versions

3.0.12.2.12.2.02.1.02.0.2
See more...

Dependencies

ballerina/log/2.6.0ballerinax/health.fhir.r4/1.0.2ballerinax/health.hl7v2/1.0.3
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC