hl7v2-validator

HL7v2 Validator

About the tool

HL7 messages are used to exchange clinical, administrative, and other types of data between healthcare systems. The syntax and content of the messages are defined in the HL7v2 specification.

The HL7v2 specification uses the HL7 abstract message syntax to formally define the structure of HL7 messages. The syntax therefore acts as a language describing the schemas of the HL7v2 message types and can be used to validate the instances of the messages.

This project of mine is a tool that validates HL7v2 messages against the abstract message syntax. The tool parses the ER7-encoded HL7 message, abstract message syntax (the schema or grammar), and checks if the message conforms to the syntax. Both the parsers and the validator are implemented by me from scratch in TypeScript and run in the browser.

Demo

HL7 abstract message syntax

MSH
MSA
[{ERR}]
[{NTE}]
[
  [
    PID
    [{NTE}]
  ]
  {
    ORC
    <OBR|RQD|RQ1|RXO|ODS|ODT>
    [{NTE}]
    [{CTI}]
  }
]1
MSH
2
MSA
3
[{ERR}]
4
[{NTE}]
5
[
6
  [
7
    PID
8
    [{NTE}]
9
  ]
10
  {
11
    ORC
12
    <OBR|RQD|RQ1|RXO|ODS|ODT>
13
    [{NTE}]
14
    [{CTI}]
15
  }
16
]

HL7 message

MSH|^~\&|^OLIS^X500||^2.16.840.1.113883.3.239.14:AZ123^ISO||20050601091510-0400||ORR^O02^ORR_O02|3A732994-A4F7-40B8-9BBB-0A91E15705CE|P|2.3.1||||||8859/1
MSA|AE|TAG123456
ERR|^^^9876&A recent result exists that may be clinically valid. Consider retrieving this result from OLIS, or resubmit the order to OLIS with the DTA intervention code.&HL70357
PID|1||5427888498^^^^JHN^^^^ON&Ontario&HL70347^^VC||Smith^John^Henry^^^^U||19271127|M|||123 Maple St^^Anytown^ON^M5W 1E6^CAN^H||^PRN^PH^^^705^7777157
ORC|OK|||2112911^^2.16.840.1.113883.3.239.14:AZ123^ISO|||||20050601091509-0400
OBR|1|8012983^^2.16.840.1.113883.3.239.14:AZ123^ISO||TR10228-5^Hemoglobin A1C^HL79901||||||||||||12345^Welby^Marcus^^^Dr^^^^^^^MDL^^^^^^^^^ON&Ontario&HL70347|^WPN^PH^^^705^2343425||||||||O||1^^^20050601^^R1
MSH|^~\&|^OLIS^X500||^2.16.840.1.113883.3.239.14:AZ123^ISO||20050601091510-0400||ORR^O02^ORR_O02|3A732994-A4F7-40B8-9BBB-0A91E15705CE|P|2.3.1||||||8859/1
2
MSA|AE|TAG123456
3
ERR|^^^9876&A recent result exists that may be clinically valid. Consider retrieving this result from OLIS, or resubmit the order to OLIS with the DTA intervention code.&HL70357
4
PID|1||5427888498^^^^JHN^^^^ON&Ontario&HL70347^^VC||Smith^John^Henry^^^^U||19271127|M|||123 Maple St^^Anytown^ON^M5W 1E6^CAN^H||^PRN^PH^^^705^7777157
5
ORC|OK|||2112911^^2.16.840.1.113883.3.239.14:AZ123^ISO|||||20050601091509-0400
6
OBR|1|8012983^^2.16.840.1.113883.3.239.14:AZ123^ISO||TR10228-5^Hemoglobin A1C^HL79901||||||||||||12345^Welby^Marcus^^^Dr^^^^^^^MDL^^^^^^^^^ON&Ontario&HL70347|^WPN^PH^^^705^2343425||||||||O||1^^^20050601^^R

Message conforms to the grammar.

Thanks for stopping by my digital playground! If you want to say hi, you can reach out to me on LinkedIn or via email. I'm always keen to chat and connect.

If you really-really like my work, you can support me by buying me a coffee.