Inventory of Health Care Information Standards. HL7 Event Type Codes

01/01/1997

Value

Description

A01

ADT/ACK - Admit / visit notification

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

A11

ADT/ACK - Cancel admit/visit notification

A12

ADT/ACK - Cancel transfer

A13

ADT/ACK - Cancel discharge/end visit

A14

ADT/ACK - Pending admit

A15

ADT/ACK - Pending transfer

A16

ADT/ACK - Pending discharge

A17

ADT/ACK - Swap patients

A18

ADT/ACK - Merge patient information

A19

QRY/ACK - Patient query

A20

ADT/ACK - Bed status update

A21

ADT/ACK - Patient goes on a "leave of absence"

A22

ADT/ACK - Patient returns from a "leave of absence"

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

A31

ADT/ACK - Update person information

A32

ADT/ACK - Cancel patient arriving - tracking

A33

ADT/ACK - Cancel patient departing - tracking

A34

ADT/ACK - Merge patient information - patient ID only

A35

ADT/ACK - Merge patient information - account number only

A36

ADT/ACK - Merge patient information - patient ID and account number

A37

ADT/ACK - Unlink patient information

A38

ADT/ACK - Cancel pre-admit

A39

ADT/ACK - Merge person - external ID

A40

ADT/ACK - Merge patient - internal ID

A41

ADT/ACK - Merge account - patient account number

A42

ADT/ACK - Merge visit - visit number

A43

ADT/ACK - Move patient information - internal ID

A44

ADT/ACK - Move account information - patient account number

A45

ADT/ACK - Move visit information - visit number

A46

ADT/ACK - Change external ID

A47

ADT/ACK - Change internal ID

A48

ADT/ACK - Change alternate patient ID

A49

ADT/ACK - Change patient account number

A50

ADT/ACK - Change visit number

A51

ADT/ACK - Change alternate visit ID

B01

PPR/ACK - Patient problem

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

C04

CRM - Patient has gone off a clinical trial

C05

CRM - Patient enters phase of clinical trial

C06

CRM - Cancel patient entering a phase (clerical mistake)

C07

CRM - Correct/update phase information

C08

CRM - Patient has gone off phase of clinical trial

C09

CSU - Automated time intervals for reporting, like monthly

C10

CSU - Patient completes the clinical trial

C11

CSU - Patient completes a phase of the clinical trial

C12

CSU - Update/correction of patient order/result information

G01

PGL/ACK - Patient goal

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

M01

MFN/MFK - Master file not otherwise specified (for backward compatibility only)

M02

MFN/MFK - Master file - Staff Practitioner

M03

MFN/MFK - Master file - Test/Observation

varies

MFQ/MFR - Master files query (use event same as asking for e.g., M05 - location)

M04

MFD/ACK - Master files delayed application acknowledgement

M05

MFN/MFK - Patient location master file

M06

MFN/MFK - Charge description master file

M07

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

M08

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

O01

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

O02

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

Q06

OSQ/OSR - Query for order status

P01

BAR/ACK - Add and update patient account

P02

BAR/ACK - Purge patient account

P03

DFT/ACK - Post detail financial transaction

P04

QRY/DSP - Generate bill and A/R statements

P05

BAR/ACK - Update account

P06

BAR/ACK - End account

P07

PEX - Unsolicited initial individual product experience report

P08

PEX - Unsolicited update individual product experience report

P09

SUR - Summary product experience report

PC1

PPR - PC/ Problem Add

PC2

PPR - PC/ Problem Update

PC3

PPR - PC/ Problem Delete

PC4

PRQ - PC/ Problem Query

PC5

PRR - PC/ Problem Response

PC6

PGL - PC/ Goal Add

PC7

PGL - PC/ Goal Update

PC8

PGL - PC/ Goal Delete

PC9

PGQ - PC/ Goal Query

PCA

PGR - PC/ Goal Response

PCB

PPP - PC/ Pathway (Problem-Oriented) Add

PCC

PPP - PC/ Pathway (Problem-Oriented) Update

PCD

PPP - PC/ Pathway (Problem-Oriented) Delete

PCE

PTQ - PC/ Pathway (Problem-Oriented) Query

PCF

PTR - PC/ Pathway (Problem-Oriented) Query Response

PCG

PPG - PC/ Pathway (Goal-Oriented) Add

PCH

PPG - PC/ Pathway (Goal-Oriented) Update

PCJ

PPG - PC/ Pathway (Goal-Oriented) Delete

PCK

PTU - PC/ Pathway (Goal-Oriented) Query

PCL

PTV - PC/ Pathway (Goal-Oriented) Query Response

Q01

QRY/DSR - Query sent for immediate response

Q02

QRY/ACK - Query sent for deferred response

Q03

DSR/ACK - Deferred response to a query

Q05

UDM/ACK - Unsolicited display update

R01

ORU/ACK - Unsolicited transmission of an observation

R02

QRY - Query for results of observation

R03

Display-oriented results, query/unsol. Update (for backward compatibility only)

R04

ORF - Response to query; transmission of requested observation

RAR

RAR - Pharmacy administration information query response

RDR

RDR - Pharmacy dispense information query response

RER

RER - Pharmacy encoded order information query response

RGR

RGR - Pharmacy dose information query response

ROR

ROR - Pharmacy prescription order query response

S01

SRM/SRR - Request new appointment booking

S02

SRM/SRR - Request appointment rescheduling

S03

SRM/SRR - Request appointment modification

S04

SRM/SRR - Request appointment cancellation

S05

SRM/SRR - Request appointment discontinuation

S06

SRM/SRR - Request appointment deletion

S07

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

S08

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

S09

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

S10

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

S11

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

S12

SIU/ACK - Notification of new appointment booking

S13

SIU/ACK - Notification of appointment rescheduling

S14

SIU/ACK - Notification of appointment modification

S15

SIU/ACK - Notification of appointment cancellation

S16

SIU/ACK - Notification of appointment discontinuation

S17

SIU/ACK - Notification of appointment deletion

S18

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

S19

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

S20

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

S21

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

S22

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

S23

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

S24

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

S25

SQM/SQR - Query schedule information

T01

MDM/ACK - Original document notification

T02

MDM/ACK - Original document notification and content

T03

MDM/ACK - Document status change notification

T04

MDM/ACK - Document status change notification and content

T05

MDM/ACK - Document addendum notification

T06

MDM/ACK - Document addendum notification and content

T07

MDM/ACK - Document edit notification

T08

MDM/ACK - Document edit notification and content

T09

MDM/ACK - Document replacement notification

T10

MDM/ACK - Document replacement notification and content

T11

MDM/ACK - Document cancel notification

T12

QRY/DOC - Document query

V01

VXQ - Query for vaccination record

V02

VXX - Response to vaccination query returning multiple PID matches

V03

VXR - Vaccination record response

V04

VXU - Unsolicited vaccination record update

W01

ORU - Waveform result, unsolicited transmission of requested information

W02

QRF - Waveform result, response to query

X01

PEX - Product experience

Attachment 2

HL7 Order Control Codes and Their Meaning

Value

Description

Originator

Field Note

NW

New order

P

I

OK

Order accepted & OK

F

I

UA

Unable to Accept Order

F

n

       

CA

Cancel order request

P

a

OC

Order canceled

F

 

CR

Canceled as requested

F

 

UC

Unable to cancel

F

b

       

DC

Discontinue order request

P

c

OD

Order discontinued

F

 

DR

Discontinued as requested

F

 

UD

Unable to discontinue

F

 
       

HD

Hold order request

P

 

OH

Order held

F

 

UH

Unable to put on hold

F

 

HR

On hold as requested

F

 
       

RL

Release previous hold

P

 

OE

Order released

F

 

OR

Released as requested

F

 

UR

Unable to release

F

 
       

RP

Order replace request

P

e,d,h

RU

Replaced unsolicited

F

f,d,h

RO

Replacement order

P,F

g,d,h,l

RQ

Replaced as requested

F

d,e,g,h

UM

Unable to replace

F

 
       

PA

Parent order

F

I

CH

Child order

F,P

i

       

XO

Change order request

P

 

XX

Order changed, unsol.

F

 

UX

Unable to change

F

 

XR

Changed as requested

F

 
       

DE

Data errors

P,F

 

RE

Observations to follow

P,F

j

RR

Request received

P,F

k

SR

Response to send order status request

F

 

SS

Send order status request

P

 

SC

Status changed

F,P

 

SN

Send order number

F

l

NA

Number assigned

P

l

CN

Combined result

F

m

       

RF

Refill order request

F, P

o

AF

Order refill request approval

P

p

DF

Order refill request denied

P

q

FU

Order refilled, unsolicited

F

r

OF

Order refilled as requested

F

s

UF

Unable to refill

F

t

LI

Link order to patient care message

u

 

UN

Unlink order from patient care message

u

 
Attachment 3

UB92 Segments

The UB2 segment contains data necessary to complete UB92 bills. Only UB92 fields that do not exist in other HL7 defined segments appear in this segment. Patient Name and Date of Birth are required; they are included in the PID segment and therefore do not appear here. When the field locators are different on the UB92, as compared to the UB82, the element is listed with its new location in parentheses ( ).

UB2 attributes

SEQ

LEN

DT

OPT

RP/#

TBL#

ITEM#

ELEMENT NAME

1

4

SI

O

   

00553

Set ID - UB2

2

3

ST

O

   

00554

Co-Insurance Days (9)

3

2

IS

O

Y/7

0043

00555

Condition Code (24-30)

4

3

ST

O

   

00556

Covered Days (7)

5

4

ST

O

   

00557

Non-Covered Days (8)

6

11

CM

O

Y/12

0153

00558

Value Amount & Code

7

11

CM

O

Y/8

 

00559

Occurrence Code & Date (32-35)

8

28

CM

O

Y/2

 

00560

Occurrence Span Code/Dates (36)

9

29

ST

O

Y/2

 

00561

UB92 Locator 2 (State)

10

12

ST

O

Y/2

 

00562

UB92 Locator 11 (State)

11

5

ST

O

   

00563

UB92 Locator 31 (National)

12

23

ST

O

Y/3

 

00564

Document Control Number

13

4

ST

O

Y/23

 

00565

UB92 Locator 49 (National)

14

14

ST

O

Y/5

 

00566

UB92 Locator 56 (State)

15

27

ST

O

   

00567

UB92 Locator 57 (National)

16

2

ST

O

Y/2

 

00568

UB92 Locator 78 (State)

17

3

NM

O

   

00815

Special Visit Count

PID attributesFigure 3-2. PID attributes

SEQ

LEN

DT

OPT

RP/#

TBL#

ITEM#

ELEMENT NAME

1

4

SI

O

   

00104

Set ID - Patient ID

2

20

CX

O

   

00105

Patient ID (External ID)

3

20

CX

R

Y

 

00106

Patient ID (Internal ID)

4

20

CX

O

Y

 

00107

Alternate Patient ID - PID

5

48

XPN

R

   

00108

Patient Name

6

48

XPN

O

   

00109

Mother's Maiden Name

7

26

TS

O

   

00110

Date/Time of Birth

8

1

IS

O

 

0001

00111

Sex

9

48

XPN

O

Y

 

00112

Patient Alias

10

1

IS

O

 

0005

00113

Race

11

106

XAD

O

Y

 

00114

Patient Address

12

4

IS

B

   

00115

County Code

13

40

XTN

O

Y

 

00116

Phone Number - Home

14

40

XTN

O

Y

 

00117

Phone Number - Business

15

60

CE

O

 

0296

00118

Primary Language

16

1

IS

O

 

0002

00119

Marital Status

17

3

IS

O

 

0006

00120

Religion

18

20

CX

O

   

00121

Patient Account Number

19

16

ST

O

   

00122

SSN Number - Patient

20

25

CM

O

   

00123

Driver's License Number - Patient

21

20

CX

O

Y

 

00124

Mother's Identifier

22

3

IS

O

 

0189

00125

Ethnic Group

23

60

ST

O

   

00126

Birth Place

24

2

ID

O

 

0136

00127

Multiple Birth Indicator

25

2

NM

O

   

00128

Birth Order

26

4

IS

O

Y

0171

00129

Citizenship

27

60

CE

O

 

0172

00130

Veterans Military Status

28

80

CE

O

   

00739

Nationality

29

26

TS

O

   

00740

Patient Death Date and Time

30

1

ID

O

 

0136

00741

Patient Death Indicator

Attachment 4

Product Experience Segments

PES - product experience sender segment

PES attributes

SEQ

LEN

DT

OPT

RP/ #

TBL #

ITEM #

ELEMENT NAME

1

80

XON

O

   

01059

Sender Organization Name

2

60

XCN

O

Y

 

01060

Sender Individual Name

3

200

XAD

O

Y

 

01062

Sender Address

4

44

XTN

O

Y

 

01063

Sender Telephone

5

75

EI

O

   

01064

Sender Event Identifier

6

2

NM

O

   

01065

Sender Sequence Number

7

600

FT

O

Y

 

01066

Sender Event Description

8

600

FT

O

   

01067

Sender Comment

9

26

TS

O

   

01068

Sender Aware Date/Time

10

26

TS

R

   

01069

Event Report Date

11

3

ID

O

Y/2

0234

01070

Event Report Timing/Type

12

1

ID

O

 

0235

01071

Event Report Source

13

1

ID

O

Y

0236

01072

Event Reported To

PEO - product experience observation segment

Details related to a particular clinical experience or event are embodied in the PEO segment. This segment can be used to characterize an event which might be attributed to a product to which the patient was exposed. Products with a possible causal relationship to the observed experience are described in the following PCR (possible causal relationship) segments. The message format was designed to be robust and includes many optional elements which may not be required for a particular regulatory purpose but allow a complete representation of the drug experience if needed.

A PEX message can contain multiple PEO segments if the patient experienced more than one event but must contain at least one PEO segment.

PEO attributes

SEQ

LEN

DT

OPTC

RP/ #

TBL #

ITEM #

ELEMENT NAME

1

60

CE

O

Y

 

01073

Event Identifiers Used

2

60

CE

O

Y

 

01074

Event Symptom/Diagnosis Code

3

26

TS

R

   

01075

Event Onset Date/Time

4

26

TS

O

   

01076

Event Exacerbation Date/Time

5

26

TS

O

   

01077

Event Improved Date/Time

6

26

TS

O

   

01078

Event Ended Data/Time

7

106

XAD

O

   

01079

Event Location Occurred Address

8

1

ID

O

Y

0237

01080

Event Qualification

9

1

ID

O

 

0238

01081

Event Serious

10

1

ID

O

 

0239

01082

Event Expected

11

1

ID

O

Y

0240

01083

Event Outcome

12

1

ID

O

 

0241

01084

Patient Outcome

13

600

FT

O

Y

 

01085

Event Description From Others

14

600

FT

O

Y

 

01086

Event From Original Reporter

15

600

FT

O

Y

 

01087

Event Description From Patient

16

600

FT

O

Y

 

01088

Event Description From Practitioner

17

600

FT

O

Y

 

01089

Event Description From Autopsy

18

60

CE

O

Y

 

01090

Cause Of Death

19

46

XPN

O

   

01091

Primary Observer Name

20

106

XAD

O

Y

 

01092

Primary Observer Address

21

40

XTN

O

Y

 

01093

Primary Observer Telephone

22

1

ID

O

 

0242

01094

Primary Observer's Qualification

23

1

ID

O

 

0242

01095

Confirmation Provided By

24

26

TS

O

   

01096

Primary Observer Aware Date/Time

25

1

ID

O

 

0243

01097

Primary Observer's identity May Be Divulged

PCR - possible causal relationship segment

The PCR segment is used to communicate a potential or suspected relationship between a product (drug or device) or test and an event with detrimental effect on a patient. This segment identifies a potential causal relationship between the product identified in this segment and the event identified in the PEO segment.

More than one PCR segment can be included in the message if more than one product is possibly causally related to the event.

PCR attributes

SEQ

LEN

DT

OPT

RP/ #

TBL #

ITEM #

ELEMENT NAME

1

60

CE

R

   

01098

Implicated Product

2

1

IS

O

 

0239

01099

Generic Product

3

60

CE

O

   

01100

Product Class

4

8

CQ

O

   

01101

Total Duration Of Therapy

5

26

TS

O

   

01102

Product Manufacture Date

6

26

TS

O

   

01103

Product Expiration Date

7

26

TS

O

   

01104

Product Implantation Date

8

26

TS

O

   

01105

Product Explanation Date

9

8

IS

O

 

0239

01106

Single Use Device

10

60

CE

O

   

01107

Indication For Product Use

11

8

IS

O

 

0239

01108

Product Problem

12

30

ST

O

Y/3

 

01109

Product Serial/Lot Number

13

1

IS

O

 

0239

01110

Product Available For Inspection

14

60

CE

O

   

01111

Product Evaluation Performed

15

60

CE

O

 

0247

01112

Product Evaluation Status

16

60

CE

O

   

01113

Product Evaluation Results

17

8

ID

O

 

0248

01114

Evaluated Product Source

18

26

TS

O

   

01115

Date Product Returned To Manufacturer

19

1

ID

O

 

0242

01116

Device Operator Qualifications

20

1

ID

O

 

0250

01117

Relatedness Assessment

21

2

ID

O

Y/6

0251

01118

Action Taken In Response To The Event

22

2

ID

O

Y/6

0232

01119

Event Causality Observations

23

1

ID

O

Y/3

0253

01120

Indirect Exposure Mechanism

PSH - product summary header segment

PSH attributes

SEQ

LEN

DT

OPT

RP/ #

TBL #

ITEM #

ELEMENT NAME

1

60

ST

R

   

01233

Report Type

2

60

ST

O

   

01234

Report Form Identifier

3

26

TS

R

   

01235

Report Date

4

26

TS

O

   

01236

Report Interval Start Date

5

26

TS

O

   

01237

Report Interval End Date

6

12

CQ

O

   

01238

Quantity Manufactured

7

12

CQ

O

   

01239

Quantity Distributed

8

1

ID

O

 

0329

01240

Quantity Distributed Method

9

600

FT

O

   

01241

Quantity Distributed Comment

10

12

CQ

O

   

01242

Quantity in Use

11

1

ID

O

 

0329

01243

Quantity in Use Method

12

600

FT

O

   

01244

Quantity in Use Comment

13

2

NM

O

Y/8

 

01245

Number of Product Experience Reports Filed by Facility

14

2

NM

O

Y/8

 

01246

Number of Product Experience Reports Filed by Distributor

PDC - product detail country segment

PDC attributes

SEQ

LEN

DT

OPT

RP/ #

TBL #

ITEM #

ELEMENT NAME

1

80

XON

R

   

01247

Manufacturer/Distributor

2

60

CE

R

   

01248

Country

3

60

ST

R

   

01249

Brand Name

4

60

ST

O

   

01250

Device Family Name

5

60

CE

O

   

01251

Generic Name

6

60

ST

O

Y

 

01252

Model Identifier

7

60

ST

O

   

01253

Catalogue Identifier

8

60

ST

O

Y

 

01254

Other Identifier

9

60

CE

O

   

01255

Product Code

10

4

ID

O

 

0330

01256

Marketing Basis

11

60

ST

O

   

01257

Marketing Approval ID

12

12

CQ

O

   

01258

Labeled Shelf Life

13

12

CQ

O

   

01259

Expected Shelf Life

14

26

TS

O

   

01260

Date First Marked

15

26

TS

O

   

01261

Date Last Marked

FAC - facility segment

FAC attributes

SEQ

LEN

DT

OPT

RP/ #####

TBL #

ITEM #

ELEMENT NAME

1

20

EI

R

   

01262

Facility ID

2

1

ID

O

 

0331

01263

Facility Type

3

200

XAD

R

   

01264

Facility Address

4

44

XTN

R

   

01265

Facility Telecommunication

5

60

XCN

O

Y

 

01266

Contact Person

6

60

ST

O

Y

 

01267

Contact Title

7

200

XAD

O

Y

 

01268

Contact Address

8

44

XTN

O

Y

 

01269

Contact Telecommunication

9

60

XCN

R

   

01270

Signature Authority

10

60

ST

O

   

01271

Signature Authority Title

11

200

XAD

O

   

01272

Signature Authority Address

12

44

XTN

O

   

01273

Signature Authority Telecommunication