Skip to main content

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

HL7v2 Implementation Guide - Version History and Changelog

Below are versions of the MARS HL7v2 Implementation Guide and change logs.

- Updated some comments to provide better clarity

Download this version

1/24/2024

Fixed hyperlink to the "Test Specific HL7v2 Fields Tool"

Changed comment for OBX[1]-1 to ""1" NOTE: For multiplex tests, there shall be an OBX and an NTE segment for each result in the panel. Each result OBX segment shall follow the format given here for OBX[1]. D15The Set ID in OBX-1 must be incremented for each OBX segment. For SARS-CoV-2 reporting, the SARS-CoV-2 result must be the first OBX segment, followed by any other result OBX segments, and then the Age, Symptomatic, and Date of Onset OBX segments. Do not change the Set ID for the added NTE segments.".

Added "NOTE: For multiplex tests, this field must match across all result OBX segments." to the comments of OBX[1]-17.1 and OBX[1]-19.

Added "Note: This field must match across all OBX segments." to the comments of OBX[all]-11, OBX[all]-15.1, OBX[all]-23.1, OBX[all]-23.10, OBX[all]-24.1, and OBX[all]-24.3.

- Changed Mobile Application Requirements for ORC-22.1, ORC-22.3, ORC-22.4 and ORC-22.9 to Conditional as the requirements will forward from PID-11 or ORC-24 depending on prescription status

6/2/23

Added OBX[1]-5.7

Removed OBX[1]-24.5

Removed OBX[1]-24.9

Removed OBX[1]-29

Added OBX[2]-3.3

Removed OBX[2]-24.5

Removed OBX[2]-24.9

Removed OBX[3]-24.5

Removed OBX[3]-24.9

Removed OBX[4]-6.7

Removed OBX[4]-24.5

Removed OBX[4]-24.9

- Updated the links in the comments for PID-8, PID-10.1, PID-10.2, PID-22.1, and PID-22.2.

Download this version

- Corrected OBX[4]-5 comment from "When OBX-5 (Set 3) is valued “Y” and user enters valid date: {YYYYMMDDHHMMSS[+/-ZZZZ]}" to "When OBX-5 (Set 3) is valued “Y” and user enters valid date: {YYYYMMDD}".

- Added a default to PID-13 as ORC-23 is derived from PID-13. Changes are as follows:1. Added "Default to "PH" if user does not enter phone number or email address" to comments of PID-13.3

1. Added "Default to "PH" if user does not enter phone number or email address" to comments of PID-13.3

2. Added "Default to "111" if user does not enter phone number or email address" to comments of PID-13.6

3. Added "Default to "1111111" if user does not enter phone number or email address" to comments of PID-13.7

Download this Version

- Added SFT[2] for MakeMyTestCount.org senders

- Added note for multiplex tests in OBX[1]-1 comment

Download this Version

- Removed PID-11.5 comment.

- Changed OBX[2]-5 comment from ""Age in years; For de-identification, the hub will replace all ages > 89 with '00' according to HHS guildelines: https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-i…"" to ""Age in years""

- Changed OBX[4]-1 comment from ""When OBX-5.1 (Set 3) is valued ""Y"": ""4"""" to ""When OBX-5 (Set 4) is valued: ""4""""

- Changed OBX[4]-5 comment from ""When OBX-5 (Set 4) is valued: {YYYYMMDDHHMMSS[+/-ZZZZ]}"" to ""When OBX-5 (Set 3) is valued “Y” and user enters valid date: {YYYYMMDDHHMMSS[+/-ZZZZ]}""."

Download this Version   

Removed OBX-[1]-24.4

Removed OBX-[2]-24.4

Removed OBX-[3]-24.4

Removed OBX-[4]-24.4

Removed "Unknown" answer from OBX[3]-5 as AOE should not be sent if answer is unknown.

Download this Version   

Change from previous versions:

Added character limit to PID-3.1, ORC-3.1, OBR-3.1, and SPM-2.2.1

Changed comment for OBX[4]-1 from "When OBX-5.1 (Set 3) is valued: "Y"" to "When OBX-5.1 (Set 3) has value "Y": "4"".

Changed comment for OBX[1]-8.3 from "HL70396" to "HL70078"

Download this Version   

Change from previous versions:

Removed columns, "Requirement for anonymous reporting (no PII)" & "Requirement for identified reporting (includes PII)"

Added columns, "Mobile application requirement" & "User entry requirement"

 

Download this Version   

Change from previous versions: 

  1. Added OBX[1]-8 
  2. Updated OBX[3]-5 comments to include the code system versions 
  3. Updated MSH-2 to correct the subcomponent separator encoding character 

Download this version

Change from previous versions: 

  1. Updated PID-11.4 to 'Include if available' for Anonymous reporting
  2. Updated comment for OBX[2]-5 to describe ages>89

Download this version

Change from previous versions: 

  1. Added OBX[1]-5.7 
  2. Removed OBX[1]-24.5 
  3. Removed OBX[1]-24.9 
  4. Removed OBX[1]-29 
  5. Added OBX[2]-3.3 
  6. Removed OBX[2]-24.5 
  7. Removed OBX[2]-24.9 
  8. Removed OBX[3]-24.5 
  9. Removed OBX[3]-24.9 
  10. Removed OBX[4]-24.5 
  11. Removed OBX[4]-24.9 

Download this Version   

Original Version