HL7 v2.5.1 Contents

HL7 Version 2.5.1

1 . Introduction

1.8 THE SCOPE OF HL7

1.9 REFERENCE DOCUMENTS

2 . Control

2.5.4 Message delimiters

2.6 MESSAGE CONSTRUCTION RULES

2.6.1 Rules for the sender

2.7 USE OF ESCAPE SEQUENCES IN TEXT FIELDS

2.8 VERSION COMPATIBILITY DEFINITION

2.9 MESSAGE PROCESSING RULES

2.9.3 Response using enhanced acknowledgement

2.10 SPECIAL HL7 PROTOCOLS

2.10.3 HL7 batch protocol

2.10.4 Modes for updating via repeating segments

2.11 LOCAL EXTENSION

2.12 CONFORMANCE USING MESSAGE PROFILES

2.12.1 Message profile

2.12.2 Use case model

2.12.3 Dynamic definition

2.12.4 Static definition

2.12.5 Profile type

2.12.6 Static definition concepts

2.12.7 Static definition - message level

2.12.8 Static definition - field level

2.12.9 Message profile document

2.12.10 Tools

2.13 CHAPTER FORMATS FOR DEFINING HL7 MESSAGES

2.14 ACKNOWLEDGMENT MESSAGES

2.15 MESSAGE CONTROL SEGMENTS

2.15.1 ADD - addendum segment

2.15.2 BHS - batch header segment

2.15.3 BTS - batch trailer segment

2.15.4 DSC - continuation pointer segment

2.15.5 ERR - error segment

2.15.6 FHS - file header segment

2.15.7 FTS - file trailer segment

2.15.8 MSA - message acknowledgment segment

2.15.9 MSH - message header segment

2.15.10 NTE - notes and comments segment

2.15.11 OVR - override segment

2.15.12 SFT - software segment

2.18 SAMPLE CONTROL MESSAGES

2.19 MESSAGE PROFILE DOCUMENT DEFINITION

2.20 OUTSTANDING ISSUES

2.A . Control (continued)

2.A.1 DATA TYPES

2.A.1.1 AD - address

2.A.1.2 AUI - authorization information

2.A.1.3 CCD - charge code and date

2.A.1.4 CCP - channel calibration parameters

2.A.1.5 CD - channel definition

2.A.1.6 CE - coded element

2.A.1.7 CF - coded element with formatted values

2.A.1.8 CNE - coded with no exceptions

2.A.1.9 CNN - composite ID number and name simplified

2.A.1.10 CP - composite price

2.A.1.11 CQ - composite quantity with units

2.A.1.12 CSU - channel sensitivity

2.A.1.13 CWE - coded with exceptions

2.A.1.14 CX - extended composite ID with check digit

2.A.1.15 DDI - daily deductible information

2.A.1.16 DIN - date and institution name

2.A.1.17 DLD - discharge to location and date

2.A.1.18 DLN - driver's license number

2.A.1.19 DLT - delta

2.A.1.20 DR - date/time range

2.A.1.24 ED - encapsulated data

2.A.1.25 EI - entity identifier

2.A.1.26 EIP - entity identifier pair

2.A.1.27 ELD - error location and description

2.A.1.28 ERL - error location

2.A.1.29 FC - financial class

2.A.1.30 FN - family name

2.A.1.34 ICD - insurance certification definition

2.A.1.38 LA1 - location with address variation 1

2.A.1.39 LA2 - location with address variation 2

2.A.1.42 MOC - money and charge code

2.A.1.43 MOP - money or percentage

2.A.1.44 MSG - message type

2.A.1.49 OCD - occurrence code and date

2.A.1.50 OSD - order sequence definition

2.A.1.51 OSP - occurrence span code and date

2.A.1.52 PIP - practitioner institutional privileges

2.A.1.53 PL - person location

2.A.1.54 PLN - practitioner license or other Id number

2.A.1.55 PPN - performing person time stamp

2.A.1.56 PRL - parent result link

2.A.1.57 PT - processing type

2.A.1.58 PTA - policy type and amount

2.A.1.59 QIP - query input parameter list

2.A.1.60 QSC - query selection criteria

2.A.1.61 RCD - row column definition

2.A.1.62 RFR - reference range

2.A.1.63 RI - repeat interval

2.A.1.64 RMC - room coverage

2.A.1.65 RP - reference pointer

2.A.1.66 RPT - repeat pattern

2.A.1.67 SAD - street address

2.A.1.68 SCV - scheduling class value pair

2.A.1.71 SPD - specialty description

2.A.1.72 SPS - specimen source

2.A.1.73 SRT - sort order

2.A.1.77 TS - time stamp

2.A.1.80 VH - visiting hours

2.A.1.81 VID - version identifier

2.A.1.82 VR - value range

2.A.1.83 WVI - channel identifier

2.A.1.84 WVS - waveform source

2.A.1.85 XAD - extended address

2.A.1.86 XCN - extended composite ID number and name for persons

2.A.1.87 XON - extended composite name and identification number for organizations

2.A.1.88 XPN - extended person name

2.A.1.89 XTN - extended telecommunication number

3 . Patient Administration

3.3.19.1 A19 usage notes

3.4 MESSAGE SEGMENTS

3.4.1 EVN - Event Type Segment

3.4.2 PID - Patient Identification Segment

3.4.3 PV1 - Patient Visit Segment

3.4.4 PV2 - Patient Visit - Additional Information Segment

3.4.5 NK1 - Next of Kin / Associated Parties Segment

3.4.6 AL1 - Patient Allergy Information Segment

3.4.7 IAM - Patient Adverse Reaction Information Segment - Unique Identifier

3.4.8 NPU - Bed Status Update Segment

3.4.9 MRG - Merge Patient Information Segment

3.4.10 PD1 - Patient Additional Demographic Segment

3.4.11 DB1 - Disability Segment

3.4.12 PDA - Patient Death and Autopsy Segment

3.5 EXAMPLE TRANSACTIONS

3.6 IMPLEMENTATION NOTES

3.6.2.1 Definitions: Merge, move, and change identifier events

3.6.2.2 Trigger events

3.6.5 Usage notes: Non-human PID patient identification

3.7 REFERENCED ORGANIZATIONS AND DOCUMENTS

4 . Order Entry

4.4.1 ORM - general order message (event O01)

4.5 GENERAL SEGMENTS

4.5.1 ORC - Common Order Segment

4.5.1.1.1 Table notes for order control codes of ORC

4.5.2 BLG - Billing Segment

4.5.3 OBR - Observation Request Segment

4.5.4 TQ1 - Timing/Quantity Segment

4.5.5 TQ2 - Timing/Quantity Relationship

4.5.6 IPC - Imaging Procedure Control Segment

4.6 GENERAL MESSAGE EXAMPLES

4.7 DIET TRIGGER EVENTS & MESSAGE DEFINITIONS

4.8 DIET SEGMENTS

4.8.1 ODS - dietary orders, supplements, and preferences segment

4.8.2 ODT - diet tray instructions segment

4.9 DIET MESSAGE EXAMPLES

4.10 SUPPLY TRIGGER EVENTS & MESSAGES

4.11 SUPPLY SEGMENTS

4.11.1 RQD - Requisition Detail Segment

4.11.2 RQ1 - Requisition Detail-1 Segment

4.12 SUPPLY MESSAGE EXAMPLES

4.13 PHARMACY/TREATMENT TRIGGER EVENTS & MESSAGES

4.13.20.1 Example

4.14 PHARMACY/TREATMENT SEGMENTS

4.14.1 RXO - Pharmacy/Treatment Order Segment

4.14.2 RXR - Pharmacy/Treatment Route Segment

4.14.3 RXC - Pharmacy/Treatment Component Order Segment

4.14.4 RXE - Pharmacy/Treatment Encoded Order Segment

4.14.5 RXD - Pharmacy/Treatment Dispense Segment

4.14.6 RXG - Pharmacy/Treatment Give Segment

4.14.7 RXA - Pharmacy/Treatment Administration Segment

4.15 PHARMACY/TREATMENT MESSAGE EXAMPLES

4.15.3 RXD segment field examples

4.16 PHARMACY/TREATMENT TRANSACTION FLOW DIAGRAM

4.17 VACCINE TRIGGER EVENTS & MESSAGE DEFINITIONS

4.18 VACCINE SEGMENTS

4.18.1 RXA - segment usage in vaccine messages

4.19 VACCINATION MESSAGE EXAMPLES

4.20 TRANSFUSION SERVICE (BLOOD BANK) TRIGGER EVENTS & MESSAGES

4.20.1 Usage notes for transfusion service messages

4.20.1.0 OMB use notes

4.21 TRANSFUSION SERVICE (BLOOD BANK) SEGMENTS

4.21.1 BPO - Blood Product Order Segment

4.21.2 BPX - Blood Product Dispense Status Segment

4.21.3 BTX - Blood Product Transfusion/Disposition Segment

4.24 OUTSTANDING ISSUES

5 . Query

5.2.5 Query specification formats

5.2.6 Summary chart of query/response pairs

5.3 QUERY/RESPONSE CONFORMANCE STATEMENT

5.3.1 Using the conformance statement

5.3.2 Formal specification of the conformance statement

5.3.3 Conformance statement templates

5.4 QUERY/RESPONSE MESSAGE PAIRS

5.5 QUERY/RESPONSE MESSAGE SEGMENTS

5.5.1 DSP - display data segment

5.5.2 QAK- query acknowledgment segment

5.5.3 QID- query identification segment

5.5.4 QPD - query parameter definition

5.5.4.3.1 Note on QPD usage for query by example variant.

5.5.5 QRI - query response instance segment

5.5.6 RCP - response control parameter segment

5.5.7 RDF - table row definition segment

5.5.8 RDT - table row data segment

5.6 AUXILIARY QUERY PROTOCOLS

5.6.1 Immediate vs. deferred response

5.7 PUBLISH AND SUBSCRIBE

5.9.1 Query by parameter (QBP) / segment pattern response (RSP)

5.9.1.1.1 Associated dispense history Conformance Statement

5.9.1.2 Comprehensive pharmacy information examples and Conformance Statement

5.9.1.2.1 Comprehensive pharmacy information Conformance Statement

5.9.2 Query using QSC variant / segment pattern response examples

5.9.2.1.1 Associated dispense information Conformance Statement

5.9.3 Query by parameter (QBP) / tabular response (RTB)

5.9.3.1.1 MPI Conformance Statement

5.9.3.2 Pharmacy example:

5.9.3.2.1 QBP/RTB dispense history Conformance Statement

5.9.4 Query using QSC variant / tabular response (RTB)

5.9.4.1.1 QBP/RTB dispense history Conformance Statement using QSC variant

5.9.5 Query by parameter (QBP) / display response (RDY)

5.9.6 Query using QSC variant (QBP) / display response (RDY)

5.9.6.1 Dispense history display Conformance Statement using QSC variant

5.9.7 Query by example (QBP) / tabular response (RTB)

5.10 SUPERCEDED QUERY/RESPONSE TRIGGER EVENTS AND MESSAGE PAIRS

5.10.1 Display message

5.10.2 Original mode queries

5.10.2.1.1 Original mode display query variants

5.10.3 Original mode deferred access

5.10.4 Enhanced mode queries

5.10.5 Other query/response message segments

5.10.5.2 ERQ - event replay query segment

5.10.5.3 QRD - original-style query definition segment

5.10.5.4 QRF - original style query filter segment

5.10.5.5 SPR - stored procedure request definition segment

5.10.5.6 URD - results/update definition segment

5.10.5.7 URS - unsolicited selection segment

5.10.5.8 VTQ - Virtual table query request segment

5.10.6 Other query examples

5.11 OUTSTANDING ISSUES

6 . Financial Management

6.5 MESSAGE SEGMENTS

6.5.1 FT1 - Financial Transaction Segment

6.5.2 DG1 - Diagnosis Segment

6.5.3 DRG - Diagnosis Related Group Segment

6.5.4 PR1 - Procedures Segment

6.5.5 GT1 - Guarantor Segment

6.5.6 IN1 - Insurance Segment

6.5.7 IN2 - Insurance Additional Information Segment

6.5.8 IN3 - Insurance Additional Information, Certification Segment

6.5.9 ACC - Accident Segment

6.5.10 UB1 - UB82 Data Segment

6.5.11 UB2 - UB92 Data Segment

6.5.12 ABS - Abstract Segment

6.5.13 BLC - Blood Code Segment

6.5.14 RMI - Risk Management Incident Segment

6.5.15 GP1 Grouping/Reimbursement - Visit Segment

6.5.16 GP2 Grouping/Reimbursement - Procedure Line Item Segment

6.6 EXAMPLE TRANSACTIONS

6.7 IMPLEMENTATION CONSIDERATIONS

7 Observation Reporting

7.3 GENERAL TRIGGER EVENTS & MESSAGE DEFINITIONS

7.4 GENERAL SEGMENTS

7.4.1 OBR - Observation Request Segment

7.4.2 OBX - Observation/Result Segment

7.4.3 SPM - Specimen Segment

7.5 EXAMPLES OF USE

7.6 CLINICAL TRIALS

7.6.1 Glossary

7.6.1.3 Data schedule:

7.7 CLINICAL TRIALS - TRIGGER EVENTS AND MESSAGE DEFINITIONS

7.8 CLINICAL TRIALS - SEGMENT DEFINITIONS

7.8.1 CSR - Clinical Study Registration Segment

7.8.2 CSP - Clinical Study Phase Segment

7.8.3 CSS - Clinical Study Data Schedule Segment

7.8.4 CTI - Clinical Trial Identification Segment

7.9 CLINICAL TRIALS - EXAMPLES OF USE

7.10 PRODUCT EXPERIENCE

7.10.1 Glossary

7.10.2 References

7.11 PRODUCT EXPERIENCE - TRIGGER EVENTS AND MESSAGE DEFINITIONS

7.12 PRODUCT EXPERIENCE - SEGMENT DEFINITIONS

7.12.1 PES - Product Experience Sender Segment

7.12.2 PEO - Product Experience Observation Segment

7.12.3 PCR - Possible Causal Relationship Segment

7.12.4 PSH - Product Summary Header Segment

7.12.5 PDC - Product Detail Country Segment

7.12.6 FAC - Facility Segment

7.14.1 Specific Observation Id Suffixes

7.15 WAVEFORM - TRIGGER EVENTS & MESSAGE DEFINITIONS

7.16 WAVEFORM - SEGMENT DEFINITIONS

7.17 WAVEFORM - EXAMPLES OF USE

7.18 TABLES LISTINGS

7.19 OUTSTANDING ISSUES

8 . Master Files

8.1 CHAPTER 8 CONTENTS

8.4.1 MFN/MFK - Master File Notification (Event M01)

8.4.2 MFN/MFK - Master File Notification - General (Event M13)

8.4.3 MFN/MFK - Master File Notification - Site Defined (Event M14)

8.4.4 MFQ/MFR - Master Files Query (Event M01-M14)

8.4.5 Example Conformance Based Master File Query

8.5 GENERAL MASTER FILE SEGMENTS

8.5.1 MFI - Master File Identification Segment

8.5.2 MFE - Master File Entry Segment

8.5.3 MFA - Master File Acknowledgment Segment

8.6 GENERIC MASTER FILE EXAMPLES

8.6.1 ZL7 Segment (Proposed Example Only)

8.6.2 MFN Message with Original Acknowledgment Mode

8.6.3 MFN message with enhanced Mode Application-Level Acknowledgment

8.7 STAFF AND PRACTITIONER MASTER FILES

8.8 SERVICE/TEST/OBSERVATIONS MASTER FILES

8.8.9 OM2 - Numeric Observation Segment

8.8.10 OM3 - Categorical Service/Test/Observation Segment

8.8.11 OM4 - Observations That Require Specimens Segment

8.8.12 OM5 - Observation Batteries (Sets) Segment

8.8.13 OM6 - Observations that are Calculated from Other Observations Segments

8.8.14 OM7 - Additional Basic Attributes (Fields That Apply to Most Observations/Services)

8.9 LOCATION MASTER FILES

8.9.3 LCH - Location Characteristic Segment

8.9.4 LRL - Location Relationship Segment

8.9.5 LDP - Location Department Segment

8.9.6 LCC - Location Charge Code Segment

8.9.7 Example: MFN Location Master File Message

8.10 CHARGE DESCRIPTION MASTER FILES

8.10.3 PRC - Pricing Segment

8.10.4 Example: MRN Message Charge Description Master File

8.11 CLINICAL TRIALS MASTER FILES

8.11.3 CM1 - Clinical Study Phase Master Segment

8.11.4 CM2 - Clinical Study Schedule Master Segment

8.12 INVENTORY ITEM MASTER FILES

8.13 EXAMPLES

8.13.1 Master file update examples: with original and enhanced acknowledgment protocol

8.14 OUTSTANDING ISSUES

9 . Medical Records/Information Management (Document Management)

9.2.1 Definition of Terms and Concepts

9.2.1.7 Legally Authenticated:

9.2.1.7.1 Pre-Authenticated:

9.6 MESSAGE SEGMENTS

9.6.1 TXA - Transcription Document Header Segment

9.6.2 OBX - Observation Segment Usage

9.8.1 QRY/DOC - Document Query (Event T12)

9.8.1.1 Query usage notes

9.9 CONSENT INFORMATION

9.10 OUTSTANDING ISSUES

10 . Scheduling

10.2.1 Schedules, Appointments, Services, and Resources

10.2.2 Application Roles

10.2.3 Trigger Events, Status, Reasons, and Types

10.2.6 Organization of This Chapter: Trigger Events and Message Definitions

10.3 PLACER APPLICATION REQUESTS AND TRIGGER EVENTS

10.4 FILLER APPLICATION MESSAGES AND TRIGGER EVENTS UNSOLICITED

10.5 QUERY TRANSACTIONS AND TRIGGER EVENTS

10.6 MESSAGE SEGMENTS

10.6.1 ARQ - Appointment Request Segment

10.6.2 SCH - Schedule Activity Information Segment

10.6.3 RGS - Resource Group Segment

10.6.4 AIS - Appointment Information - Service Segment

10.6.5 AIG - Appointment Information - General Resource Segment

10.6.6 AIL - Appointment Information - Location Resource Segment

10.6.7 AIP - Appointment Information - Personnel Resource Segment

10.6.8 APR - Appointment Preferences Segment

10.7 EXAMPLE TRANSACTIONS

10.8 IMPLEMENTATION CONSIDERATIONS

10.9 ISSUES

10.9.1 Logical Relationship of Resource and Service Segments

10.10 OUTSTANDING ISSUES

11 . Patient Referral

11.2.1 Patient Referral and Responses

11.2.2 Application Roles and Data Process

11.2.3 Glossary

11.3 PATIENT INFORMATION REQUEST MESSAGES AND TRIGGER EVENTS

11.4 PATIENT TREATMENT AUTHORIZATION REQUESTS

11.5 PATIENT REFERRAL MESSAGES AND TRIGGER EVENTS

11.6 SEGMENTS

11.6.1 RF1 - Referral Information Segment

11.6.2 AUT - Authorization Information Segment

11.6.3 PRD - provider data segment

11.6.4 CTD - Contact Data Segment

11.7 EXAMPLES

11.8 OUTSTANDING ISSUES

11.8.1 HL7 Overlapping With ASC X12N

12 . Patient Care

12.2.1 Glossary

12.2.2 Scenario Descriptions

12.2.5 Message Construction Rules

12.3 MESSAGE DEFINITIONS

12.4 MESSAGE SEGMENTS

12.4.1 GOL - Goal Detail Segment

12.4.2 PRB - Problem Detail Segment

12.4.5 VAR - Variance Segment

13 . Clinical Laboratory Automation

13.3 TRIGGER EVENTS AND MESSAGE DEFINITIONS

13.4 MESSAGE SEGMENTS

13.4.1 EQU - Equipment Detail Segment

13.4.2 ISD - Interaction Status Detail Segment

13.4.3 SAC- Specimen Container Detail Segment

13.4.4 INV - Inventory Detail Segment

13.4.5 ECD - Equipment Command Segment

13.4.6 ECR - Equipment Command Response Segment

13.4.7 NDS - Notification Detail Segment

13.4.8 CNS - Clear Notification Segment

13.4.9 TCC - Test Code Configuration Segment

13.4.10 TCD - Test Code Detail Segment

13.4.11 SID - Substance Identifier Segment

13.4.12 EQP - Equipment Log/Service Segment

13.5 NOTES REGARDING USAGE

13.6 EXAMPLE MESSAGES

13.7 OUTSTANDING ISSUES

14 . Application Management

14.3.1 NMQ - Application Management Query Message (Event N01)

14.3.1.0 QRD use notes

14.3.2 NMD - Application Management Data Message (Event N02)

14.4 MESSAGE SEGMENTS

14.4.1 NCK - System Clock Segment

14.4.2 NSC - Application Status Change Segment

14.4.3 NST - Application Control-Level Statistics Segment

14.5 OUTSTANDING ISSUES

15 . Personnel Management

15.2.1 Usage of Chapter 15 vs. Chapter 8

15.3 TRIGGER EVENTS AND MESSAGE DESCRIPTIONS

15.4 MESSAGE SEGMENTS

15.4.1 AFF - Professional Affiliation Segment

15.4.2 CER - Certificate Detail Segment

15.4.3 EDU - Educational Detail Segment

15.4.4 LAN - Language Detail Segment

15.4.5 ORG - Practitioner Organization Unit Segment

15.4.6 PRA - Practitioner Detail Segment

15.4.7 ROL - Role Segment

15.4.8 STF - Staff Identification Segment

15.5 EXAMPLE TRANSACTIONS

15.5.1 Add Personnel Record - Event B01

15.6 OUTSTANDING ISSUES