Standards Documents

Enter a search term to find standard and specification articles.

Admit Discharge and Transfer Specification v2-1

UHIN STANDARDS COMMITTEE

UHIN Admit/Discharge/Transfer (ADT) Specification

Origination Date: 01/21/2010

Approved

 

 

 

 

 

UHIN STANDARDS COMMITTEE

Version 2.1

Admit, Discharge and Transfer Specification

 

Admit, Discharge and Transfer Specification is compatible with all HL7 version 2.3 message standards.

 

 

Purpose

The Admit, Discharge and Transfer Specification is an implementation guide providing the message framework of Admit, Discharge and Transfer (ADT) messages based on the HL7 version 2.3 Standard for ADT messages which are exchanged via the UHIN gateway.

 

This Specification contains the minimum requirements for Admit, Discharge and Transfer messages.

 

The details of the Admit, Discharge and Transfer (ADT) message can be found in Appendices A, B and C.

 

Applicability

UHIN trading partners who exchange HL7 version 2.3 ADT messages via the UHIN gateway.

 

Basic Concepts

  • A sender will create an HL7 version 2.3 ADT message.
  • The sender will send the HL7 version 2.3 ADT message to the identified receiver.
  • The receiver will follow the Clinical Acknowledgement and Error Status Standard to send the applicable acknowledgment and/or error status response back to the sender who submitted the HL7 version 2.3 ADT message.

 

Detail 

The structure(s) in Appendix B provides an overview of the HL7 segment usage (e.g. repetitions, optional) used in this Specifications.

 

This document standardizes ADT messages for use in electronic exchanges of ADT messages between UHIN trading partners.

 

This does not preclude trading partners from using version 2.3.1 through 2.5.1 to create ADT messages, but these messages must be compliant with the minimum requirements of this Specification.

 

Implementation Issues

  • General:
    • Senders/Receivers must have an HL7 translator or use a third-party software tool (e.g. E-lite) to create and/or receive HL7 version 2.3 ADT messages.

 

  • Senders:
    • A sender will communicate their desire to exchange an intended HL7 version 2.3 ADT message to the receiver, prior to the first exchange of data.  

 

 

  • Receivers:
    • A receiver is able to receive the intended HL7 version 2.3 ADT message from the sender.

 

 

 

 

History: (MM/DD/YY)

 

Original

A* 1

A 2

A2.1

A 3

A 4

ORIGINATION DATE

 

 

2/26/2009

01/21/2010

 

 

APPROVAL DATE

 

 

05/15/2009

11/03/2010

 

 

EFFECTIVE DATE

 

 

06/15/2009

12/03/2010

 

 

* A = Amendment

 


Admit Discharge Transfer (ADT) Specification Contents

 

Trigger Event ADT^A01

Trigger Event ADT^A02

Trigger Event ADT^A03

Trigger Event ADT^A04

Trigger Event ADT^A05

Trigger Event ADT^A07

Trigger Event ADT^A08

Trigger Event ADT^A11

Trigger Event ADT^A13

Trigger Event ADT^A17

Trigger Event ADT^A18

Trigger Event ADT^A28

Trigger Event ADT^A31

Trigger Event ADT^A34

Trigger Event ADT^A35

Trigger Event ADT^A42

Appendix C – Attribute Table

Table 1 – HL7– MSH – Message Header

Table 2 – HL7 – EVN – Event Type

Table 3 – HL7 – PID – Patient Identification Segment

Table 4 – HL7 – PD1 – Additional Demographics Segment

Table 5 – HL7 – NK1 – Next of Kin/Associated Parties Segment

Table 6 – HL7 – PV1 – Patient Visit Segment

Table 7 – HL7 – PV2 – Patient Visit Additional Information Segment

Table 8 – HL7 – AL1 – Allergies Segment

Table 9 – HL7 – DG1 – Diagnosis Information Segment

Table 10 – HL7 – PR1 – Procedures Segment

Table 11 – HL7 – GT1 – Guarantor Segment

Table 12 – HL7 – IN1 – Insurance Segment

Table 13 – HL7 – ACC – Accident Segment

Table 14 – HL7 – MRG – Merge Patient Information Segment

Table 14 – (User Defined) – ZAR – Access Restriction Segment

Table 15 – HL7 – MSH/ACK –Acknowledgement Header

Table 16 – HL7 – MSA – Message Acknowledgement Segment

Table 17 – HL7 – ERR – Error Segment

Table 18 – HL7 Table 0062 – Event Reason (See HL7 v2.3 Standard)

Table 19 – HL7 User-Defined Table 0200 – Name Type Codes (See HL7 v2.3 Standard)

Table 20 – HL7 Table 0001 – Sex (See HL7 v2.3 Standard)

Table 21 – HL7 User-Defined Table 0005 – Race (See HL7 v2.4 Standard)

Table 22 – HL7 User-Defined Table 0002 – Marital Status (See HL7 v2.3 Standard)

Table 23 – HL7 User-Defined Table 0006 – Religion (See HL7 v2.4 Standard)

Table 24 – HL7 User-Defined Table 0136 – Yes/No Indicator (See HL7 v2.3 Standard)

Table 25 – HL7 User-Defined Table 0223 – Living Dependency (See HL7 v2.3 Standard)

Table 26 – HL7 User-Defined Table 0220 – Living Arrangement (See HL7 v2.3 Standard)

Table 27 – HL7 User-Defined Table 0231 – Student Status (See HL7 v2.3 Standard)

Table 28 – HL7 User-Defined Table 0315 – Living Will (See HL7 v2.3 Standard)

Table 29 – HL7 User-Defined Table 0316 – Organ Donor (See HL7 v2.3 Standard)

Table 30 – HL7 User-Defined Table 0215 – Publicity Code (See HL7 v2.4 Standard)

Table 31 – HL7 User-Defined Table 0063 – Relationship (See HL7 v2.4 Standard)

Table 32 – HL7 User-Defined Table 0004 – Patient Class (See HL7 v2.3 Standard)

Table 33 – HL7 User-Defined Table 0007 – Admission Type (See HL7 v2.3 Standard)

Table 34 – User-Defined Table 0112 – Discharge Disposition

Table 35 – HL7 Table 0125 – Value Type (See HL7 v2.3 Standard)

Table 36 – HL7 User-Defined Table 0127 – Allergy Type (See HL7 v2.3 Standard)

Table 37 – HL7 User-Defined Table 0128 – Allergy Severity (See HL7 v2.3 Standard)

Table 38 – HL7 User-Defined Table 0053 – Diagnosis Coding Method (See HL7 v2.3 Standard)

Table 39 – HL7 User-Defined Table 0052 – Diagnosis Type (See HL7 v2.3 Standard)

Table 40 – HL7 User-Defined Table 0230 – Procedure Functional Type (See HL7 v2.3 Standard)

Table 41 – HL7 User-Defined Table 0396 – Coding System

Table 43 – HL7 User-Defined Table 0206 – Segment Action Code

Table 44 – HL7 User-Defined Table 0717 – Access Restriction Value

Table 45 – HL7 User-Defined Table 0719 – Access Restriction Reason Code


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Appendix A – Basic Definitions

 

Basic Definitions

 

  • Data Type (DT) – The basic building block used to construct or restrict the contents of a data field. 
    • CE – Coded element.
    • CK – Composite ID with check digit.
    • CM – Composite
    • CN – Composite ID number and name.
    • DT – Date, Date/time YYYYMMDD
    • FN – Family name
    • FT – Formatted text
    • ID – Coded values for HL7 tables, all components are a ST data type
    • IS – Coded value for user-defined table.
    • PN – person name
    • SI – Sequence IDA positive integer in the form of an NM field.
    • ST – String, alphanumeric.
    • TQ – Timing/quantity
    • TS – Times stamp, date/time.  Exact time if the event, including date/time.
    • TX – Text data
  • Element/Field – A string of characters, see SEQ.
  • Health Level 7 (HL7[1]) – HL7 is a Standards Development Organization (SDO) and focuses on the interface requirements between healthcare information systems.
  • Maximum Length (LEN) – Maximum number of characters that one occurrence of the data field may occupy.
  • Optionality (OPT) – Whether the field is required, optional, or conditional in a segment.
    • R – Required
    • O – Optional
    • C Conditional
  • Position (Sequence within the segment, SEQ)See SEQ.
  • Repetition (RP#) – Whether the field may repeat.
    • N or blank – No repetition
    • Y – The field may repeat an indefinite or site-determined number of times.
    • (integer) – The field may repeat up to the number of times specified by the integer.
  • Segment – A logical grouping of fields (e.g. MSH, PID, PV1, OBX). 
  • SEQ– Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.
  • Table (TBL#) – The table attribute of the data field definition specifies the HL7 identifier for a set of coded values.
  • Delimiter values

 

Delimiter

Suggested Value

Encoding Character Position

Usage

Segment Terminator

<CR>

Terminates a segment record.  This value cannot be changed by implementers

Field Separator

|

Separates two adjacent data fields within a segment.  It also separates the segment ID from the first data field in each segment

Component Separator

^

1

Separates adjacent components of data fields where allowed

Subcomponent Separator

&

4

Separates adjacent subcomponents of data fields where allowed.  If there are no subcomponents, this character may be omitted.

Repetition Separator

~

2

Separates multiple occurrences of a field where allowed

Escape Character

\

3

Escape character for use with any field represented by an ST, TX or FT data type, or for use with the data (fourth) component of the ED data type.  If no escape characters are used in a message, this character may be omitted.  However, it must be present if subcomponents are used in the message.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Appendix B Trigger Event Structure(s)

 

 

 

 

 

 

 

 

Detail 

This structure provides an overview of the HL7 segment usage (e.g. repetitions, optional) used in this Specification.

 

Braces { } = Indicate one or more repetitions of the enclosed group of segments

Brackets [ ] = Show that the enclosed group of segments is optional.

 

Trigger Event ADT^A01

 

ADT^A01                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

 [{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

 [ACC]       Accident Information6

[ZAR]          Access Restrictions

Trigger Event ADT^A02

 

ADT^A02                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[ZAR]          Access Restrictions

 

 


Trigger Event ADT^A03

 

ADT^A03                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{PR1}]       Procedures6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

Trigger Event ADT^A04

 

ADT^A04                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

 [{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

 


Trigger Event ADT^A05

 

ADT^A05                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

 [{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

 [{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

Trigger Event ADT^A07

 

ADT^A07                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

 [{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions


Trigger Event ADT^A08

 

ADT^A08                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

 [{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

 

Trigger Event ADT^A11

 

ADT^A11                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{DG1}]       Diagnosis Information6

[ZAR]          Access Restrictions

 


Trigger Event ADT^A13

 

ADT^A13                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

 

Trigger Event ADT^A17

 

ADT^A17                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{OBX}]           Observation/Result                           7

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[ZAR]          Access Restrictions

 

 

 

 

 

 

 

 

 

Trigger Event ADT^A18

 

ADT^A18                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[MRG]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[ZAR]          Access Restrictions

 

Trigger Event ADT^A28

 

ADT^A28                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 


Trigger Event ADT^A31

 

ADT^A31                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

[{NK1}]       Next of Kin/Associated Parties3

PV1        Patient Visit3

[PV2]        Patient Visit Additional Info 3

[{AL1}]       Allergy Information3

[{DG1}]       Diagnosis Information6

[{PR1}]       Procedures6

[{GT1}]       Guarantor6

[{IN1}]       Insurance6

[ACC]       Accident Information6

[ZAR]          Access Restrictions

 

 

Trigger Event ADT^A34

 

ADT^A34                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

MRG       Merge Information3

[ZAR]          Access Restrictions

 

Trigger Event ADT^A35

 

ADT^A35                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

PID                  Patient Identification                  3

[PD1]       Additional Demographics3

MRG       Merge Information3

[ZAR]          Access Restrictions

 

 

Trigger Event ADT^A42

 

ADT^A42                Admit, Transfer and Discharge   HL7 Standard ChapterChapter  

(See MSH-9.2

trigger event)


 

MSH                Message Header                         

EVN        Event Type3   

{PID}                  Patient Identification                  3

[PD1]       Additional Demographics3

MRG       Merge Information3

[PV1]       Patient Visit3

[ZAR]          Access Restrictions

 

 

 

 

 

Appendix C – Attribute Table

 

 

These tables list and describe the data fields in the segment and characteristics of their usage. 

 

 

                Table 1 – HL7– MSH – Message Header

 

(Please reference HL7 Header and Trailer Specification

for those fields not addressed below)

 

 

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

MSH| ^~\&| |9999^ | |1111^|20060126130405| |ADT^A01|20060126130405|P|2.3| | |ER

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

 

ITEM#

Element

Comments

9

13

 

CM

 

R

 

 

00009

Message Type

Composite

9.1

 

ID

R

 

 

 

Message Type

Use “ADT

9.2

 

ID

R

 

 

 

Trigger Event

May use the following trigger events-

A01 Admit/visit notificaiton.

A02”  Transfer a patient

A03” Discharge/end visit

“A04”  Register a patient

“A05”  Preadmit a patient

“A07”  Change an inpatient to an outpatient

“A08”  Update patient information

“A11”  Cancel admit/visit notification

“A13”  Cancel discharge/ end visit

“A17”  Swap patients

“A18”  Merge patient information

“A28”  Add person information

“A31”  Update person information

“A34”  Merge patient information ID only

“A35”  Merge patient information account number only

“A42”  Merge visit – visit number

 

12

8

CM

R

 

 

 

00012

Version ID

Composite

12.1

 

ID

R

 

 

 

Version ID

Use “2.3

 

 

 

Table 2 – HL7 – EVN – Event Type

 

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

EVN| |20060126130405 | | | | |

 

SEQ

LEN

DT

OPT

RP#

TBL#

 

ITEM#

Element

Comments

1

3

ID

B

 

 

00099

Event Type Code

This field is for backward compatibility only.

 

See MSH-9.2 allowable “trigger event(s)”

2

26

TS

R

 

 

00100

Recorded Date/Time

 

3

26

TS

O

 

 

00101

Date/Time Planned Event

 

4

3

IS

O

 

0062

00102

Event Reason Code

See table 18

5

60

XCN

O

 

 

00103

Operator ID

 

6

26

TS

O

 

 

01278

Event Occurred

 


Table 3HL7 – PID – Patient Identification Segment

 

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

PID|1| |123456| |SMITH^JOHN^^JR| |19650201|M| | | | | | | | | | | | | | | | | | | | | | |

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

O

 

[0..1]

 

00104

Set ID PID

This states the number of PID records

2

 

 

N/A

 

 

00105

Patient ID (external ID)

Not used at this time for HL7 ADT Message(s)

 

3

20

 

CX

 

R

[1..*]

 

00106

Patient ID (Internal ID)

Composite

 

This includes the provider patient identification number (see 3.5). 

3.1

 

ST

R

 

 

 

ID Number

The ID number for the 3.5 qualifier.

3.2

 

 

N/A

 

 

 

 

 

3.3

 

 

N/A

 

 

 

 

 

3.4

 

 

R

 

 

 

Assigning Authority

Refers to the source organization or enterprise

3.4.1

 

 

R

 

 

 

Namespace ID

Identifier to be defined by trading partner

3.4.2

 

 

O

 

 

 

Universal ID

If the community master patient index identifier is used, it should be placed here.

3.4.3

 

 

O

 

 

 

Universal ID Type

If the community master patient index identifier is used, “Elysium” should be placed here.

3.5

 

 

R

 

 

 

Identifier Type Code

Provider patient identification number(s) values are limited to at least one identifier are required.

 

“MR” – Medical Record Number.

“NI” –  National unique individual identifier

“NNxxx” – National person identifier

“PI” – Patient internal identifier

“PN” – Person number; OR

“PT” – Patient external identifier”.

 

3.6

 

 

R

 

 

 

Assigning facility

Refers to the facility within the organization or enterprise (only needed if ID is facility specific).

3.6.1

 

 

R

 

 

 

Namespace ID

Identifier to be defined by trading partner

3.6.2

 

 

O

 

 

 

Universal ID

If the community facility identifier is used, it should be placed here.

3.6.3

 

 

O

 

 

 

Universal ID Type

If the community facility identifier is used, “Elysium” should be placed here.

4

20

CX

O

Y

 

00107

Alternative Patient ID – PID

 

5

48

XPN

R

[1..*]

0200

00108

Patient Name

Composite

 

It is recommended that the patient name follow UHIN Individual Name Standard

 

See table 19

5.1

 

FN

R

 

 

 

Family Name

Required that something is placed in this field even with anonymous patients

5.2

 

ST

O

 

 

 

Given Name

Recommend use, if available

5.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

5.4

 

ST

O

 

 

 

Suffix

Recommend use, if available

5.5

 

ST

O

 

 

 

Prefix

 

5.6

 

ST

O

 

 

 

Degree

 

5.7

 

ID

O

 

 

 

Name Type Code

 

6

48

XPN

O

 

 

00109

Mothers Maiden Name

 

6.1

 

FN

R

 

 

 

Family Name

 

7

26

 

TS

O

[0..1]

 

00110

Date/Time of Birth

Composite.

 

 

7.1

 

TS

 

O

 

 

 

Date only format “CCYYMMDD”

 

Recommend use, if available

8

1

IS

R

 

[0..1]

0001

000111

Sex

See table 20

9

 

 

N/A

 

 

 

Patient Alias

Not used at this time for HL7 ADT Message(s)

 

10

1

IS

O

 

0005

00113

Race

See table 21

11

106

XAD

C

[1..*]

 

00114

Patient Address

Composite

 

Required if a patient address is known

11.1

 

ST

R

 

 

 

Street Address

 

11.2

 

ST

O

 

 

 

Other Designation

 

11.3

 

ST

R

 

 

 

City

 

11.4

 

ST

R

 

 

 

State or Province

 

11.5

 

ST

R

 

 

 

Zip or Postal Code

 

12

 

 

N/A

 

 

 

Country Code

Not used at this time for ADT Message(s)

 

13

40

XTN

O

[1..*]

 

00116

Phone Number – Home

Personal phone number(s)

 

Example

(999) 999-9999

14

40

XTN

O

[1..*]

 

00117

Phone Number Work

Business phone number(s)

 

Example

(999) 999-9999

15

 

 

 

 

 

 

Primary Language

Not used at this time for HL7 ADT Message(s)

16

1

IS

O

 

0002

00119

Marital Status

See table 22

17

3

IS

O

 

0006

00120

Religion

See table 23

18

20

CX

O

 

 

00121

Patient Account Number

Recommend use, if available

19

16

ST

O

 

 

00122

SSN

 

20

25

DLN

O

 

 

00123

Drivers License Number

Composite

20.1

 

ST

O

 

 

 

License #

 

20.2

 

ID

O

 

 

 

Issuing State or Province

 

20.3

 

DT

O

 

 

 

Expiration Date

 

21

20

CX

O

[1..*]

 

00124

Mothers Identifier

 

22 thru 23

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

24

2

ID

O

 

0136

00127

Multiple Birth Indicator

Recommend use, if available

 

See table 24

25

2

NM

O

 

 

00128

Birth Order

Recommend use, if available

26

 

 

 

 

 

 

Citizenship

Not used at this time for HL7 ADT Message(s)

27 thru 28

 

 

 

 

 

 

 

 

Not used at this time for HL7 ADT Message(s)

29

26

TS

O

 

 

00740

Patient Death Date and Time

 

30

1

ID

O

 

0136

00741

Patient Death Indicator

See table 24

 


Table 4HL7 – PD1 – Additional Demographics Segment

 

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

PD1|1| |123456| |SMITH^JOHN^^JR| |19650201|M| | | | | | | | | | | | | | | | | | | | | | |

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

2

IS

O

 

[1..*]

0223

00755

Living Dependency

See table 25

2

2

IS

O

 

0220

00742

Living Arraingment

See table 26

3

90

 

XON

 

O

[1..*]

 

00756

Patient Primary Facility

 

4

90

XCN

C

[1..*]

 

00757

Patient Primary Care Provider Name and ID #

Required if there is a known primary care provider

 

4.1

 

ST

C

 

 

 

ID Number

The ID number for the 4.13 qualifier.

 

Note:  The  ID number is the NPI

 

4.2

 

FN

R

 

 

 

Family Name

 

4.3

 

ST

R

 

 

 

Given Name

 

4.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

4.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

4.6

 

ST

O

 

 

 

Prefix

 

4.8 thru 4.12

 

 

N/A

 

 

 

 

 

4.13

 

ID

R

 

 

 

Identifier Type Code

Value is limited to: “NPI” (National Provider Identifier)

 

5

2

IS

O

 

0231

00745

Student Indicator

See table 27

6

 

 

 

 

 

 

Handicap

Not used at this time for HL7 ADT Message(s)

7

2

IS

O

 

0315

00759

Living Will

See table 28

8

2

IS

O

 

0316

00760

Organ Donor

See table 29

9

1

ID

O

 

0136

00761

Separate Bill

See table 24

10

20

CX

O

[1..*]

 

00762

Duplicate Patient

 

11

80

CE

O

 

0215

00743

Publicity Code

See table 26

12

1

ID

O

 

0136

00744

Protection Indicator

See table 24


Table 5 – HL7 – NK1 Next of Kin/Associated Parties Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

NK1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

O

 

 

00190

Set ID – NK1

 

2

48

XPN

O

Y

 

00191

Name

 

2.1

 

FN

R

 

 

 

Family Name

 

2.2

 

ST

O

 

 

 

Given Name

Recommend use, if available

2.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

2.4

 

ST

O

 

 

 

Suffix

Recommend use, if available

2.5

 

ST

O

 

 

 

Prefix

 

2.6

 

ST

O

 

 

 

Degree

 

2.7

 

ID

O

 

 

 

Name Type Code

 

3

60

CE

O

 

0063

00192

Relationship

Recommend use, if available

 

See table 31

3.1

 

FN

R

 

 

 

Identifier

 

3.2

 

ST

O

 

 

 

Text

 

3.3

 

ST

O

 

 

 

Name of Coding System

See table 41

4

106

XAD

O

Y

 

00193

Address

 

4.1

 

ST

R

 

 

 

Street Address

 

4.2

 

ST

O

 

 

 

Other Designation

 

4.3

 

ST

R

 

 

 

City

 

4.4

 

ST

R

 

 

 

State or Province

 

4.5

 

ST

R

 

 

 

Zip or Postal Code

 

5

40

XTN

O

Y

 

00194

Phone Number

Personal phone number(s)

 

Example

(999) 999-9999

6

40

XTN

O

Y

 

00195

Business Phone Number

Business phone number(s)

 

Example

(999) 999-9999

7 through 14

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

15

1

IS

O

 

0001

00111

Administrative Sex

See table 20

16

26

TS

O

 

 

00110

Date/Time of Birth

 

17 through 38

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

 


Table 6 – HL7 PV1 – Patient Visit Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

PV1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

O

 

 

00131

Set ID – PV1

 

2

1

ID

R

 

0004

00132

Patient Class

See table 32

 

3

80

PL

O

 

 

00133

Assigned Patient Location

If present, recommend to send

 

3.1

 

IS

O

 

 

 

Point of Care

 

3.2

 

IS

O

 

 

 

Room

 

3.3

 

IS

O

 

 

 

Bed

 

4

2

IS

O

 

0007

00134

Admission Type

If present, recommend to send

 

See table 33

5

20

CX

O

 

 

00135

Preadmit Number

 

6

 

 

N/A

 

 

 

Prior Patient Location

Not used at this time for HL7 ADT Message(s)

 

 

7

60

 

XCN

C

 

0010

00137

Attending Doctor

Required if there is an attending doctor

 

7.1

 

ST

R

 

 

 

ID Number

The ID number for the 7.13 qualifier.

 

Note:  The  ID number is the NPI

 

7.2

 

FN

R

 

 

 

Family Name

 

7.3

 

ST

R

 

 

 

Given Name

 

7.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

7.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

7.6

 

ST

O

 

 

 

Prefix

 

7.8 thru 7.12

 

 

N/A

 

 

 

 

 

7.13

 

ID

R

 

 

 

Identifier Type Code

Value is limited to: “NPI” (National Provider Identifier)

 

 

See table 40

 

8

60

XCN

C

[1..*]

0010

00138

Referring Doctor

Required if there is a referring doctor

 

8.1

 

ST

R

 

 

 

ID Number

The ID number for the 8.13 qualifier.

 

Note:  The  ID number is the NPI

 

8.2

 

FN

R

 

 

 

Family Name

 

8.3

 

ST

R

 

 

 

Given Name

 

8.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

8.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

8.6

 

ST

O

 

 

 

Prefix

 

8.8 thru 8.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

8.13

 

ID

R

 

 

 

Identifier Type Code

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 

9

60

 

XCN

C

Y

0010

00139

Consulting Doctor

Required if there is a consulting doctor

 

 

See table 12

9.1

 

ST

R

 

 

 

ID Number

If PV1-9 is populated, this element is required

 

The ID number for the 9.13 qualifier.

 

 

NOTE: The  ID number is the NPI.

 

9.2

 

FN

R

 

 

 

Family Name

 

9.3

 

ST

R

 

 

 

Given Name

 

9.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

9.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

9.6

 

ST

O

 

 

 

Prefix

 

9.8 thru 9.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

9.13

 

ID

C

 

 

 

Identifier Type Code

If PV1-9.1 is populated, this element is required

 

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 

10 thru 16

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

17

60

 

XCN

C

Y

0010

00139

Admitting Doctor

Required if there is a admitting doctor

 

 

See table 12

17.1

 

ST

R

 

 

 

ID Number

If PV1-17 is populated, this element is required

 

The ID number for the 17.13 qualifier.

 

 

NOTE: The  ID number is the NPI.

 

17.2

 

FN

R

 

 

 

Family Name

 

17.3

 

ST

R

 

 

 

Given Name

 

17.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

17.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

17.6

 

ST

O

 

 

 

Prefix

 

17.8 thru 17.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

17.13

 

ID

C

 

 

 

Identifier Type Code

If PV1-17.1 is populated, this element is required

 

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 

18

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

19

15

NM

R

 

 

00149

Visit Number

This can also be the encounter #

20 thru 35

 

 

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

36

3

IS

R

 

0112

00166

Discharge Disposition

See table 34

37 thru 43

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

44

26

TS

O

 

 

00174

Admit Date/Time

Use “CCYYMMDDHHMM”

 

If present, recommend to send

 

45

26

TS

O

 

 

00174

Discharge Date/Time

Use “CCYYMMDDHHMM”

 

If present, recommend to send

 

46 thru 49

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

50

20

CX

O

 

0192

00180

Alternative Visit Number

See table 42

 

51 thru 52

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

 


Table 7 – HL7 – PV2 – Patient Visit Additional Information Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

PV1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

80

PL

C

 

 

00181

Prior Pending Location

 

2 thru 4

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

5

25

ST

O

Y

 

00185

Patient Valuables

 

6

25

ST

O

 

 

00186

Patient Valuables Locations

 

7

 

 

N/A

 

 

 

Visit User Code

Not used at this time for HL7 ADT Message(s)

 

8

26

TS

O

 

 

00188

Expected Admit Date/Time

 

9

26

TS

O

 

 

 

Expected Dischage Date/Time

 

10 thru 37

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

 

Table 8 – HL7 – AL1 – Allergies Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

AL1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

R

 

 

00203

Set ID – AL1

 

2

2

IS

O

 

0127

00204

Allergy Type

See table 36

3

60

CE

R

 

 

00205

Allergy Code/Mnemonic/Description

 

3.1

 

ST

O

 

 

 

Identifier

Recommend use, if available

 

3.2

 

ST

R

 

 

 

Text

Agreed upon by trading partners

 

3.3

 

ST

R

 

 

 

Name of Coding System

 

4

2

IS

O

 

0128

00206

Allergy Severity

See table 37

 

5

15

ST

O

 

 

00207

Allergy Reaction

 

6

8

DT

O

 

 

00208

Identification Date

 


Table 9 – HL7 – DG1 – Diagnosis Information Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

DG1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

R

 

 

00375

Set ID – DG1

 

2

2

IS

(B)R

 

0053

00376

Diagnosis Coding Method

See table 38

 

3

60

CE

O

 

 

00377

Diagnosis Code

See table 39

 

4

40

ST

B

 

 

00378

Diagnosis Description

 

5

 

 

N/A

 

 

 

Diagnosis Date/Time

Not used at this time for ADT Message(s)

 

6

2

IS

R

 

0052

00380

Diagnosis Type

See table 39

 

7

 

 

N/A

 

 

 

Major Diagnostic Category

Not used at this time for ADT Message(s)

 

8

60

CE

B

 

0055

0382

Diagnostic  Related Group

See table 49

 

9 thru 19

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 


Table 10 – HL7 – PR1 – Procedures Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

PR1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

R

 

 

00391

Set ID – PR1

 

2

 

 

N/A

 

 

 

Procedure Coding (method)

Not used at this time for ADT Message(s)

 

3

80

CE

R

 

0088

00393

Procedure Code

See table 50

 

3.1

 

ST

R

 

 

 

Identifier

 

3.2

 

ST

R

 

 

 

Text

 

3.3

 

ST

R

 

 

 

Name of Coding System

 

4

40

ST

B

 

 

00394

Procedure Description

 

5

26

TS

R

 

 

00395

Procedure Date/Time

 

6

2

IS

R

 

0230

00396

Procedure Functional Type

See table 40

 

 

 

 

 

 

 

 

 

 

7

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

8

120

XCN

C

Y

0010

00398

Aneshesiologist

Required if there is an Aneshesiologist

 

 

See table 12

8.1

 

ST

R

 

 

 

ID Number

If PV1-8 is populated, this element is required

 

The ID number for the 8.13 qualifier.

 

 

NOTE: The  ID number is the NPI.

 

8.2

 

FN

R

 

 

 

Family Name

 

8.3

 

ST

R

 

 

 

Given Name

 

8.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

8.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

8.6

 

ST

O

 

 

 

Prefix

 

8.8 thru 8.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

8.13

 

ID

C

 

 

 

Identifier Type Code

If PV1-8.1 is populated, this element is required

 

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 

9 through 10

 

 

 

 

 

 

 

Not used at this time for ADT Message(s)

 

11

120

XCN

C

Y

0010

00401

Surgeon

Required if there is a surgeon

 

 

 

11.1

 

ST

R

 

 

 

ID Number

If PV1-11 is populated, this element is required

 

The ID number for the 11.13 qualifier.

 

 

NOTE: The  ID number is the NPI.

 

     11.2

 

FN

R

 

 

 

Family Name

 

11.3

 

ST

R

 

 

 

Given Name

 

11.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

11.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

11.6

 

ST

O

 

 

 

Prefix

 

11.8 thru 11.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

11.13

 

ID

C

 

 

 

Identifier Type Code

If PV1-11.1 is populated, this element is required

 

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 

12

230

XCN

C

Y

0010

00402

Procedure Practioner

Required if there is a Procedure Practioner

 

 

See table 12

12.1

 

ST

R

 

 

 

ID Number

If PV1-12 is populated, this element is required

 

The ID number for the 12.13 qualifier.

 

 

NOTE: The  ID number is the NPI.

 

     12.2

 

FN

R

 

 

 

Family Name

 

12.3

 

ST

R

 

 

 

Given Name

 

12.4

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

12.5

 

ST

O

 

 

 

Suffix

Recommend use, if available

12.6

 

ST

O

 

 

 

Prefix

 

12.8 thru 12.12

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

12.13

 

ID

C

 

 

 

Identifier Type Code

If PV1-12.1 is populated, this element is required

 

Value is limited to: “NPI” (National Provider Identifier)

 

See table 40

 


Table 11 – HL7 GT1 Guarantor Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

GT1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

R

 

 

00190

Set ID – GT1

 

2

 

 

 

 

 

 

Guarantor Number

Not used at this time for ADT Message(s)

 

3

250

XPN

R

Y

 

00191

Guarantor Name

 

3.1

 

FN

R

 

 

 

Family Name

Recommend use, if available

3.2

 

ST

C

 

 

 

Given Name

Recommend use, if available

3.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

3.4

 

ST

O

 

 

 

Suffix

Recommend use, if available

3.5

 

ST

O

 

 

 

Prefix

 

3.6

 

ST

O

 

 

 

Degree

 

3.7

 

ID

O

 

 

 

Name Type Code

 

4

 

 

 

 

 

 

Guranantor Spouse Name

Not used at this time for ADT Message(s)

 

5

250

XAD

O

Y

 

00409

Guarantor Address

Composite

5.1

 

ST

R

 

 

 

Street Address

 

5.2

 

ST

O

 

 

 

Other Designation

 

5.3

 

ST

R

 

 

 

City

 

5.4

 

ST

R

 

 

 

State or Province

 

5.5

 

ST

R

 

 

 

Zip or Postal Code

 

6

250

XTN

O

Y

 

00410

Guarantor Phone Number

Gurantor personal phone number(s)

 

Example

(999) 999-9999

7

250

XTN

O

Y

 

00411

Guarantor Business Phone Number

Guarantor business phone number(s)

 

Example

(999) 999-9999

8

26

TS

O

 

 

00412

Guarantor Date/Time of Birth

 

9

1

IS

O

 

0001

00413

Guarantor Sex

See table 20

 

10

 

 

N/A

 

 

 

Guarantor Type

Not used at this time for ADT Message(s)

 

11

250

CE

O

 

0063

00415

Guarantor Relationship

See table 31

 

12 through 15

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

16

250

XPN

O

Y

 

00420

Guarantor Employer Name

 

16.1

 

FN

R

 

 

 

Family Name

 

     16.2

 

ST

O

 

 

 

Given Name

Recommend use, if available

16.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

16.4

 

ST

O

 

 

 

Suffix

Recommend use, if available

16.5

 

ST

O

 

 

 

Prefix

 

16.6

 

ST

O

 

 

 

Degree

 

16.7

 

ID

O

 

 

 

Name Type Code

 

17

 

 

N/A

 

 

 

Guarantor Employer Address

 

18

250

XTN

O

Y

 

00422

Guarantor Employer Phone Number

Guarantor employer phone number(s)

 

Example

(999) 999-9999

19 through 50

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

51

250

XON

O

Y

 

0299

Guarantor Employer’s Organization Name

 

51.1

 

ST

R

 

 

 

Organization Name

 

     51.2

 

ID

N/A

 

 

 

Organization Name Type Code

Not used at this time for ADT Message(s)

51.3

 

ID

N/A

 

 

 

ID Number

Not used at this time for ADT Message(s)

51.4

 

NM

N/A

 

 

 

Check Digit

Not used at this time for ADT Message(s)

51.5

 

ID

N/A

 

 

 

Check Digit Scheme

Not used at this time for ADT Message(s)

51.6

 

HD

N/A

 

 

 

Assigning Authority

Not used at this time for ADT Message(s)

51.7

 

ID

N/A

 

 

 

Identifier Type Code

Not used at this time for ADT Message(s)

51.8

 

HD

N/A

 

 

 

Assigning Facility ID

Not used at this time for ADT Message(s)

52 through 55

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 


Table 12 – HL7 IN1 Insurance Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

IN1| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

SI

R

 

 

00426

Set ID – IN1

 

2

250

CE

R

 

0072

00368

Insurance Plan ID

See table 53

 

3

250

CX

R

Y

 

00428

Insurance Company ID

 

4

250

XON

C

Y

 

00429

Insurance Company Name

If IN1-3 is populated, then IN1-4 is required

4.1

 

ST

O

Y

 

 

Organization Name

 

5

250

XAD

O

Y

 

00430

Insurance Company Address

 

5.1

 

ST

R

 

 

 

Street Address

 

5.2

 

ST

O

 

 

 

Other Designation

 

5.3

 

ST

R

 

 

 

City

 

5.4

 

ST

R

 

 

 

State or Province

 

5.5

 

ST

R

 

 

 

Zip or Postal Code

 

6

250

XPN

O

Y

 

00431

Insurance Company Contact Number

 

6.1

 

FN

O

 

 

 

Family Name

Recommend use, if available

6.2

 

ST

O

 

 

 

Given Name

Recommend use, if available

6.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

6.4

 

ST

O

 

 

 

Suffix

 

6.5

 

ST

O

 

 

 

Prefix

 

6.6

 

ST

O

 

 

 

Degree

 

5.7

 

ID

O

 

 

 

Name Type Code

 

7

250

XTN

O

Y

 

00432

Guarantor Business Phone Number

Guarantor business phone number(s)

 

Example

(999) 999-9999

8

12

ST

O

 

 

00433

Group Number

 

9

250

XON

O

Y

 

00434

Group Name

 

10

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

11

130

XON

O

Y

 

00436

Insured’s Group Employer Name

 

12 thru 15

 

 

 

 

 

 

 

 

16

250

XPN

O

Y

 

00415

Name of Insured

 

16.1

 

FN

O

 

 

 

Family Name

Recommend use, if available

16.2

 

ST

O

 

 

 

Given Name

Recommend use, if available

16.3

 

ST

O

 

 

 

Second and further given names or initials thereof

Recommend use, if available

 

16.4

 

ST

O

 

 

 

Suffix

 

16.5

 

ST

O

 

 

 

Prefix

 

16.6

 

ST

O

 

 

 

Degree

 

16.7

 

ID

O

 

 

 

Name Type Code

 

17 thru 18

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

19

106

XAD

O

Y

 

00444

Insured’s Address

 

20

 

 

N/A

 

 

 

Assignments of Benefits

Not used at this time for ADT Message(s)

 

21

2

IS

O

 

0173

00446

Coordination of Benefits

 

22

2

ST

O

 

 

00447

Coordination of Benefits Priority

 

23 thru 27

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

28

15

ST

O

 

 

00453

Pre-Admit Cert (PAC

 

29 through 35

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

36

15

ST

O

 

 

00461

Policy Number

 

37 through 49

 

 

N/A

 

 

 

 

Not used at this time for ADT Message(s)

 

Table 13 – HL7 ACC Accident Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

ACC| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

26

TS

O

 

 

00527

Accident Date/Time

 

2

 

 

N/A

 

 

 

Accident Code

Not used at this time for HL7 ADT Message(s)

 

3

25

ST

O

 

 

00529

Accident Location

 

4 through 6

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

 


Table 14 – HL7 – MRG – Merge Patient Information Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

ACC| | | | | | | | | | | | | | | | | | |123456| | | | | | | | | | | | | | | | |01| | | | | | | |200602041820|200602060510| | | | | | | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

20

CX

R

Y

 

00211

Prior Patient ID – internal

 

2

20

CX

O

Y

 

00212

Prior Alternate patient ID

 

3

20

CX

O

 

 

00213

Prior Patient Account Number

 

4 thru 7

 

 

N/A

 

 

 

 

Not used at this time for HL7 ADT Message(s)

 

 


Table 14 – (User Defined) – ZAR – Access Restriction (Optional) Segment

For column table heading definitions, see Appendix A – Basic Definitions

 

Example:

ZAR|U|OTH|ORG| | |

 

Position (Sequence within the segment)- Ordinal position of the data field within the segment.  This number is used to refer to the data field in the text comments that follow the segment definition table.

In the segment attribute tables this information is provided in the column labeled SEQ.

 

 

SEQ

LEN

DT

OPT

RP#

TBL#

ITEM#

Element Name

Comments and Examples

1

4

 

SI

R

 

 

[0..1]

 

 

Set ID –

ZAR sequence number

2

705

 

CE

R

 

[1..1]

0206

 

Access Restriction Action Code

See table 43

3

 

705

CE

R

 

[1..1]

0717

 

Access Restriction Value

See table 44

4

705

CE

O

[0..*]

0719

 

Access Restriction Reason

See table 45

5

250

ST

O

[0..*]

 

 

Special Access Restriction Instructions

 

6

49

DR

O

[0..1]

 

 

Access Restriction Date Range

 

 


Table 15 – HL7 – MSH/ACK –Acknowledgement Header

(Please reference Clinical Acknowledgment and Error Status Standard

for those fields not addressed below)

 

For column table heading definitions, see Appendix A – Basic Definitions

 

Example MSH Segment-

MSH| ^~\&| |9999^HT000346-001^UHIN| |1111^HT000346-002^UHIN|20060126130405| |ACK^A02

         |20060126130405|P|2.3| | |ER

 

SEQ

LEN

DT

OPT

RP#

TBL#

 

ITEM#

Element

Comments

9

13

 

CM

 

R

[1..1]

 

00009

Message Type

Composite

9.1

 

ID

R

 

 

 

Message Type

Use “ACK

9.2

 

ID

R

 

 

 

Trigger Event

Use the same trigger event which was contained in the MSH-9.2 field (event type) in table 1.

 

12

8

CM

R

R

[1..1]