You are on page 1of 20

HL7

v2.5
SPECIFICATION
GUIDE

HL7 version 2.5 update

www.corepointhealth.com
HL7@corepointhealth.com

HL7 Reference Guide

HL7 Standard

Introduction

HL7 v2.x Specification

This is an update to the Corepoint Health HL7 Reference Guide that includes

Unlike many protocol specifications, which contain cookbook-like rules for


exchanging data, the HL7 v2.x specification is like a catalog for creating HL7 messages. The HL7 standard provides a shopping list of message ingredients to discuss
and negotiate. The key point is that each vendor who implements HL7 may interpret
the specification slightly differently, using slightly different ingredients to send the
same information.

HL7 V2.5.
Please continue to use the HL7 Reference Guide, Second Edition, for a
complete overview of HL7 and industry best practices.
Read current insights and commentary about HL7 at www.HL7Standards.com
or the HL7 Resource Center at www.corepointhealth.com.
Thank you for your support and participation in the HL7 community!

HL7 Table of Contents (v2.5)


Chapter 1............................................................................ Introduction (HL7 Overview)
Chapter 2 & 2A...................................................................................................... Control
Chapter 3............................................................................Patient Administration (ADT)
Chapter 4............................................................................................ Order Entry (ORM)
Chapter 5................................................................................................................. Query
Chapter 6...................................................................Financial Management (BAR/DFT)
Chapter 7.......................................................................... Observation Reporting (ORU)
Chapter 8...............................................................................................Master Files (MF)
Chapter 9........Medical Records/Information Management (Document Management)
Chapter 10....................................................................................................... Scheduling
Chapter 11................................................................................................Patient Referral
Chapter 12..................................................................................................... Patient Care
Chapter 13.................................................................................. Laboratory Automation
Chapter 14............................................................................... Application Management
Chapter 15..................................................................................Personnel Management
Appendix A....................................................................................Data Definition Tables
Appendix B....................................................................................Lower Layer Protocols
Appendix C................................................................................. \ Message Descriptions
Appendix D......................................................................................................... Glossary
Note: Chapters in red denote chapters that are new in the
v2.5 specification.

The HL7 v2.x specification is a complex specification, defining required and optional
message ingredients for every HL7 message. Starting at chapter 2, each chapter of the
HL7 standard defines the ingredients that can be used when creating HL7 messages
for a specific healthcare problem area (i.e. patient tracking, orders, results, etc.).
The HL7 v2.5 specification is over 1500 pages long. To avoid duplication of data within
the specification, references are made to information previously defined, making the
specification easier to keep updated, but harder to read.
It is difficult to gain the big picture of HL7 by reading the specification. Therefore,
training is recommended as the most effective way to learn HL7. Visit the NeoTool
website for information on HL7 training.
Due to the varying nature of information exchanged within an HL7 message, HL7 messages have been defined with many levels of information. In the HL7 v2.x standard:

Real

world events are represented as triggers
Triggers

are modeled as messages
Messages

are built using segments
Segments

are built of fields
Fields

are built of components/data
HL7 Version 2.5 introduces a number of new events, segments and messages, as well
as a significantly expanded chapter on Control. Version 2.5 is more consistent and
supports more functionality than any of the previous versions.
NOTE: Only voting members can download final specifications of the latest HL7 version from www.hl7.org.
To get a copy of an approved HL7 Specification, you must purchase it from HL7.
1. Join the HL7 organization!
Members get discounts. HL7 specifications cost $25 - $250.
2. Non-member copies of HL7 specifications cost $450 - $700.

w w w . c o r e p o i n t h e a lt h . c o m

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

HL7 MESSAGE TYPES (HL7 TABLE 0076)

Message

Description

Message

Description

MDM

Medical document management

ACK

General acknowledgement

MFD

Master files delayed application acknowledgement

ADR

ADT response

MFK

Master files application acknowledgement

ADT

ADT message

MFN

Master files notification

ARD

Ancillary RPT (display) (removed in 2.3.1)

MFQ

Master files query

BAR

Add / change billing account

MFR

Master files response

BPS

Blood product dispense status

NMD

Application management data

BRP

Blood product dispense status acknowledgement

NMQ

Application management query

BRT

Blood product transfusion/disposition acknowledgement

NMR

Application management response

BTS

Blood product transfusion/disposition

OMB

Blood product order

CNQ

Cancel query (removed in 2.3.1)

OMD

Dietary order

CRM

Clinical study registration

OMG

General clinical order

CSU

Unsolicited study data

OMI

Imaging order

DFT

Detail financial transactions

OML

Laboratory order

DOC

Document response

OMN

Non-stock requisition order

DSR

Display response

OMP

Pharmacy/treatment order

EAC

Automated equipment command

OMS

Stock requisition order

EAN

Automated equipment notification

ORB

Blood product order acknowledgement

EAR

Automated equipment response

ORD

Dietary order acknowledgement

EDR

Enhanced display response

ORF

Query for results of observation

EQQ

Embedded query language query

ORG

General clinical order acknowledgement

ERP

Event replay response

ORI

Imaging order acknowledgement

ESR

Automated equipment status update acknowledgement

ORL

Laboratory acknowledgement (unsolicited)

ESU

Automated equipment status update

ORM

Order (Pharmacy/treatment)

INR

Automated equipment inventory request

ORN

Non-stock requisition - general order acknowledgement

INU

Automated equipment inventory update

ORP

Pharmacy/treatment order acknowledgement

LSR

Automated equipment log/service request

ORR

General order response to any ORM

LSU

Automated equipment log/service update

ORS

Stock requisition - order acknowledgement

MCF

Delayed acknowledgement (bc)

ORU

Observation result (unsolicited)

Red = new (v2.5) HL7 message types.

OSQ

Order status query

(bc) = Retained for backward compatibility only

Red = new (v2.5) HL7 message types.


(bc) = Retained for backward compatibility only

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Message

Description

Message

Description

OSR

Query response for order status

RER

Pharmacy/treatment encoded order information

OUL

Unsolicited laboratory observation

RGR

Pharmacy/treatment dose information

PEX

Product experience

RGV

Pharmacy/treatment give

PGL

Patient goal

ROR

Pharmacy/treatment order response

PIN

Patient insurance info

RPA

Return patient authorization

PMU

Add personnel record

RPI

Return patient information

PPG

Patient pathway (goal-oriented)

RPL

Return patient display list

PPP

Patient pathway (problem-oriented)

RPR

Return patient list

PPR

Patient problem

RQA

Request patient authorization

PPT

Patient pathway goal-oriented response

RQC

Request clinical information

PPV

Patient goal response

RQI

Request patient info

PRM

Response to request for personnel data

RQP

Request patient demographics

PRR

Patient problem response

RQQ

Event replay query

PTR

Patient pathway problem-oriented response

RRA

Pharmacy/treatment administration acknowledgement

QBP

Query by parameter

RRD

Pharmacy/treatment dispense acknowledgement

QCK

Deferred query

RRE

Pharmacy/treatment encoded order acknowledgement

QCN

Cancel query

RRG

Pharmacy/treatment give acknowledgement

QRY

Query, original mode

RRI

Return referral information

QSB

Create subscription

RSP

Segment pattern response

QSX

Cancel subscription/acknowledge

RTB

Tabular response

QVR

Query for previous events

SIU

Schedule information unsolicited

RAR

Pharmacy/treatment administration information

SPQ

Stored procedure request

RAS

Pharmacy/treatment administration

SQM

Schedule query

RCI

Return clinical information

SQR

Schedule query response

RCL

Return clinical list

SRM

Schedule request

RDE

Pharmacy/treatment encoded order

SRR

Schedule request response

RDR

Pharmacy/treatment dispense information

SSR

Specimen status request

RDS

Pharmacy/treatment dispense

SSU

Specimen status update

RDY

Display based response

SUR

Summary product experience report

REF

Patient referral

TBR

Tabular data response

Red = new (v2.5) HL7 message types.

Red = new (v2.5) HL7 message types.

(bc) = Retained for backward compatibility only

(bc) = Retained for backward compatibility only

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Message

Description

Event

Description

TCR

Automated equipment test code settings request

A16

ADT/ACK - Pending discharge

TCU

Automated equipment test code settings update

A17

ADT/ACK - Swap patients

UDM

Unsolicited display update

VQQ

Virtual table query

A18

ADT/ACK - Merge patient information (bc)


Deprecated - use A40-45, A47, and A49-51

VXQ

Query for vaccination record

A19

VXR

Vaccination record response

A20

ADT/ACK - Bed status update

VXU

Unsolicited vaccination record update

A21

ADT/ACK - Patient goes on a leave of absence

VXX

Response for vaccination query with multiple PID matches

A22

ADT/ACK - Patient returns from a leave of absence

Any Z message event type (e.g., ZZZ, ZXX, etc.) is site or vendor defined.
See local or vendor documents for details.

A23

ADT/ACK - Delete a patient record

A24

ADT/ACK - Link patient information

A25

ADT/ACK - Cancel pending discharge

A26

ADT/ACK - Cancel pending transfer

A27

ADT/ACK - Cancel pending admit

A28

ADT/ACK - Add person information

A29

ADT/ACK - Delete person information

A30

ADT/ACK - Merge person information (bc)

A31

ADT/ACK - Update person information

A32

ADT/ACK - Cancel patient arriving - tracking

A33

ADT/ACK - Cancel patient departing - tracking

Red = new (v2.5) HL7 message types.


(bc) = Retained for backward compatibility only

HL7 MESSAGE EVENT typeS (HL7 TABLE 0003)


Event

Description

A01

ADT/ACK - Admit/visit notification

QRY/ADR - Patient query

A02

ADT/ACK - Transfer a patient

A03

ADT/ACK - Discharge/end visit

A04

ADT/ACK - Register a patient

A05

ADT/ACK - Pre-admit a patient

A06

ADT/ACK - Change an outpatient to an inpatient

A07

ADT/ACK - Change an inpatient to an outpatient

A08

ADT/ACK - Update patient information

A09

ADT/ACK - Patient departing - tracking

A10

ADT/ACK - Patient arriving - tracking

A37

ADT/ACK - Unlink patient information

A11

ADT/ACK - Cancel admit/visit notification

A38

ADT/ACK - Cancel pre-admit

A12

ADT/ACK - Cancel transfer

A13

ADT/ACK - Cancel discharge/end visit

A14

ADT/ACK - Pending admit

A40

ADT/ACK - Merge patient - patient identifier list

A15

ADT/ACK - Pending transfer

A41

ADT/ACK - Merge account - patient account number

A34

A35

A36

A39

ADT/ACK - Merge patient information - patient ID only (bc)


Deprecated - use A40-45, A47, and A49-51
ADT/ACK - Merge patient information - account number only (bc)
Deprecated - use A40-45, A47, and A49-51
ADT/ACK - Merge patient information - patient ID and account number (bc)
Deprecated - use A40-45, A47, and A49-51

ADT/ACK - Merge person - patient ID (bc)


Deprecated - use A40-45, A47, and A49-51

Red = new (v2.5) HL7 message event types.

Red = new (v2.5) HL7 message event types.

(bc) = Retained for backward compatibility only

(bc) = Retained for backward compatibility only

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Event

Description

Event

Description

A42

ADT/ACK - Merge visit - visit number

C04

CRM - Patient has gone off a clinical trial

A43

ADT/ACK - Move patient information - patient identifier list

C05

CRM - Patient enters phase of clinical trial

A44

ADT/ACK - Move account information - patient account number

C06

CRM - Cancel patient entering a phase (clerical mistake)

A45

ADT/ACK - Move visit information - visit number

C07

CRM - Correct/update phase information

ADT/ACK - Change patient ID (bc)

C08

CRM - Patient has gone off phase of clinical trial

Deprecated - use A40-45, A47, and A49-51

C09

CSU - Automated time intervals for reporting (i.e. monthly)

ADT/ACK - Change patient identifier list

C10

CSU - Patient completes the clinical trial

ADT/ACK - Change alternate patient ID (bc)

C11

CSU - Patient completes a phase of the clinical trial

C12

CSU - Update/correction of patient order/result information

CNQ

QRY/EQQ/SPQ/VQQ/RQQ - Cancel query

I01

RQI/RPI - Request for insurance information

I02

RQI/RPL - Request/receipt of patient selection display list

I03

RQI/RPR - Request/receipt of patient selection list

I04

RQD/RPI - Request for patient demographic data

I05

RQC/RCI - Request for patient clinical information

I06

RQC/RCL - Request/receipt of clinical data listing

I07

PIN/ACK - Unsolicited insurance information

I08

RQA/RPA - Request for treatment authorization information

I09

RQA/RPA - Request for modification to an authorization

I10

RQA/RPA - Request for resubmission of an authorization

I11

RQA/RPA - Request for cancellation of an authorization

I12

REF/RRI - Patient referral

I13

REF/RRI - Modify patient referral

I14

REF/RRI - Cancel patient referral

I15

REF/RRI - Request patient referral status

J01

QCN/ACK - Cancel query/acknowledge message

J02

QSX/ACK - Cancel subscription/acknowledge message

K11

RSP - Segment pattern response to QBP^Q11

K13

RTB - Tabular response to QBP^Q13

K15

RDY - Display response to QBP^Q15

A46
A47
A48

Deprecated - use A40-45, A47, and A49-51

A49

ADT/ACK - Change patient account number

A50

ADT/ACK - Change visit number

A51

ADT/ACK - Change alternate visit ID

A52

ADT/ACK - Cancel leave of absence for a patient

A53

ADT/ACK - Cancel patient returns from leave of absence

A54

ADT/ACK - Change attending doctor

A55

ADT/ACK - Cancel change attending doctor

A60

ADT/ACK - Update allergy information

A61

ADT/ACK - Change consulting doctor

A62

ADT/ACK - Cancel change consulting doctor

B01

PMU/ACK - Add personnel record

B02

PMU/ACK - Update personnel record

B03

PMU/ACK - Delete personnel record

B04

PMU/ACK - Active practicing person

B05

PMU/ACK - Deactivate practicing person

B06

PMU/ACK - Terminate practicing person

B07

PMU/ACK - Grant certificate/permission

B08

PMU/ACK - Revoke certificate/permission

C01

CRM - Register a patient on a clinical trial

C02

CRM - Cancel a patient registration on clinical trial (for clerical mistakes only)

C03

CRM - Correct/update registration information

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

10

11

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Event

Description

Event

Description

K21

RSP - Get person demographics response

O09

OMP - Pharmacy/treatment order

K22

RSP - Find candidates response

O10

ORP - Pharmacy/treatment order acknowledgement

K23

RSP - Get corresponding identifiers response

O11

RDE - Pharmacy/treatment encoded order

K24

RSP - Allocate identifiers response

O12

RRE - Pharmacy/treatment encoded order acknowledgement

K25

RSP - Personnel information by segment response

O13

RDS - Pharmacy/treatment dispense

M01

MFN/MFK - Master file not otherwise specified (bc)

O14

RRD - Pharmacy/treatment dispense acknowledgement

M02

MFN/MFK - Master file - staff practitioner

O15

RGV - Pharmacy/treatment give

M03

MFN/MFK - Master file - test/observation (bc)

O16

RRG - Pharmacy/treatment give acknowledgement

M04

MFN/MFK - Master files charge description

O17

RAS - Pharmacy/treatment administration

M05

MFN/MFK - Patient location master file

O18

RRA - Pharmacy/treatment administration acknowledgement

M06

MFN/MFK -Clinical study with phases and schedules master file

O19

OMG - General clinical order

M07

MFN/MFK - Clinical study without phases but with schedules master file

O20

ORG/ORL - General clinical order response

M08

MFN/MFK - Test/observation (numeric) master file

O21

OML - Laboratory order

M09

MFN/MFK - Test/observation (categorical) master file

O22

ORL - General laboratory order response message to any OML

M10

MFN/MFK - Test /observation batteries master file

O23

OMI - Imaging order

M11

MFN/MFK - Test/calculated observations master file

O24

ORI - Imaging order response message to any OMI

M12

MFN/MFK - Master file notification message

O25

RDE - Pharmacy/treatment refill authorization request

M13

MFN/MFK - Master file notification - general

O26

RRE - Pharmacy/treatment refill authorization acknowledgment

M14

MFN/MFK - Master file notification - site defined

O27

OMB - Blood product order

M15

MFN/MFK - Inventory item master file notification

O28

ORB - Blood product order acknowledgement

N01

NMQ/NMR - Application management query message

O29

BPS - Blood product dispense status

N02

NMD/ACK - Application management data message (unsolicited)

O30

BRP - Blood product dispense status acknowledgement

O01

ORM - Order message (also RDE, RDS, RGV, RAS)

O31

BTS - Blood product transfusion/disposition

O02

ORR - Order response (also RRE, RRD, RRG, RRA)

O32

BRT - Blood product transfusion/disposition acknowledgement

O03

OMD - Diet order

O33

OML - Laboratory order for multiple orders related to a single specimen

O04

ORD - Diet order acknowledgement

O34

O05

OMS - Stock requisition order

ORL - Laboratory order response message to a multiple order related to single


specimen OML

O06

ORS - Stock requisition acknowledgement

O35

OML - Laboratory order for multiple orders related to a single container of a


specimen

O07

OMN - Non-stock requisition order

O08

ORN - Non-stock requisition acknowledgement

O36

ORL - Laboratory order response for multiple orders related to a single container
of a specimen OML

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

12

13

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Event

Description

Event

Description

P01

BAR/ACK - Add patient accounts

PCK

QRY - PC/ pathway (goal-oriented) query

P02

BAR/ACK - Purge patient accounts

PCL

PPT - PC/ pathway (goal-oriented) query response

P03

DFT/ACK - Post detail financial transaction

Q01

QRY/DSR - Query sent for immediate response

P04

QRY/DSP - Generate bill and A/R statements

Q02

QRY/QCK - Query sent for deferred response

P05

BAR/ACK - Update account

Q03

DSR/ACK - Deferred response to a query

P06

BAR/ACK - End account

Q04

EQQ - Embedded query language query

P07

PEX - Unsolicited initial individual product experience report

Q05

UDM/ACK - Unsolicited display update message

P08

PEX - Unsolicited update individual product experience report

Q06

OSQ/OSR - Query for order status

P09

SUR - Summary product experience report

Q07

VQQ - Virtual table query

P10

BAR/ACK -Transmit Ambulatory Payment Classification (APC)

Q08

SPQ - Stored procedure request

P11

DFT/ACK - Post detail financial transactions - new

Q09

RQQ - Event replay query

P12

BAR/ACK - Update diagnosis/procedure

Q11

QBP - Query by parameter requesting an RSP - segment pattern response

PC1

PPR - PC/ problem add

Q13

QBP - Query by parameter requesting an RTB - tabular response

PC2

PPR - PC/ problem update

Q15

QBP - Query by parameter requesting an RDY- display response

PC3

PPR - PC/ problem delete

Q16

QSB - Create subscription

PC4

QRY - PC/ problem query

Q17

QVR - Query for previous events

PC5

PRR - PC/ problem response

Q21

QBP - Get person demographics

PC6

PGL - PC/ goal add

Q22

QBP - Find candidates

PC7

PGL - PC/ goal update

Q23

QBP - Get corresponding identifiers

PC8

PGL - PC/ goal delete

Q24

QBP - Allocate identifiers

PC9

QRY - PC/ goal query

Q25

QBP - Personnel information by segment query

PCA

PPV - PC/ goal response

Q26

ROR - Pharmacy/treatment order response

PCB

PPP - PC/ pathway (problem-oriented) add

Q27

RAR - Pharmacy/treatment administration information

PCC

PPP - PC/ pathway (problem-oriented) update

Q28

RDR - Pharmacy/treatment dispense information

PCD

PPP - PC/ pathway (problem-oriented) delete

Q29

RER- Pharmacy/treatment encoded order information

PCE

QRY - PC/ pathway (problem-oriented) query

Q30

RGR - Pharmacy/treatment dose information

PCF

PTR - PC/ pathway (problem-oriented) query response

R01

ORU/ACK - Unsolicited transmission of an observation message

PCG

PPG - PC/ pathway (goal-oriented) add

R02

QRY - Query for results of observation

PCH

PPG - PC/ pathway (goal-oriented) update

R03

PCJ

PPG - PC/ pathway (goal-oriented) delete

QRY/DSR - Display-oriented results, query/unsolicited update (bc) (Replaced by


Q05)

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

14

15

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Event

Description

Event

Description

R04

ORF - Response to query; transmission of requested observation

S12

SIU/ACK - Notification of new appointment booking

R05

QRY/DSR - Query for display results (omitted in 2.5)

S13

SIU/ACK - Notification of appointment rescheduling

R06

UDM - Unsolicited update/display results (omitted in 2.5)

S14

SIU/ACK - Notification of appointment modification

R07

EDR - Enhanced display response

S15

SIU/ACK - Notification of appointment cancellation

R08

TBR - Tabular data response

S16

SIU/ACK - Notification of appointment discontinuation

R09

ERP - Event replay response

S17

SIU/ACK - Notification of appointment deletion

R21

OUL - Unsolicited laboratory observation

S18

SIU/ACK - Notification of addition of service/resource on appointment

R22

OUL - Unsolicited specimen oriented observation message

S19

SIU/ACK - Notification of modification of service/resource on appointment

R23

OUL - Unsolicited specimen container oriented observation message

S20

SIU/ACK - Notification of cancellation of service/resource on appointment

R24

OUL - Unsolicited order oriented observation message

S21

SIU/ACK - Notification of discontinuation of service/resource on appointment

R30

ORU - Unsolicited point-of-care observation message without existing order place an order

S22

SIU/ACK - Notification of deletion of service/resource on appointment

S23

SIU/ACK - Notification of blocked schedule time slot(s)

R31

ORU - Unsolicited new point-of-care observation message - search for an order

S24

SIU/ACK - Notification of opened (unblocked) schedule time slot(s)

R32

ORU - Unsolicited pre-ordered point-of-care observation

S25

SQM/SQR - Schedule query message and response

RAR

RAR - Pharmacy administration information query response (omitted in 2.5)

S26

SIU/ACK - Notification that patient did not show up for scheduled appointment

RDR

RDR - Pharmacy dispense information query response (omitted in 2.5)

T01

MDM/ACK - Original document notification

RER

RER - Pharmacy encoded order information query response (omitted in 2.5)

T02

MDM/ACK - Original document notification and content

RGR

RGR - Pharmacy dose information query response (omitted in 2.5)

T03

MDM/ACK - Document status change notification

ROR

ROR - Pharmacy prescription order query response

T04

MDM/ACK - Document status change notification and content

S01

SRM/SRR - Request new appointment booking

T05

MDM/ACK - Document addendum notification

S02

SRM/SRR - Request appointment rescheduling

T06

MDM/ACK - Document addendum notification and content

S03

SRM/SRR - Request appointment modification

T07

MDM/ACK - Document edit notification

S04

SRM/SRR - Request appointment cancellation

T08

MDM/ACK - Document edit notification and content

S05

SRM/SRR - Request appointment discontinuation

T09

MDM/ACK - Document replacement notification

S06

SRM/SRR - Request appointment deletion

T10

MDM/ACK - Document replacement notification and content

S07

SRM/SRR - Request addition of service / resource on appointment

T11

MDM/ACK - Document cancel notification

S08

SRM/SRR - Request modification of service / resource on appointment

T12

QRY/DOC - Document query

S09

SRM/SRR - Request cancellation of service / resource on appointment

U01

ESU/ACK - Automated equipment status update

S10

SRM/SRR - Request discontinuation of service / resource on appointment

U02

ESR/ACK - Automated equipment status request

S11

SRM/SRR - Request deletion of service / resource on appointment

U03

SSU/ACK - Specimen status update

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only
w w w . c o r e p o i n t h e a lt h . c o m

16

17

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Event

Description

Segment

Description

Chapter

U04

SSR/ACK - Specimen status request

AIS

Appointment Information - Service

10

U05

INU/ACK - Automated equipment inventory update

AL1

Patient Allergy Information

U06

INR/ACK - Automated equipment inventory request

APR

Appointment Preferences

10

U07

EAC/ACK - Automated equipment command

ARQ

Appointment Request

10

U08

EAR/ACK - Automated equipment response

AUT

Authorization Information

11

U09

EAN/ACK - Automated equipment notification

BHS

Batch Header

U10

TCU/ACK - Automated equipment test code settings update

BLC

Blood Code

U11

TCR/ACK - Automated equipment test code settings request

BLG

Billing

U12

LSU/ACK - Automated equipment log/service update

BPO

Blood Product Order

U13

LSR/ACK - Automated equipment log/service request

BPX

Blood Product Dispense Status

V01

VXQ - Query for vaccination record

BTS

Batch Trailer

V02

VXX - Response to vaccination query returning multiple PID matches

BTX

Blood Product Transfusion/Disposition

V03

VXR - Vaccination record response

CDM

Charge Description Master

V04

VXU - Unsolicited vaccination record update

CER

Certificate Detail

15

Varies

MFQ/MFR - Master files query

CM0

Clinical Study Master

7,8

W01

ORU - Waveform result, unsolicited transmission of requested information

CM1

Clinical Study Phase Master

7,8

W02

QRF - Waveform result, response to query

CM2

Clinical Study Schedule Master

7,8

Any Z event type (e.g., Z01, ZXX, etc.) is site or vendor defined. See local or vendor
documents for details.

CNS

Clear Notification

13

CON

Consent

CSP

Clinical Study Phase

CSR

Clinical Study Registration

CSS

Clinical Study Data Schedule

CTD

Contact Data

11

CTI

Clinical Trial Identification

DB1

Disability

DG1

Diagnosis

DRG

Diagnosis Related Group

DSC

Continuation Pointer

DSP

Display Data

ECD

Equipment Command

13

Red = new (v2.5) HL7 message event types.


(bc) = Retained for backward compatibility only

HL7 SEGMENTS
Segment

Description

Chapter

ABS

Abstract

ACC

Accident

ADD

Addendum

AFF

Professional Affiliation

15

AIG

Appointment Information - General Resource

10

AIL

Appointment Information - Location Resource

10

AIP

Appointment Information - Personnel Resource

10

Red = new (v2.5) HL7 segments.


w w w . c o r e p o i n t h e a lt h . c o m

Red = new (v2.5) HL7 segments.

w w w . c o r e p o i n t h e a lt h . c o m

18

19

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Segment

Description

Chapter

Segment

Description

Chapter

ECR

Equipment Command Response

13

MFA

Master File Acknowledgment

EDU

Educational Detail

15

MFE

Master File Entry

EQL

Embedded Query Language

MFI

Master File Identification

EQP

Equipment/Log Service

13

MRG

Merge Patient Information

EQU

Equipment Detail

13

MSA

Message Acknowledgment

ERQ

Event Replay Query

MSH

Message Header

ERR

Error

NCK

System Clock

14

EVN

Event Type

NDS

Notification Detail

13

FAC

Facility

NK1

Next of Kin / Associated Parties

FHS

File Header

NPU

Bed Status Update

FT1

Financial Transaction

NSC

Application Status Change

14

FTS

File Trailer

NST

Application Control-Level Statistics

14

GOL

Goal Detail

12

NTE

Notes and Comments

GP1

Grouping/Reimbursement - Visit

OBR

Observation Request

4,7

GP2

Grouping/Reimbursement - Procedure Line Item

OBX

Observation / Result

7,9

GT1

Guarantor

ODS

Dietary Orders, Supplements, Preferences

IAM

Patient Adverse Reaction Information - Unique Identifier

ODT

Diet Tray Instructions

IIM

Inventory Item Master

OM1

General (Fields that Apply to Most Observations)

IN1

Insurance

OM2

Numeric Observation

IN2

Insurance Additional Information

OM3

Categorical Service/Test/Observation

IN3

Insurance Additional Information, Certification

OM4

Observations that Require Specimens

INV

Inventory Detail

13

OM5

Observation Batteries (Sets)

IPC

Imaging Procedure Control

OM6

Observations Calculated from Other Observations

ISD

Interaction Status Detail

13

OM7

LAN

Language Detail

15

Additional Basic Attributes (Fields that Apply to Most


Observations/Services)

LCC

Location Charge Code

ORC

Common Order

LCH

Location Characteristic

ORG

Practitioner Organization Unit

15

LDP

Location Department

OVR

Override

PCR

Possible Causal Relationship

PD1

Patient Additional Demographic

PDA

Patient Death and Autopsy

LOC

Location Identification

LRL

Location Relationship

Red = new (v2.5) HL7 segments.

Red = new (v2.5) HL7 segments.


w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

20

21

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Segment

Description

Chapter

Segment

Description

Chapter

PDC

Product Detail Country

RXD

Pharmacy/Treatment Dispense

PEO

Product Experience Observation

RXE

Pharmacy/Treatment Encoded Order

PES

Product Experience Sender

RXG

Pharmacy/Treatment Give

PID

Patient Identification

RXO

Pharmacy/Treatment Order

PR1

Procedures

RXR

Pharmacy/Treatment Route

PRA

Practitioner Detail

15

SAC

Specimen Container Detail

13

PRB

Problem Detail

12

SCH

Scheduling Activity Information

10

PRC

Pricing

SFT

Software

PRD

Provider Data

11

SID

Substance Identifier

13

PSH

Product Summary Header

SPM

Specimen

PTH

Pathway

12

SPR

Stored Procedure Request Defintion

PV1

Patient Visit

STF

Staff Identification

15

PV2

Patient Visit - Additional Information

TCC

Test Code Configuration

13

QAK

Query Acknowledgment

TCD

Test Code Detail

13

QID

Query Identification

TQ1

Timing/Quantity

QPD

Query Parameter Definition

TQ2

Timing Quantity Relationship

QRD

Original Mode Query Definition

TXA

Transcription Document Header

QRF

Original Mode Query Filter

UB1

UB82 Data

QRI

Query Response Instance

UB2

UB92 Data

RCP

Response Control Parameter

URD

Results/Update Definition

RDF

Table Row Definition

URS

Unsolicited Selection

RDT

Table Row Data

VAR

Variance

12

RF1

Referral Information

11

VTQ

Virtual Table Query Request

RGS

Resource Group

10

RMI

Risk Management Incident

Any Z segment (e.g., ZZZ, ZXX, etc.) is site or vendor defined.


See local or vendor documents for details.

ROL

Role

12,15

RQ1

Requisition Detail-1

RQD

Requisition Detail

RXA

Pharmacy/Treatment Administration

RXC

Pharmacy/Treatment Component Order

Red = new (v2.5) HL7 segments.

Red = new (v2.5) HL7 segments.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

22

23

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

HL7 DATA TYPES


Maximum
length

Type

Description

Sub-components

AD

Address

Used only in the LA1 data type. Replaced


elsewhere by the XAD data type as of v2.3
1. <street address (ST)>^
2. <other designation (ST)>^
3. <city (ST)>^
4. <state or province (ST)>^
5. <zip or postal code (ST)>^
6. <country (ID)>^
7. <address type (ID)>^
8. <other geographic designation (ST)>

415

AUI

Authorization
information

Replaces the CM data type as of v2.5


1. <authorization number (ST)>^
2. <date (DT)>^
3. <source (ST)>

239

CCD

Charge code and


date

Replaces the CM data type as of v2.5


1. <invocation event <ID)>^
2. <date/time (TS)>

28

CCP

Channel
calibration
parameters

Replaces the CM data type as of v2.5


1. <channel calibration sensitivity correction
factor (NM)>^
2. <channel calibration baseline (NM)>^
3. <channel calibration time skew (NM)>

20

CD

Channel
definition

For waveform data only, see Chapter 7, Section


7.17
1. <channel identifier (WVI)>^
2. <waveform source (WVS)>^
3. <
 channel sensitivity/units (CSU)>^
4. <channel calibration parameters (CCP)>^
5. <channel sampling frequency (NM)>^
6. <minimum/maximum data values (NR)>

581

Coded element

Retained for backward compatibility as of v2.5.


Refer to CNE and CWE.
1. <identifier (ST)>^
2. <text (ST)>^
3. <name of coding system (ID)>^
4. <alternate identifier (ST)>^
5. <alternate text (ST)>^
6. <name of alternate coding system (ID)>

483

1. <identifier (ST)>^
2. <formatted text (FT)>^
3. <name of coding system (ID)>^
4. <alternate identifier (ST)>^
5. <alternate formatted text (FT)>^
6. <name of alternate coding system (ID)>

65536

CE

CF

Coded element
with formatted
values

Maximum
length

Type

Description

Sub-components

CK

Composite ID
with check digit

Withdrawn as of v2.5.
1. <ID number (NM)>^
2. <check digit (NM)>^
3. <code ID for chk digit schm (ID)>^
4. <assigning authority (HD)>

n/a

CM

Composite

No new CMs are allowed after v2.2.

n/a

CN

Composite ID
number and
name

Replaced by XCN as of v2.3.


1. <ID number (ST)>^
2. <family name (FN)>^
3. <given name (ST)>^
4. <middle initial or name (ST)>^
5. <
 suffix (e.g., JR or III) (ST)>^
6. <prefix (e.g., DR) (ST)>^
7. <degree (e.g., MD) (ST)>^
8. <source table (IS)>^
9. <assigning authority (HD)>

n/a

CNE

Coded with no
exceptions

1. <identifier (ST)>^
2. <text (ST)>^
3. <name of coding system (ID)>^
4. <alternate identifier (ST)>^
5. <
 alternate text (ST)>^
6. <name of alternate coding system (ID)>^
7. <coding system version ID (ST)>^
8. <alternate coding system version ID (ST)>^
9. <original text (ST)>

705

CNN

Composite ID
number and
name simplified

1. <ID number (ST)>^


2. <family name (ST)>^
3. <given name (ST)>^
4. <second and further given names or initials
thereof (ST)>^
5. <
 suffix (e.g., JR or III) (ST)>^
6. <prefix (e.g., DR) (ST)>^
7. <degree (e.g., MD) (IS)>^
8. <source table (IS)>^
9. <assigning authority - namespace ID (IS)>^
10. <
 assigning authority - universal ID (ST)>^
11. <assigning authority - universal ID type (ID)>

406

CP

Composite price

Replaces MO as of v2.3
1. <price (MO)>^
2. <price type (ID)>^
3. <from value (NM)>^
4. <to value (NM)>^
5. <
 range units (CE)>^
6. <range type (ID)>

543

Red = new (v2.5) HL7 data types.

Red = new (v2.5) HL7 data types.


w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

24

25

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Maximum
length

Type

Description

Sub-components

1. <quantity (NM)>^
2. <units (CE)>

500

DLT

Delta

45

Replaces the CM data type as of v2.5.


1. <channel sensitivity (NM)>^
2. <unit of measure identifier (ST)>^
3. <unit of measure description (ST)>^
4. <unit of measure coding system (ID)>^
5. <alternate unit of measure identifier (ST)>^
6. <alternate unit of measure description (ST)>^
7. <alternate unit of measure coding system (ID)>

490

Replaces the CM data type as of v2.5.


1. <normal range (NR)>^
2. <numeric threshold (NM)>^
3. <change computation (ID)>^
4. <days retained (NM)>

DR

Date/time range

For use with Chapter 10 Scheduling only


1. <range start date/time (TS)>^
2. <range end date/time (TS)>

53

DT

Date

YYYY[MM[DD]]

DTM

Date/time

705

YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/ZZZZ]

24

1. <identifier (ST)>^
2. <text (ST)>^
3. <name of coding system (ID)>^
4. <alternate identifier (ST)>^
5. <alternate text (ST)>^
6. <name of alternate coding system (ID)>^
7. <coding system version ID (ST)>^
8. <alternate coding system version ID (ST)>^
9. <original text (ST)>

DTN

Day type and


number

Replaces the CM data type as of v2.5.


1. <day type (IS)>^
2. <number of days (NM)>

ED

Encapsulated
data

65536

1. <ID number (ST)>^


2. <check digit (ST)>^
3. <check digit scheme (ID)>^
4. <assigning authority (HD)>^
5. <identifier type code (ID)>^
6. <assigning facility (HD)>^
7. <effective date (DT)>^
8. <expiration date (DT)>^
9. <assigning jurisdiction (CWE)>^
10. <
 assigning agency or department (CWE)>

1913

Supports ASCII MIME-binary encoding


1. <source application (HD)>^
2. < type of data (ID)>^
3. <data subtype (ID)>^
4. <encoding (ID)>^
5. <
 data (TX)>

EI

Entity identifier

1. <entity identifier (ST)>^


2. <namespace ID (IS)>^
3. <universal ID (ST)^
4. <universal ID type (ID)>

427

EIP

Entity identifier
pair

Replaces the CM data type as of v2.5.


1. <placer assigned identifier (EI)>^
2. < filler assigned identifier (EI)>

855

ELD

Error location and


description

Replaces the CM data type as of v2.5.


1. <segment ID (ST)>^
2. <segment sequence (NM)>^
3. < field position (NM)>^
4. <code identifying error (CE)>

493

ERL

Error location

1. <segment ID (ST)>^
2. <segment sequence (NM)>^
3. < field position (NM)>^
4. < field repetition (NM)>^
5. <component number (NM)>^
6. <sub-component number (NM)>

18

FC

Financial class

1. < financial class code (IS)>^


2. <effective data (TS)>

47

Type

Description

Sub-components

CQ

Composite
quantity with
units

CSU

Channel
sensitivity

CWE

CX

Coded with
exceptions

Extended
composite ID
with check digit

DDI

Daily deductible
information

Replaces the CM data type as of v2.5.


1. <delay days (NM)>^
2. <monetary amount (MO)>^
3. <number of days (NM)>^

25

DIN

Date and
institution name

Replaces the CM data type as of v2.5.


1. <date (TS)>^
2. <institution name (CE)>

510

DLD

Discharge to
location and date

Replaces the CM data type as of v2.5.


1. <discharge location (IS)>^
2. <effective date (TS)>

47

DLN

Drivers license
number

1. <license number (ST)>^


2. <issuing state, province., country (IS)>^
3. <expiration date (DT)>

66

Maximum
length

Red = new (v2.5) HL7 data types.

Red = new (v2.5) HL7 data types.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

26

27

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Maximum
length

Type

Description

Sub-components

Appears ONLY in the PPN, XCN and XPN


1. <surname (ST)>^
2. <own surname prefix (ST)>^
3. <own surname (ST)>^
4. <surname prefix from partner/spouse (ST)>^
5. <surname from partner/spouse (ST)>

194

LA2

Location with
address variation
2

790

Formatted text
data

Coded value for HL7-Defined Tables


ST with formatting codes; 64K max length

65536

GTS

General timing
specification

General Timing Specification (ST)

199

HD

Hierarchic
designator

1. <namespace ID (IS)>^
2. <universal ID (ST)>^
3. <universal ID type (ID)>

227

ICD

Insurance
certification
definition

Replaces the CM data type as of v2.5.


1. <certification patient type (IS)>^
2. <certification required (ID)>^
3. <date/time certification required (TS)>

40

Replaces the CM data type as of v2.5.


1. <point of care (IS)>^
2. <room (IS)>^
3. <bed (IS)>^
4. <facility (HD)>^
5. <
 location status (IS)>^
6. <
 patient location type (IS)>^
7. <building (IS)>^
8. < floor (IS)>^
9. <street address (ST)>^
10. <
 other designation (ST))>^
11. <city (ST)>^
12. <state or province (ST)>^
13. <zip or postal code (ST)>^
14. <country (ID)>^
15. <address type (ID)>^
16. <other geographic designation (ST)>

MA

Multiplexed array

65536

ID

Coded value

Coded value for HL7-defined tables

Varies

IS

Coded value

Coded values for user-defined tables

20

JCC

Job code/class

1. <job code (IS)>^


2. <job class (IS)>^
3. <job description text (TX)>

292

LA1

Location with
address variation
1

Replaces the CM data type as of v2.5.


1. <point of care (IS)>^
2. <room (IS)>^
3. <bed (IS)>^
4. <facility (HD)>^
5. <location status (IS)>^
6. <patient location type (IS)>^
7. <building (IS)>^
8. < floor (IS)>^
9. <address (AD)>

790

For waveform data only, see Chapter 7, Section


7.15.2
1. <sample 1 from ch 1 (NM)>^
2. <sample 1 from ch 2 (NM)>^
3. <sample 1 from ch 3 (NM)>^
4. ~
5. <
 sample 2 from ch 1 (NM)>^
6. <sample 2 from ch 2 (NM)>^
7. <sample 2 from ch 3 (NM)>^

MO

Money

1. <quantity (NM)>^
2. <denomination (ID)>

20

MOC

Money and
charge code

Replaces the CM data type as of v2.5.


1. <monetary amount (MO)>^
2. <charge code (CE)>

504

MOP

Money or
percentage

Replaces the CM data type as of v2.5.


1. <money or percentage indicator (ID)>^
2. <money or percentage quantity (NM)>^
3. <currency denomination (ID)>

23

MSG

Message type

Replaces the CM data type as of v2.5.


1. <message code (ID)>^
2. <trigger event (ID)>^
3. <message structure (ID)>

15

Type

Description

Sub-components

FN

Family name

FT

Red = new (v2.5) HL7 data types.

Maximum
length

Red = new (v2.5) HL7 data types.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

28

29

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Maximum
length

Type

Description

Sub-components

For wave form data only, see Chapter7, Section


7.15.1
1. <value1 (NM)>^
2. <value2 (NM)>^
3. <value3 (NM)>^
4. <value4 (NM)>^

65536

PIP

Practitioner
institutional
privileges

Replaces the CM data type as of v2.5.


1. <privilege (CE)>^
2. <privilege class (CE)>^
3. <
 expiration date (DT)>^
4. <activation date (DT)>^
5. <
 facility (EI)>

1413

PL

Person location

835

1. <point of care (IS)>^


2. <
 room (IS)>^
3. <bed (IS)>^
4. <
 facility (HD)>^
5. <
 location status (IS)>^
6. <person location type (IS)>^
7. <building (IS)>^
8. <
 floor (IS)>^
9. <location description (ST)>^
10. <
 comprehensive location identifier (EI)>^
11. <assigning authority for location (HD)>

1230

Replaces the CM data type as of v2.5.


1. <name (CNN)>^
2. <start date/time (TS)>^
3. <end date/time (TS)>^
4. <point of care (IS)>^
5. <room (IS)>^
6. <bed (IS)>^
7. <facility (HD)>^
8. <location status (IS)>^
9. <patient location type (IS)>^
10. <
 building (IS)>^
11. < floor (IS)>

PLN

Practitioner
license or other
ID number

Replaces the CM data type as of v2.5.


1. <ID number (ST)>^
2. <type of ID number (IS)>^
3. <state/other qualifying information (ST)>^
4. <expiration date (DT)>

101

PN

Person name

Replaced by the XPN data type as of v2.3


1. <family name (FN)>^
2. <given name (ST)>^
3. <middle initial or name (ST)>^
4. <suffix (e.g., JR or III) (ST)>^
5. <prefix (e.g., DR) (ST)>^
6. <degree (e.g., MD) (IS)>

n/a

Type

Description

Sub-components

NA

Numeric array

NDL

Name with date


and location

NM

Numeric

Numeric

16

NR

Numeric range

Replaces the CM data type as of v2.5.


1. <low value (NM)>^
2. <high value (NM)>

33

OCD

Occurrence code
and date

Replaces the CM data type as of v2.5.


1. <occurrence code (CNE)>^
2. <occurrence date (DT)>

714

OSD

Order sequence
definition

Replaces the CM data type as of v2.5.


1. <sequence/results flag (ID)>^
2. <placer order number: entity identifier (ST)>^
3. <placer order number: namespace ID (IS)>^
4. < filler order number: entity identifier (ST)>^
5. < filler order number: namespace ID (IS)>^
6. <sequence condition value (ST)>^
7. <maximum number of repeats (NM)>^
8. <placer order number: universal ID (ST)>^
9. <placer order number: universal ID type (ID)>^
10. <
 filler order number: universal ID (ST)>^
11. < filler order number: universal ID type (ID)>

110

Replaces the CM data type as of v2.5.


1. <occurrence span code (CNE)>^
2. <occurrence span start date (DT)>^
3. <occurrence span stop date (DT)>

723

OSP

Occurrence span
code and date

Maximum
length

Red = new (v2.5) HL7 data types.

Red = new (v2.5) HL7 data types.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

30

31

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Maximum
length

Type

Description

Sub-components

1. <ID number (ST)>^


2. <family name (FN)>^
3. <given name (ST)>^
4. <second and further given names or initials
thereof (ST)>^
5. <suffix (e.g., JR or III) (ST)>^
6. <prefix (e.g., DR) (ST)>^
7. <degree (e.g., MD) (IS)>^
8. <source table (IS)>^
9. <assigning authority (HD)>^
10. <
 name type code (ID)>^
11. <identifier check digit (ST)>^
12. <check digit scheme (ID)>^
13. <identifier type code (ID)>^
14. <assigning facility (HD)>^
15. <date/time action performed (TS)>^
16. <name representation code (ID)>^
17. <name context (CE)>^
18. <
 name validity range (DR)>^
19. <name assembly order (ID)>^
20. <
 effective date (TS)>^
21. <expiration date (TS)>^
22. <professional suffix (ST)>^
23. <assigning jurisdiction (CWE)>^
24. <assigning agency or department (CWE)>

2993

RFR

Reference range

Replaces the CM data type as of v2.5.


1. <numeric range (NR)>^
2. <administrative sex (IS)>^
3. <age range (NR)>^
4. <gestational age range (NR)>^
5. <
 species (ST)>^
6. <race/subspecies (ST)>^
7. <
 conditions (TX)>

352

RI

Repeat interval

Refer to RPT data type.


For use with Chapter 10 Scheduling only
1. <repeat pattern (IS)>^
2. <explicit time interval (ST)>

206

RMC

Room coverage

Replaces the CM data type as of v2.5.


1. <room type (IS)>^
2. <amount type (IS)>^
3. <coverage amount (NM)>^
4. <money or percentage (MOP)>

82

RP

Reference pointer

1. <pointer (ST)>^
2. <application ID (HD)>^
3. <type of data (ID)>^
4. <subtype (ID)>

273

RPT

Repeat pattern

1. <repeat pattern code (CWE)>^


2. <calendar alignment (ID)>^
3. <phase range begin value (NM)>^
4. <phase range end value (NM)>^
5. <
 period quantity (NM)>^
6. <period units (IS)>^
7. <institution specified time (ID)>^
8. <event (ID)>^
9. <event offset quantity (NM)>^
10. <
 event offset units (IS)>^
11. <general timing specification (GTS)>

284

SAD

Street address

Appears only in the XAD data type.


1. <street or mailing address (ST)>^
2. <street name (ST)>^
3. <dwelling number (ST)>

184

SCV

Scheduling class
value pair

For use with Chapter 10 Scheduling only


1. <parameter class (CWE)>^
2. <parameter value (ST)>

41

SI

Sequence ID

Non-negative integer in form of NM field.


Allows for a number between 0 and 9999.

SN

Structured
numeric

1. <comparator (ST)>^
2. <num1 (NM)>^
3. <separator/suffix (ST)>^
4. <num2 (NM)>

36

Type

Description

Sub-components

PPN

Performing
person time
stamp

PRL

Parent result link

Replaces the CM data type as of v2.5.


Applied only to OBR-26.
1. <parent observation identifier (CE)>^
2. <parent observation sub-identifier (ST)>^
3. <parent observation value descriptor (TX)>

755

PT

Processing type

1. <processing ID (ID)>^
2. <processing mode (ID)>

PTA

Policy type and


amount

Replaces the CM data type as of v2.5.


1. <policy type (IS)>^
2. <amount class (IS)>^
3. <money or percentage quantity (NM)>^
4. <money or percentage (MOP)>

56

QIP

Query input
parameter list

1. <segment field name (ST)>^


2. <value1(ST)>&<value2(ST)>&<valueN (ST)...>

212

QSC

Query selection
criteria

1. <segment field name(ST)>^


2. <relational operator (ID)>^
3. <value (ST)>^
4. <relational conjunction (ID)>

219

Row column
definition

1. <segment field name (ST)>^


2. <HL7 data type (ID)>^
3. <maximum column width (NM)>

19

RCD

Red = new (v2.5) HL7 data types.


w w w . c o r e p o i n t h e a lt h . c o m

Maximum
length

Red = new (v2.5) HL7 data types.


w w w . c o r e p o i n t h e a lt h . c o m

32

33

HL7 Reference Guide

HL7 Reference Guide

HL7 Standard

HL7 Standard

Maximum
length

Type

Description

Sub-components

Replaces the CM data type as of v2.5.


1. <specialty name (ST)>^
2. <governing board (ST)>^
3. <eligible or certified (ID)>^
4. <date of certification (DT)>

112

UVC

UB value code
and amount

Replaces the CM data type as of v2.5.


1. <value code (CNE)>^
2. <value amount (MO)>

41

VH

Visiting hours

41

Replaces the CM data type as of v2.5. Refer to


the SPM segment.
1. <specimen source name or code (CWE)>^
2. <additives (CWE)>^
3. <specimen collection method (TX)>^
4. <body site (CWE)>^
5. <site modifier (CWE)>^
6. <collection method modifier code (CWE)>^
7. <specimen role (CWE)>

4436

1. <start day range (ID)>^


2. <end day range (ID)>^
3. <start hour range (TM)>^
4. <end hour range (TM)>

VID

Version identifier

1. <version ID (ID)>^
2. <internationalization code (CE)>^
3. <
 international version ID (CE)>

973

VR

Value range

Replaces the CM data type as of v2.5.


1. < first data code value (ST)>^
2. <last data code value (ST)>

13

WVI

Channel identifier

For waveform data only, See Chapter 7. Replaces


the CM data type as of v2.5.
1. <channel number (NM)>^
2. <channel name (ST)>

22

WVS

Waveform source

For waveform data only, See Chapter 7. Replaces


the CM data type as of v2.5.
1. <source one name (ST)>^
2. <source two name (ST)>

17

XAD

Extended
address

Replaces the AD data type as of v2.3


1. <street address (SAD)>^
2. <other designation (ST)>^
3. <city (ST)>^
4. <state or province (ST)>^
5. <
 zip or postal code (ST)>^
6. <country (ID)>^
7. <address type (ID)>^
8. <other geographic designation (ST)>^
9. <county/parish code (IS)>^
10. <
 census tract (IS)>^
11. <address representation code (ID)>^
12. <address validity range (DR)>^ (bc)
13. <effective date (TS)>^
14. <expiration date (TS)>
(bc) Deprecated as of v2.5

631

Type

Description

Sub-components

SPD

Specialty
description

SPS

Specimen source

SRT

Sort order

1. <sort-by field (ST)>^


2. <sequencing (ID)>

15

ST

String

Displayable/printable ASCII only. Generally less


than 200 characters.
For longer strings, use TX or FT data types.

199

TM

Time

HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ]

16

TN

Telephone
number

Replaced by the XTN data type as of v2.3


[NN][(999)]9999999[X99999]
[B99999][C any text]

N/A

Timing/
quantity

Retained for backward compatibility as of v2.5.


Refer to TQ1 and TQ2 segments.
1. <quantity (CQ)>^
2. <interval (RI)>^
3. <duration (ST)>^
4. <start date/time (TS)>^
5. <end date/time (TS)>^
6. <priority (ST)>^
7. <condition (ST)>^
8. <text (TX)>^
9. <conjunction (ID)>^
10. <
 order sequencing (OSD)>^
11. <occurrence duration (CE)>^
12. <total occurrences (NM)>

1545

TQ

WARNING:
CQ cannot be
implemented
as it contains
a CE w/ no
sub-subcomponent.
To use TQ, leave
off
2 & 3.
TS

Time stamp

1. <time (DTM)>^
2. <degree of precision (ID)>
Format: YYYY[MM[DD
[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]^<degree
of precision>

26

TX

Text data

User display on a terminal or printer.

65536

Maximum
length

Red = new (v2.5) HL7 data types.

Red = new (v2.5) HL7 data types.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

34

35

HL7 Reference Guide

HL7 Standard

Maximum
length

Type

Description

Sub-components

Replaces the CN data type as of v2.3


1. <ID number (ST)>^
2. <family name (FN)>^
3. <given name (ST)>^
4. <second and further given names or initials
thereof (ST)>^
5. <suffix (e.g., JR or III) (ST)>^
6. <prefix (e.g., DR) (ST)>^
7. <degree (e.g., MD) (IS)>^ (bc)
8. <source table (IS)>^
9. <assigning authority (HD)>^
10. <
 name type code (ID)>^
11. <identifier check digit (ST)>^
12. <check digit scheme (ID)>^
13. <identifier type code (ID)>^
14. <assigning facility (HD)>^
15. <name representation code (ID)>^
16. <name context (CE)>^
17. <name validity range (DR)>^
18. <
 name assembly order (ID)>^
19. <effective date (TS)>^
20. <
 expiration date (TS)>^
21. <professional suffix (ST)>^
22. <assigning jurisdiction (CWE)>^
23. <assigning agency or department (CWE)>
(bc) Deprecated as of v3

3002

XPN

Extended person
name

Replaces the PN data type as of v2.3


1. <family name (FN)>^
2. <given name (ST)>^
3. <second and further given names or initials
thereof (ST)>^
4. <suffix (e.g., JR or III) (ST)>^
5. <
 prefix (e.g., DR) (ST)>^
6. <degree (e.g., MD) (IS)>^ (bc)
7. <name type code (ID)>^
8. <name representation code (ID)>^
9. <name context (CE)>^
10. <
 name validity range (DR)>^
11. <name assembly order (ID)>^
12. <effective date (TS)>^
13. <expiration date (TS)>^
14. <professional suffix (ST)>
(bc) Deprecated as of v3

1103

XTN

Extended
telecommunication number

850

1. <organization name (ST)>^


2. <organization name type code (IS)>^
3. <ID number (NM)>^
4. <check digit (NM)>^
5. <check digit scheme (ID)>^
6. <assigning authority (HD)>^
7. <identifier type code (ID)>^
8. <assigning facility (HD)>^
9. <name representation code (ID)>^
10. <
 organization identifier (ST)>

567

Replaces TN data type as of v2.3


1. <telephone number (ST)>^ (bc)
NNN] [(999)]999-9999 [X99999] [B99999]
[C any text]^
2. <telecommunication use code (ID)> ^
3. <telecommunication equipment type (ID)> ^
4. <email address (ST)> ^
5. <
 country code (NM)> ^
6. <area/city code (NM)> ^
7. <lcoal number (NM)> ^
8. <extension (NM)> ^
9. <any text (ST)>^
10. <
 extension prefix (ST)>^
11. <speed dial code (ST)>^
12. <unformatted telephone number (ST)>
(bc) Deprecated as of v3

Type

Description

Sub-components

XCN

Extended
composite ID
number and
name for persons

XON

Extended
composite name
and identification
number for
organizations

Maximum
length

Red = new (v2.5) HL7 data types.

Red = new (v2.5) HL7 data types.

w w w . c o r e p o i n t h e a lt h . c o m

w w w . c o r e p o i n t h e a lt h . c o m

Meeting standards.
Setting new ones.
Corepoint Integration Engine
Ranked #1 by KLAS for 2009 & 2010.
Interface Engines Market Segment, Top 20 Best in KLAS Awards:
Software & Professional Services Report.
2010 KLAS Enterprises, LLC. All rights reserved.
www.KLASresearch.com

Corepoint Health Achieves ONC-ATCB Modular


EHR Certification by Drummond Group
First Interface Engine Certified for Modular Ambulatory
EHR and Modular Inpatient EHR
www.corepointhealth.com/onc-certified

Follow us at:

@corepointhealth

facebook.com/corepointhealth
linkedin