RADx® MARS: Getting started: HL7v2

Share:

EmailFacebookLinkedInXWhatsAppShare

Links

Documentation

HL7v2 implementation guide

The HL7v2 implementation guide is available for download as a spreadsheet file (link above).

Patient-specific fields

Patient-related fields fall into two categories: (1) user profile (such as name, address, phone) and (2) test results. User profile fields should require a one-time entry by the individual user of the application. Test result fields need to be populated separately every time a test is taken.

Sender-specific fields

Sender-specific fields help to uniquely identify the sending mobile application and are shown in the table below.

Sender-specific field HL7v2 Element
Sending system OID MSH-3.2
Sending facility name MSH-4.1
Sending facility ID MSH-4.2
Filler Order Number Assigner OID OBR-3.3
Filler Order Number Assigner OID ORC-3.3
Patient ID Assigner PID-3.4.2
Specimen ID Assigner OID SPM-2.2.3

 

The values of these fields will be provided by the Association of Public Health Laboratories (APHL), and will be unique to each mobile application.

To request sender-specific field values for your organization and/or application, follow the link below.

Sender-specific field values request form

To look up existing sender/receiver-specific field values, follow the link below.

Sender/receiver-specific field values look up

 

Test-specific fields

Finally, test-specific fields help to uniquely identify the type of test that is taken and are shown in the table below. A diagnostics company may manufacture different types of tests. Each type of test will have its own unique ID. 

Test-specific field HL7v2 Element
Test ordered code OBR-4.1
Test ordered description OBR-4.2
Test performed code OBX[1]-3.1
Test performed description OBX[1]-3.2
Device identifier OBX[1]-17.1
Specimen type code SPM-4.1
Specimen type description SPM-4.2

 

The Test-Specific HL7v2 Field Values Tool is a tool that helps to identify the appropriate values for the above fields.
 

Receiver-specific fields for this project

Receiving
System

MSH
5.1

MSH
5.2

MSH
5.3

MSH
6.1

MSH
6.2

MSH
6.3

APHL AIMS Testing

AIMS.INTEGRATION.STG

2.16.840.1.114222.4.3.15.2

ISO

AIMS.PLATFORM

2.16.840.1.114222.4.1.217446

ISO

APHL AIMS Production

AIMS.INTEGRATION.PRD

2.16.840.1.114222.4.3.15.1

ISO

AIMS.PLATFORM

2.16.840.1.114222.4.1.217446

ISO

ReportStream CDC PRIME 2.16.840.1.114222.4.1.237821 ISO CDC PRIME 2.16.840.1.114222.4.1.237821 ISO

 

NIST HL7v2 validator instructions

NIST supports a web-based validation tool that app developers can use to test the HL7v2 messages created by different applications. 

Instructions:

  • Launch the NIST validator
  • Upper right > Tool Scopes > Select 'RADx MARS HL7v2'
  • Upper menu bar > Select 'Context-based'
  • Left hand menu > Click arrow next to 'HHS HL7 2.5.1'
  • Left hand menu > Click arrow next to 'Over-the-Counter (OTC)'
  • Left hand menu > Select test type
  • Top blue menu bar > Select 'Load Test Case'

Under 'Test steps execution' (blue bar), you will see several test message scenarios.

  • 'Message content' box > Paste a sample HL7 message.
  • 'Test steps execution' box > Check validation in 'Test step outcome' column 
  • 'Test steps execution' box > Click 'Next' to move to next step
  • After passing all scenarios - 'Test steps execution' box > Click 'Test summary'
  • 'Test result box' > Click 'Download' as PDF

Known conditions when validator will issue an error that can be ignored:

  • Foreign states, counties, and zip codes
  • Use of fake-CLIA numbers generated specifically for mobile applications

 

EmailFacebookLinkedInXWhatsAppShare