HL7 Version 2.7 Contents

HL7 Version 2.7

1 . Introduction

1.8 THE SCOPE OF HL7

1.9 REFERENCE DOCUMENTS

2 . Control

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 Protocol for interpreting repeating segments or segment groups in an update Message

2.10.4.0 Snapshot mode update definition

2.10.4.1 Action code/unique identifier mode update definition

2.10.5 Protocol for interpreting repeating fields in an update message

2.11 LOCAL EXTENSION

2.12 CHAPTER FORMATS FOR DEFINING HL7 MESSAGES

2.13 ACKNOWLEDGMENT MESSAGES

2.13.1 ACK - general acknowledgment

2.14 MESSAGE CONTROL SEGMENTS

2.14.1 ADD - addendum segment

2.14.1.0 ADD-1 Addendum Continuation Pointer (ST) 00066

2.14.2 BHS - batch header segment

2.14.3 BTS - batch trailer segment

2.14.4 DSC - continuation pointer segment

2.14.5 ERR - error segment

2.14.6 FHS - file header segment

2.14.7 FTS - file trailer segment

2.14.8 MSA - message acknowledgment segment

2.14.9 MSH - message header segment

2.14.10 NTE - notes and comments segment

2.14.11 OVR - override segment

2.14.12 SFT - software segment

2.14.13 UAC - User Authentication Credential Segment

2.17 SAMPLE CONTROL MESSAGES

2.18 OUTSTANDING ISSUES

2 .A Control (continued)

2.A DATA TYPES

2.A.1 AD - address

2.A.2 AUI - authorization information

2.A.3 CCD - charge code and date

2.A.4 CCP - channel calibration parameters

2.A.5 CD - channel definition

2.A.8 CNE - coded with no exceptions

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

2.A.10 CP - composite price

2.A.11 CQ - composite quantity with units

2.A.12 CSU - channel sensitivity and units

2.A.13 CWE - coded with exceptions

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

2.A.15 DDI - daily deductible information

2.A.16 DIN - date and institution name

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

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

2.A.19 DLT - delta

2.A.20 DR - date/time range

2.A.24 ED - encapsulated data

2.A.25 EI - entity identifier

2.A.26 EIP - entity identifier pair

2.A.29 FC - financial class

2.A.30 FN - family name

2.A.34 ICD - insurance certification definition

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

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

2.A.42 MOC - money and charge code

2.A.43 MOP - money or percentage

2.A.44 MSG - message type

2.A.49 OCD - occurrence code and date

2.A.52 PIP - practitioner institutional privileges

2.A.53 PL - person location

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

2.A.55 PPN - performing person time stamp

2.A.56 PRL - parent result link

2.A.57 PT - processing type

2.A.58 PTA - policy type and amount

2.A.59 QIP - query input parameter list

2.A.60 QSC - query selection criteria

2.A.61 RCD - row column definition

2.A.62 RFR - reference range

2.A.63 RI - repeat interval

2.A.64 RMC - room coverage

2.A.65 RP - reference pointer

2.A.66 RPT - repeat pattern

2.A.67 SAD - street address

2.A.68 SCV - scheduling class value pair

2.A.81 VH - visiting hours

2.A.82 VID - version identifier

2.A.83 VR - value range

2.A.84 WVI - channel identifier

2.A.85 WVS - waveform source

2.A.86 XAD - extended address

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

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

2.A.89 XPN - extended person name

2.A.90 XTN - extended telecommunication number

2 .B Control (continued)

2.B CONFORMANCE USING MESSAGE PROFILES

2.B.1 Message profile

2.B.4 Static definition

2.B.5 Table definition

2.B.6 Profile type

2.B.7 Static definition concepts

2.B.8 Static definition - message level

2.B.9 Static definition - field level

2.B.10 Message profile document

2.B.13 Outstanding Issues

2 .C Control (continued)

2.C CODE TABLES

2.C.1 DEFINITIONS:

2.C.2 HL7 and User-Defined code Tables

3 . Patient Administration

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

3.4.8 IAR - Allergy Reaction Segment

3.4.9 NPU - Bed Status Update Segment

3.4.10 MRG - Merge Patient Information Segment

3.4.11 PD1 - Patient Additional Demographic Segment

3.4.12 DB1 - Disability Segment

3.4.13 PDA - Patient Death and Autopsy Segment

3.4.14 ARV Access Restrictions segment

3.5 EXAMPLE TRANSACTIONS

3.6 IMPLEMENTATION NOTES

3.6.2.0 Definitions: Merge, move, and change identifier events

3.6.2.1 Trigger events

3.6.4.3.1 Figure 3-1 - Client system assigns identifier, person exists on MPI only

3.6.4.4 Client system assigns identifier, person exists on both systems

3.6.4.4.1 Figure 3-2 - Client system assigns identifier, person exists on both systems

3.6.4.5 Client system assigns identifier, person exists on neither system

3.6.4.5.1 Figure 3-3 - Client system assigns identifier, does not exist on either system

3.6.4.6 MPI assigns identifier, person exists on MPI

3.6.4.7 MPI assigns identifier, person exists on both systems

3.6.4.7.1 Figure 3- 6 - MPI assigns identifier, person exists on both systems

3.6.4.8 MPI assigns identifier, person exists on neither system

3.6.4.8.1 Figure 3-7 - MPI assigns identifier, person exists on neither system

3.6.5 Usage notes: Non-human PID patient identification

3.7 REFERENCED ORGANIZATIONS AND DOCUMENTS

4 . Order Entry: General, Laboratory, Dietary, Supply, Blood Transfusion

4.5 GENERAL SEGMENTS

4.5.1 ORC - Common Order Segment

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.6.2.0 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 TRANSFUSION SERVICE (BLOOD BANK) TRIGGER EVENTS & MESSAGES

4.13.1 Usage notes for transfusion service messages

4.13.1.0 The NTE segment(s) can be included in the OMB message in four places; in each place the NTE refers to the segment that it follows. In particular, the NTEs following the MSH refer only to the message header; the NTEs following the blood product order segment apply to the service defined by that ORC and blood product order segment.

4.14 TRANSFUSION SERVICE (BLOOD BANK) SEGMENTS

4.14.1 BPO - Blood Product Order Segment

4.14.2 BPX - Blood Product Dispense Status Segment

4.14.3 BTX - Blood Product Transfusion/Disposition Segment

4.16.1 Figure 4-8 Associations between Order Control Codes and Trigger Events

4.17 OUTSTANDING ISSUES

4 .A Order Entry: Pharmacy/Treatment, Vaccination

4.A ORDER ENTRY: PHARMACY/TREATMENT, VACCINATION

4.A.4 Pharmacy/Treatment Segments

4.A.4.0 RXO - Pharmacy/Treatment Order Segment

4.A.4.1 RXR - Pharmacy/Treatment Route Segment

4.A.4.2 RXC - Pharmacy/Treatment Component Order Segment

4.A.4.3 RXE - Pharmacy/Treatment Encoded Order Segment

4.A.4.4 RXD - Pharmacy/Treatment Dispense Segment

4.A.4.5 RXG - Pharmacy/Treatment Give Segment

4.A.4.6 RXA - Pharmacy/Treatment Administration Segment

4.A.5 Pharmacy/Treatment Message Examples

4.A.5.1.2 RXO-18 and RXO-19 Requested Strength and Strength Unit examples

4.A.5.2 RXD segment field examples

4.A.6 Pharmacy/Treatment Transaction Flow Diagram

4.A.7 Vaccine Trigger Events & Message Definitions

4.A.8 Vaccine Segments

4.A.8.0 RXA - segment usage in vaccine messages

4.A.9 Vaccination Message Examples

5 . Query

5.2.5 Query specification formats

5.2.5.0 Expressing the same data using the variants

5.2.6 Summary chart of query/response pairs

5.3 QUERY/RESPONSE PROFILE

5.3.1 Using the Query Profile

5.3.2 Formal specification of the Query Profile

5.3.3 Query Profile 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.2.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.5.8.0 RDT-1 Column Value (varies) 00703

5.6 AUXILIARY QUERY PROTOCOLS

5.6.1 Immediate vs. deferred response

5.7 PUBLISH AND SUBSCRIBE

5.7.3.0 Example of a publish and subscribe Query Profile

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

5.9.1.0 Proposed dispense history example and Query Profile

5.9.1.0.1 Associated dispense history Query Profile

5.9.1.1 Comprehensive pharmacy information examples and Query Profile

5.9.1.1.1 Comprehensive pharmacy information Query Profile

5.9.2 Query using QSC variant / segment pattern response examples

5.9.2.0 Dispense information example and Query Profile

5.9.2.0.1 Associated dispense information Query Profile

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

5.9.3.0 MPI example

5.9.3.0.1 MPI Query Profile

5.9.3.1 Pharmacy example:

5.9.3.1.1 QBP/RTB dispense history Query Profile

5.9.4 Query using QSC variant / tabular response (RTB)

5.9.4.0 Pharmacy example

5.9.4.0.1 QBP/RTB dispense history Query Profile using QSC variant

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

5.9.5.0 Dispense history display Query Profile

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

5.9.6.0 Dispense history display Query Profile using QSC variant

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

5.10 SUPERSEDED QUERY/RESPONSE TRIGGER EVENTS AND MESSAGE PAIRS

5.10.1 Display message

5.10.2 Original mode queries

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 - Uniform Billing 1 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

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.4.4 PRT - Participation Information Segment

7.5 EXAMPLES OF USE

7.6 CLINICAL TRIALS

7.6.1 Glossary

7.6.1.2 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- SEGMENT DEFINITIONS

7.17 WAVEFORM - EXAMPLES OF USE

7.18 SPECIMEN SHIPMENT MANIFEST

7.18.1 OSM - Unsolicited Specimen Shipment Manifest Message (Event R26)

7.18.2 SHP - Shipment Segment

7.18.3 PAC - Shipment Package Segment

7.19 TABLES LISTINGS

7.20 OUTSTANDING ISSUES

8 . Master Files

8.4.2.0 MFK use notes

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

8.4.4 MFQ/MFR - Master Files Query [WITHDRAWN] (Event M01-M17)

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.2.0 Example message

8.6.3 MFN message with enhanced Mode Application-Level Acknowledgment

8.6.3.0 Example message

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: MFN 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 DRG MASTER FILES

8.14 EXAMPLES

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

8.15 OUTSTANDING ISSUES

9 . Medical Records/Information Management (Document Management)

9.2.1 Definition of Document Management Terms and Concepts

9.2.2 Definition of Consent Terms and Concepts

9.4.0.-1.1 Example 1:

9.7 MESSAGE SEGMENTS

9.7.1 CON - Consent Segment

9.8 EXAMPLE MESSAGES

9.9 QUERY

9.9.1 QRY/DOC - Document Query (Event T12)

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.2.6.0 Update mode

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

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 COLLABORATIVE CARE MESSAGES AND TRIGGER EVENTS

11.7 COLLABORATIVE CARE INFORMATION REQUEST MESSAGES AND TRIGGER EVENTS

11.8 SEGMENTS

11.8.1 RF1 - Referral Information Segment

11.8.2 AUT - Authorization Information Segment

11.8.3 PRD - provider data segment

11.8.4 CTD - Contact Data Segment

11.9 EXAMPLES

11.10 OUTSTANDING ISSUES

11.10.1 HL7 Overlapping With ASC X12N

12 . Patient Care

12.2.1 Glossary

12.2.2 Scenario Descriptions

12.2.4.0 Examples of action code usage

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 PRB

12.4.3 PTH - Pathway Segment

12.4.4 VAR - Variance Segment

12.4.5 REL - Clinical Relationship 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.4 MESSAGE SEGMENTS

14.4.1 NCK - System Clock Segment

14.4.1.0 NCK-1 System Date/time (DTM) 01172

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

16 . Claims and Reimbursement

16.2.1 Scope

16.3 TRIGGER EVENTS AND MESSAGE DEFINITIONS

16.4 MESSAGE SEGMENTS

16.4.1 RFI - Request for Information

16.4.2 IVC - Invoice Segment

16.4.3 PYE - Payee Information Segment

16.4.4 PSS - Product/Service Section Segment

16.4.5 PSG - Product/Service Group Segment

16.4.6 PSL - Product/Service Line Item Segment

16.4.7 ADJ - Adjustment

16.4.8 PMT - Payment Information Segment

16.4.9 IPR - Invoice Processing Results Segment

16.5 OUTSTANDING ISSUES

17 . Materials Management

17.2.1 Inventory Item Master Updates

17.3 TRIGGER EVENTS

17.3.3 Organization of This Chapter: Trigger Events and Message Definitions

17.3.3.0 Update mode

17.4 INVENTORY ITEM MASTER MESSAGES SEGMENTS

17.4.1 IIM - Inventory Item Master Segment

17.4.2 ITM - Material Item Segment

17.4.3 STZ - Sterilization Parameter Segment

17.4.4 VND - Purchasing Vendor Segment

17.4.5 PKG - Packaging Segment

17.4.6 PCE - Patient Charge Cost Center Exception

17.4.7 IVT - Material Location Segment

17.4.8 ILT - Material Lot Segment

17.5 PLACER APPLICATION REQUESTS AND TRIGGER EVENTS

17.6 FILLER APPLICATION MESSAGES AND TRIGGER EVENTS UNSOLICITED

17.7 STERILIZATION AND DECONTAMINATION MESSAGE SEGMENTS

17.7.1 SCP - Sterilizer Configuration Segment

17.7.2 SLT - Sterilization Lot Segment

17.7.3 SDD - Sterilization Device Data Segment

17.7.4 SCD - Anti-Microbial Cycle Data Segment

17.8 EXAMPLE TRANSACTIONS