The Demo site for our new HL7 Version 2+ (plus) Standard
visit the hl7 website

Draft Website - For Review Purposes Only

Financial Management

Chapter Chair:

Kathleen Connor
Book Zurman Incorporated

Chapter Chair:

Paul Knapp
Knapp Consulting, Inc.

Chapter Chair

Mary Kay Mc Daniel
Markam Cognosante

Chapter Chair

Benoit Schoeffler
almerys

Sponsoring TC:

Financial Management

List Server

fm@lists.hl7.org


PURPOSE

The Finance chapter describes patient accounting transactions. Other financial transactions may be added in the future. Financial transactions can be sent between applications either in batches or online. As defined in Chapter 2 on batch segments, multiple transactions may be grouped and sent through all file transfer media or programs when using the HL7 Encoding Rules.

This chapter defines the transactions that take place at the seventh level, that is, the abstract messages. The examples included in this chapter were constructed using the HL7 Encoding Rules.

PATIENT ACCOUNTING MESSAGE SET

The patient accounting message set provides for the entry and manipulation of information on billing accounts, charges, payments, adjustments, insurance, and other related patient billing and accounts receivable information.

This Standard includes all of the data defined in the National Uniform Billing Field Specifications. We have excluded state-specific coding and suggest that, where required, it be implemented in site-specific "Z" segments. State-specific fields may be included in the Standard at a later time. In addition, no attempt has been made to define data that have traditionally been required for the financial responsibility ("proration") of charges. This requirement is unique to a billing system and not a part of an interface.

We recognize that a wide variety of billing and accounts receivable systems exist today. Therefore, in an effort to accommodate the needs of the most comprehensive systems, we have defined an extensive set of transaction segments.

TRIGGER EVENTS AND MESSAGE DEFINITIONS

The triggering events that follow are served by Detail Financial Transaction (DFT), Add/Change Billing Account (BAR), and General Acknowledgment (ACK) messages.

Each trigger event is documented below, along with the applicable form of the message exchange. The notation used to describe the sequence, optionality, and repetition of segments is described in Chapter 2, "Format for Defining Abstract Messages."

BAR/ACK - Add Patient Account (Event P01)

Data are sent from some application (usually a Registration or an ADT system, for example) to the patient accounting or financial system to establish an account for a patient's billing/accounts receivable record. Many of the segments associated with this event are optional. This optionality allows those systems needing these fields to set up transactions that fulfill their requirements and yet satisfy the HL7 requirements.

When an account's start and end dates span a period greater than any particular visit, the P01 (add account) event should be used to transmit the opening of an account. The A01 (admit/visit notification) event can notify systems of the creation of an account as well as notify them of a patient's arrival in the healthcare facility. In order to create a new account without notifying systems of a patient's arrival, use the P01 trigger event.

From Standard Version 2.3 onward, the P01 event should only be used to add a new account that did not exist before, not to update an existing account. The new P05 (update account) event should be used to update an existing account. The new P06 (end account) event should be used to close an account. With the P01 event, EVN-2 - Recorded Date/Time should contain the account start date.

BAR^P01^BAR_P01: Add Billing Account
HL7 MessageStructure Table - BAR_P01
Segment Cardinality Must Implement Status
BAR_P01
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PD1 0..1
PRT 0..*
ROL 0..* B
VISIT 1..* Yes
PV1 1..1 Yes
PV2 0..1
PRT 0..*
ROL 0..* B
DB1 0..*
OBX 0..*
PRT 0..*
AL1 0..*
DRG 0..1
GT1 0..*
NK1 0..*
ACC 0..1
UB1 0..1 B
UB2 0..1
DIAGNOSIS 0..*
DG1 1..1 Yes
PROCEDURE 0..*
PR1 1..1 Yes
PRT 0..*
ROL 0..* B
INSURANCE 0..*
IN1 1..1 Yes
IN2 0..1
IN3 0..*
PRT 0..*
ROL 0..* B

Original Mode Acknowledgement Choreography for BAR^P01^BAR_P01

Send Application Ack: ACK^P01^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P01^BAR_P01

When the MSH-15 value of a BAR^P01^BAR_P01 message is AL or ER or SU, an ACK^P01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P01^BAR_P01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P01^BAR_P01 message is AL or ER or SU, an ACK^P01^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P01^BAR_P01 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P01^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P01^ACK
NE (none)

ACK^P01^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P01^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P01^ACK

When the MSH-15 value of an ACK^P01^ACK message is AL or ER or SU, an ACK^P01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P01^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P01^ACK
NE (none)
MSH-16 NE (none)

The error segment will indicate the fields that caused a transaction to be rejected.

BAR/ACK - Purge Patient Accounts (Event P02)

Generally, the elimination of all billing/accounts receivable records will be an internal function controlled, for example, by the patient accounting or financial system. However, on occasion, there will be a need to correct an account, or a series of accounts, that may require that a notice of account deletion be sent from another sub-system and processed, for example, by the patient accounting or financial system. Although a series of accounts may be purged within this one event, we recommend that only one PID segment be sent per event.

BAR^P02^BAR_P02: Purge Billing Account
HL7 MessageStructure Table - BAR_P02
Segment Cardinality Must Implement Status
BAR_P02
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PATIENT 1..* Yes
PID 1..1 Yes
PD1 0..1
PRT 0..*
PV1 0..1
DB1 0..*

Original Mode Acknowledgement Choreography for BAR^P02^BAR_P02

Send Application Ack: ACK^P02^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P02^BAR_P02

When the MSH-15 value of a BAR^P02^BAR_P02 message is AL or ER or SU, an ACK^P02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P02^BAR_P02 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P02^BAR_P02 message is AL or ER or SU, an ACK^P02^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P02^BAR_P02 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P02^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P02^ACK
NE (none)

ACK^P02^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P02^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P02^ACK

When the MSH-15 value of an ACK^P02^ACK message is AL or ER or SU, an ACK^P02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P02^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P02^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

DFT/ACK - Post Detail Financial Transactions (Event P03)

The Detail Financial Transaction (DFT) message is used to describe a financial transaction transmitted between systems, that is, to the billing system for ancillary charges, ADT to billing system for patient deposits, etc.

Use case for Post Detail Financial Transaction with related Order:

This information can originate in many ways. For instance, a detailed financial transaction for an ancillary charge is sent to a billing system that also tracks the transaction(s) in relation to their order via placer order number or wishes to post these transactions with the additional order information. Therefore a service reaches a state where a detailed financial transaction is created and interfaced to other systems along with optional associated order information. If the message contains multiple transactions for the same order, such as a test service and venipuncture charge on the same order, the ordering information is entered in the Order segment construct that precedes the FT1 segments. If a message contains multiple transactions for disparate orders for the same account each FT1 segment construct may contain the order related information specific to that transaction within the message.

If the common order information is sent, the Order Control Code should reflect the current state of the common order and is not intended to initiate any order related triggers on the receiving application. For example if observations are included along with common order information the order control code would indicate 'RE' as observations to follow.

If common order information is sent related to the entire message or a specific financial transaction, the required Order Control Code should reflect the current state of the common order and is not intended to initiate any order related triggers on the receiving application. For example if observations are included along with common order information the order control code would indicate 'RE' as observations to follow.

If order detail information is sent related to the entire message or a specific financial transaction, the required fields for that detail segment must accompany that information.

DFT^P03^DFT_P03: Detail Financial Transaction
HL7 MessageStructure Table - DFT_P03
Segment Cardinality Must Implement Status
DFT_P03
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PD1 0..1
PRT 0..*
ROL 0..* B
VISIT 0..1
PV1 0..1
PV2 0..1
PRT 0..*
ROL 0..* B
DB1 0..*
COMMON_ORDER 0..*
ORC 1..1 Yes
PRT 0..*
TIMING_QUANTITY 0..*
TQ1 1..1 Yes
TQ2 0..*
ORDER 0..1
OBR 1..1 Yes
PRT 0..*
NTE 0..*
OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL 1..* Yes
FT1 1..1 Yes
PRT 0..*
ROL 0..* B
NTE 0..*
FINANCIAL_PROCEDURE 0..*
PR1 1..1 Yes
PRT 0..*
ROL 0..* B
FINANCIAL_OBSERVATION_STANDALONE 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_ORDER_STANDALONE 0..*
OBR 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_COMMON_ORDER 0..*
ORC 1..1 Yes
PRT 0..*
FINANCIAL_TIMING_QUANTITY 0..*
TQ1 1..1 Yes
TQ2 0..*
FINANCIAL_ORDER 0..1
OBR 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
DIAGNOSIS 0..*
DG1 1..1 Yes
DRG 0..1
GT1 0..*
INSURANCE 0..*
IN1 1..1 Yes
IN2 0..1
IN3 0..*
PRT 0..*
ROL 0..* B
ACC 0..1

Original Mode Acknowledgement Choreography for DFT^P03^DFT_P03

Send Application Ack: ACK^P03^ACK

Enhanced Mode Acknowledgement Choreography for DFT^P03^DFT_P03

When the MSH-15 value of a DFT^P03^DFT_P03 message is AL or ER or SU, an ACK^P03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a DFT^P03^DFT_P03 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a DFT^P03^DFT_P03 message is AL or ER or SU, an ACK^P03^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a DFT^P03^DFT_P03 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P03^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P03^ACK
NE (none)

Note: The ROL segment is optionally included after the PD1 to transmit information for patient level primary care providers, after the PV2 for additional information on the physicians whose information is sent there (i.e., Attending Doctor, Referring Doctor, Consulting Doctor), and within the insurance construct to transmit information for insurance level primary care providers.

Note: There is an information overlap between the FT1, DG1 and PR1 segments. If diagnosis information is sent in an FT1 segment, it should be consistent with the information contained in any DG1 segments present within its hierarchy. Since the procedure code field within the FT1 does not repeat, if procedure information is sent on an FT1 it is recommended that the single occurrence of the code in FT1 equates to the primary procedure (PR1-14 - Procedure Priority code value 1).

Note: The extra set of DG1/DRG/GT1/IN1/IN2/IN3/ROL segments added in V2.4 have been withdrawn as a technical correction

ACK^P03^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P03^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P03^ACK

When the MSH-15 value of an ACK^P03^ACK message is AL or ER or SU, an ACK^P03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P03^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P03^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

QRY/DSR - Generate Bills And Accounts Receivable Statements (Event P04)

Retained for backwards compatibility only in version 2.4 and later; refer to Chapter 5, "Queries", section 5.4.  The original mode query and the QRD/QRF segments have been replaced.

BAR/ACK - Update Account (Event P05)

The P05 event is sent when an existing account is being updated. From version 2.3 onward, the P01 (add account) event should no longer be used for updating an existing account, but only for creating a new account. With the addition of P10 (transmit ambulatory payment classification [APC] groups) in version 2.4, it is expected that the P05 (update account) will be used to send inpatient coding information and the P10 (transmit ambulatory payment classification [APC] groups) will be used to send outpatient coding information.

BAR^P05^BAR_P05: Update Billing Account
HL7 MessageStructure Table - BAR_P05
Segment Cardinality Must Implement Status
BAR_P05
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PD1 0..1
PRT 0..*
ROL 0..* B
VISIT 1..* Yes
PV1 1..1 Yes
PV2 0..1
PRT 0..*
ROL 0..* B
DB1 0..*
OBX 0..*
PRT 0..*
AL1 0..*
DRG 0..1
GT1 0..*
NK1 0..*
ACC 0..1
UB1 0..1 B
UB2 0..1
ABS 0..1
BLC 0..*
RMI 0..1
DIAGNOSIS 0..*
DG1 1..1 Yes
PROCEDURE 0..*
PR1 1..1 Yes
PRT 0..*
ROL 0..* B
INSURANCE 0..*
IN1 1..1 Yes
IN2 0..1
IN3 0..*
PRT 0..*
ROL 0..* B

Original Mode Acknowledgement Choreography for BAR^P05^BAR_P05

Send Application Ack: ACK^P05^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P05^BAR_P05

When the MSH-15 value of a BAR^P05^BAR_P05 message is AL or ER or SU, an ACK^P05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P05^BAR_P05 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P05^BAR_P05 message is AL or ER or SU, an ACK^P05^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P05^BAR_P05 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P05^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P05^ACK
NE (none)

ACK^P05^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P05^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P05^ACK

When the MSH-15 value of an ACK^P05^ACK message is AL or ER or SU, an ACK^P05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P05^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P05^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

BAR/ACK - End Account (event P06)

The P06 event is a notification that the account is no longer open, that is, no new charges can accrue to this account. This notification is not related to whether or not the account is paid in full. EVN-2 - Recorded Date/Time must contain the account end date.

BAR^P06^BAR_P06: End Billing Account
HL7 MessageStructure Table - BAR_P06
Segment Cardinality Must Implement Status
BAR_P06
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PATIENT 1..* Yes
PID 1..1 Yes
PRT 0..*
PV1 0..1

Original Mode Acknowledgement Choreography for BAR^P06^BAR_P06

Send Application Ack: ACK^P06^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P06^BAR_P06

When the MSH-15 value of a BAR^P06^BAR_P06 message is AL or ER or SU, an ACK^P06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P06^BAR_P06 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P06^BAR_P06 message is AL or ER or SU, an ACK^P06^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P06^BAR_P06 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P06^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P06^ACK
NE (none)

ACK^P06^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P06^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P06^ACK

When the MSH-15 value of an ACK^P06^ACK message is AL or ER or SU, an ACK^P06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P06^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P06^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

Note: P07-P09 have been defined by the Orders/Observations Technical Committee as product experience messages. Refer to Chapter 7.

BAR/ACK - Transmit Ambulatory Payment Classification (APC) Groups (Event P10)

The P10 event is used to communicate Ambulatory Payment Classification (APC) grouping. The grouping can be estimated or actual, based on the APC status indictor in GP1-1. This information is mandated in the USA by the Centers for Medicare and Medicaid Services (CMS) for reimbursement of outpatient services. The PID and PV1 segments are included for identification purposes only. When other patient or visit related fields change, use the A08 (update patient information) event.

BAR^P10^BAR_P10: Transmit Ambulatory Payment Classification (APC) groups
HL7 MessageStructure Table - BAR_P10
Segment Cardinality Must Implement Status
BAR_P10
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PRT 0..*
PV1 1..1 Yes
DIAGNOSIS 0..*
DG1 1..1 Yes
GP1 1..1 Yes
PROCEDURE 0..*
PR1 1..1 Yes
GP2 0..1

Original Mode Acknowledgement Choreography for BAR^P10^BAR_P10

Send Application Ack: ACK^P10^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P10^BAR_P10

When the MSH-15 value of a BAR^P10^BAR_P10 message is AL or ER or SU, an ACK^P10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P10^BAR_P10 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P10^BAR_P10 message is AL or ER or SU, an ACK^P10^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P10^BAR_P10 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P10^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P10^ACK
NE (none)

ACK^P10^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P10^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P10^ACK

When the MSH-15 value of an ACK^P10^ACK message is AL or ER or SU, an ACK^P10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P10^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P10^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

DFT/ACK - Post Detail Financial Transactions - Expanded (Event P11)

The Detail Financial Transaction (DFT) - Expanded message is used to describe a financial transaction transmitted between systems, that is, to the billing system for ancillary charges, ADT to billing system for patient deposits, etc. It serves the same function as the Post Detail Financial Transactions (event P03) message, but also supports the use cases described below.

Use case for adding the INx and GT1 segments inside the FT1 repetition:

If the insurance and/or the guarantor information is specific to a certain financial transaction of a patient and differs from the patient's regular insurance and/or guarantor, you may use the INx and GT1 segments related to the FT1 segment. If being used, the information supersedes the information on the patient level.

Example: Before being employed by a company, a pre-employment physical is required. The cost of the examinations is paid by the company, and not by the person's private health insurance. One of the physicians examining the person is an eye doctor. For efficiency reasons, the person made an appointment for these examinations on the same day as he already had an appointment with his eye doctor in the same hospital. The costs for this eye doctor appointment are being paid by the patient's private health insurance. Both financial transactions for the same patient/person could be sent in the same message. To bill the examination for the future-employer to that organization, you need to use the GT1 segment that is related to the FT1.

DFT^P11^DFT_P11: Detail Financial Transaction - Expanded
HL7 MessageStructure Table - DFT_P11
Segment Cardinality Must Implement Status
DFT_P11
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PRT 0..*
PD1 0..1
PRT 0..*
ROL 0..* B
VISIT 0..1
PV1 0..1
PV2 0..1
PRT 0..*
ROL 0..* B
DB1 0..*
COMMON_ORDER 0..*
ORC 1..1 Yes
PRT 0..*
TIMING_QUANTITY 0..*
TQ1 1..1 Yes
TQ2 0..*
ORDER 0..1
OBR 1..1 Yes
PRT 0..*
NTE 0..*
OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
DIAGNOSIS 0..*
DG1 1..1 Yes
DRG 0..1
GT1 0..*
INSURANCE 0..*
IN1 1..1 Yes
IN2 0..1
IN3 0..*
PRT 0..*
ROL 0..* B
ACC 0..1
FINANCIAL 1..* Yes
FT1 1..1 Yes
NTE 0..*
PRT 0..*
DRG 0..1
GT1 0..*
FINANCIAL_PROCEDURE 0..*
PR1 1..1 Yes
PRT 0..*
ROL 0..* B
FINANCIAL_OBSERVATION_STANDALONE 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_ORDER_STANDALONE 0..*
OBR 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_COMMON_ORDER 0..*
ORC 1..1 Yes
PRT 0..*
FINANCIAL_TIMING_QUANTITY 0..*
TQ1 1..1 Yes
TQ2 0..*
FINANCIAL_ORDER 0..1
OBR 1..1 Yes
PRT 0..*
NTE 0..*
FINANCIAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
DIAGNOSIS_FT1 0..*
DG1 1..1 Yes
FINANCIAL_INSURANCE 0..*
IN1 1..1 Yes
IN2 0..1
IN3 0..*
PRT 0..*
ROL 0..* B

Original Mode Acknowledgement Choreography for DFT^P11^DFT_P11

Send Application Ack: ACK^P11^ACK

Enhanced Mode Acknowledgement Choreography for DFT^P11^DFT_P11

When the MSH-15 value of a DFT^P11^DFT_P11 message is AL or ER or SU, an ACK^P11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a DFT^P11^DFT_P11 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a DFT^P11^DFT_P11 message is AL or ER or SU, an ACK^P11^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a DFT^P11^DFT_P11 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P11^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P11^ACK
NE (none)

Note: The ROL segment is optionally included after the PD1 to transmit information for patient level primary care providers, after the PV2 for additional information on the physicians whose information is sent there (i.e., Attending Doctor, Referring Doctor, Consulting Doctor), and within the insurance construct to transmit information for insurance level primary care providers.

Note: There is an information overlap between the FT1, DG1 and PR1 segments. If diagnosis information is sent in an FT1 segment, it should be consistent with the information contained in any DG1 segments present within its hierarchy. Since the procedure code field within the FT1 does not repeat, if procedure information is sent on an FT1 it is recommended that the single occurrence of the code in FT1 equates to the primary procedure (PR1-14 - Procedure Priority code value 1).

ACK^P11^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P11^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P11^ACK

When the MSH-15 value of an ACK^P11^ACK message is AL or ER or SU, an ACK^P11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P11^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P11^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

BAR/ACK - Update Diagnosis/Procedure (Event P12)

The P12 event is used to communicate diagnosis and/or procedures in update mode. The newly created fields in DG1 and PR1, i.e., identifiers and action codes, must be populated to indicate which change should be applied. When other patient or visit related fields change, use the A08 (update patient information) event.

BAR^P12^BAR_P12: Update Diagnosis/Procedures
HL7 MessageStructure Table - BAR_P12
Segment Cardinality Must Implement Status
BAR_P12
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
PID 1..1 Yes
PRT 0..*
PV1 1..1 Yes
DIAGNOSIS 0..*
DG1 1..1 Yes
DRG 0..1
PROCEDURE 0..*
PR1 1..1 Yes
PRT 0..*
ROL 0..* B
OBX 0..1
PRT 0..*

Original Mode Acknowledgement Choreography for BAR^P12^BAR_P12

Send Application Ack: ACK^P12^ACK

Enhanced Mode Acknowledgement Choreography for BAR^P12^BAR_P12

When the MSH-15 value of a BAR^P12^BAR_P12 message is AL or ER or SU, an ACK^P12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a BAR^P12^BAR_P12 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a BAR^P12^BAR_P12 message is AL or ER or SU, an ACK^P12^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a BAR^P12^BAR_P12 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P12^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^P12^ACK
NE (none)

ACK^P12^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^P12^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^P12^ACK

When the MSH-15 value of an ACK^P12^ACK message is AL or ER or SU, an ACK^P12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^P12^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^P12^ACK
NE (none)
MSH-16 NE (none)

The error segment indicates the fields that caused a transaction to be rejected.

MESSAGE SEGMENTS

FT1 - Financial Transaction Segment

The FT1 segment contains the detail data necessary to post charges, payments, adjustments, etc., to patient accounting records.

HL7 Attribute Table - FT1 - Financial Transaction Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
FT1
1 00355 Set ID - FT1 [0..1] [1..4] SI
2 00356 Transaction ID [0..1] [1..12] CX
3 00357 Transaction Batch ID [0..1] [1..10] ST
4 00358 Transaction Date SHALL [1..1] DR
5 00359 Transaction Posting Date [0..1] DTM
6 00360 Transaction Type SHALL [1..1] CWE
7 00361 Transaction Code SHALL [1..1] CWE
8 00362 Transaction Description SHALL NOT W [0..0]
9 00363 Transaction Description - Alt SHALL NOT W [0..0]
10 00364 Transaction Quantity = [0..1] 6 NM
11 00365 Transaction Amount - Extended [0..1] CP
12 00366 Transaction Amount - Unit [0..1] CP
13 00367 Department Code [0..1] CWE
14 00368 Health Plan ID [0..1] CWE
15 00369 Insurance Amount [0..1] CP
16 00133 Assigned Patient Location [0..1] PL
17 00370 Fee Schedule [0..1] CWE
18 00148 Patient Type [0..1] CWE
19 00371 Diagnosis Code - FT1 [0..*] CWE
20 00372 Performed By Code [0..*] XCN
21 00373 Ordered By Code [0..*] XCN
22 00374 Unit Cost [0..1] CP
23 00217 Filler Order Number [0..1] EI
24 00765 Entered By Code [0..*] XCN
25 00393 Procedure Code [0..1] CNE
26 01316 Procedure Code Modifier [0..*] CNE
27 01310 Advanced Beneficiary Notice Code [0..1] CWE
28 01646 Medically Necessary Duplicate Procedure Reason [0..1] CWE
29 01845 NDC Code [0..1] CWE
30 01846 Payment Reference ID [0..1] CX
31 01847 Transaction Reference Key [0..*] [1..4] SI
32 02361 Performing Facility [0..*] XON
33 02362 Ordering Facility [0..1] XON
34 02363 Item Number [0..1] CWE
35 02364 Model Number = [0..1] 20 ST
36 02365 Special Processing Code [0..*] CWE
37 02366 Clinic Code [0..1] CWE
38 02367 Referral Number [0..1] CX
39 02368 Authorization Number [0..1] CX
40 02369 Service Provider Taxonomy Code [0..1] CWE
41 01600 Revenue Code [0..1] CWE
42 00325 Prescription Number = [0..1] 20 ST
43 02370 NDC Qty and UOM [0..1] CQ
44 03496 DME Certificate of Medical Necessity Transmission Code [0..1] CWE
45 03497 DME Certification Type Code [0..1] CWE
46 03498 DME Duration Value [0..1] NM
47 03499 DME Certification Revision Date [0..1] DT
48 03500 DME Initial Certification Date [0..1] DT
49 03501 DME Last Certification Date [0..1] DT
50 03502 DME Length of Medical Necessity Days [0..1] NM
51 03503 DME Rental Price [0..1] MO
52 03504 DME Purchase Price [0..1] MO
53 03505 DME Frequency Code [0..1] CWE
54 03506 DME Certification Condition Indicator [0..1] ID
55 03507 DME Condition Indicator Code [0..2] CWE
56 03508 Service Reason Code [0..1] CWE

FT1-1: Set ID - FT1 (SI) 00355

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment the sequence number shall be 1, for the second occurrence it shall be 2, etc.

FT1-2: Transaction ID (CX) 00356

Definition: This field contains a number assigned by the sending system for control purposes. The number can be returned by the receiving system to identify errors.

FT1-3: Transaction Batch ID (ST) 00357

Definition: This field uniquely identifies the batch in which this transaction belongs.

FT1-4: Transaction Date (DR) 00358

Definition: This field contains the date/time or date/time range of the transaction. For example, this field would be used to identify the date a procedure, item, or test was conducted or used. It may be defaulted to today's date. To specify a single point in time, only the first component is valued. When the second component is valued, the field specifies a time interval during which the transaction took place.

FT1-5: Transaction Posting Date (DTM) 00359

Definition: This field contains the date of the transaction that was sent to the financial system for posting.

FT1-6: Transaction Type (CWE) 00360

Definition: This field contains the code that identifies the type of transaction. Refer to User-defined Table 0017 - Transaction Type in Chapter 2C, Code Tables, for suggested values.

FT1-7: Transaction Code (CWE) 00361

(Definition from FT1.7 in Ch. 6)

Definition: This field contains the code assigned by the institution for the purpose of uniquely identifying the transaction based on the Transaction Type (FT1-6). For example, this field would be used to uniquely identify a procedure, supply item, or test for charges, or to identify the payment medium for payments. Refer to User-defined Table 0132 - Transaction Code in Chapter 2C, Code Tables, for suggested values. See Chapter 7 for a discussion of the universal service ID for charges.

(Definition from ITM.12 in Ch. 17)

Definition: This field contains the code assigned by the institution for the purpose of uniquely identifying a patient billing code specific for a supply item. In the context of this message, this is a code that is a cross-reference to the Item Code/Id. This field would be used to uniquely identify a procedure, supply item, or test for charges; or to identify the payment medium for payments. It can reference, for example, a CBC (a lab charge), or an Elastic Bandage 3'' (supply charge), or Chest 1 View (radiology charge). For instance the code would be 300-0001, with a description of CBC.

Refer to User-defined Table 0132 - Transaction Code in Chapter 2C, Code Tables, for suggested values. See Chapter 7 for a discussion of the universal service ID for charges.

(Definition from PCE.3 in Ch. 17)

Definition: This field contains a code that is used by a billing system to charge for the inventory supply item, the descriptive name of the patient charge for that system (as it may appear on a patient's bill or charge labels) and the name of the coding system that assigned the charge code. Refer to User-defined Table 0132 – Transaction Codes in Chapter 6, Financial Management, for suggested values.

(Definition from IVT.12 in Ch. 17)

Definition: This field contains a code that is used by a billing system to charge for the inventory supply item, the descriptive name of the patient charge for that system (as it may appear on a patient's bill or charge labels) and the name of the coding system that assigned the charge code. Refer to User-defined Table 0132 – Transaction Codes in Chapter 2C, Code Tables, for suggested values.

FT1-8: Transaction Description

Attention: FT1-8 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

FT1-9: Transaction Description - Alt

Attention: FT1-9 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

FT1-10: Transaction Quantity (NM) 00364

Definition: This field contains the quantity of items associated with this transaction.

FT1-11: Transaction Amount - Extended (CP) 00365

Definition: This field contains the amount of a transaction. It may be left blank if the transaction is automatically priced. Total price for multiple items.

FT1-12: Transaction Amount - Unit (CP) 00366

(Definition from FT1.12 in Ch. 6)

Definition: This field contains the unit price of a transaction. Price of a single item.

(Definition from ITM.13 in Ch. 17)

Definition: Unit price of transaction. Price of a single item. This field contains the dollar amount charged to patients for this item.

(Definition from PCE.4 in Ch. 17)

Definition: The price that a department charges to a patient for this inventory supply item when using the Patient Charge Billing code present in this segment.

(Definition from IVT.13 in Ch. 17)

Definition: This field contains the dollar amount charged to patients for this single inventory supply item.

FT1-13: Department Code (CWE) 00367

Definition: This field contains the department code that controls the transaction code described above. Refer to User-defined Table 0049 - Department Code in Chapter 2C, Code Tables, for suggested values.

FT1-14: Health Plan ID (CWE) 00368

(Definition from FT1.14 in Ch. 6)

Definition: This field contains the identifier of the primary insurance plan with which this transaction should be associated. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values.

(Definition from IN1.2 in Ch. 6)

Definition: This field contains a unique identifier for the insurance plan. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values. To eliminate a plan, the plan could be sent with Delete Indication values in each subsequent element. If the respective systems can support it, a Delete Indication value can be sent in the plan field.

The assigning authority for IN1-2, Health Plan ID is assumed to be the Entity named in IN1-3, Insurance Company ID.

(Definition from PM1.1 in Ch. 8)

Definition: This field contains a unique identifier for the insurance plan. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values. To eliminate a plan, the plan could be sent with null values in each subsequent element. If the respective systems can support it, a null value can be sent in the plan field.

The assigning authority for PM1-1, Health Plan ID is assumed to be the Entity named in PM1-2, Insurance Company ID.

FT1-15: Insurance Amount (CP) 00369

Definition: This field contains the amount to be posted to the insurance plan referenced above.

FT1-16: Assigned Patient Location (PL) 00133

(Definition from PV1.3 in Ch. 3)

Definition: This field contains the patient's initial assigned location or the location to which the patient is being moved. The first component may be the nursing station for inpatient locations, or clinic or department, for locations other than inpatient. For canceling a transaction or discharging a patient, the current location (after the cancellation event or before the discharge event) should be in this field. If a value exists in the fifth component (location status), it supersedes the value in PV1-40 - Bed Status.

(Definition from FT1.16 in Ch. 6)

Definition: This field contains the current patient location. This can be the location of the patient when the charge item was ordered or when the charged service was rendered. For the current assigned patient location, use PV1-3 - Assigned Patient Location.

FT1-17: Fee Schedule (CWE) 00370

Definition: This field contains the code used to select the appropriate fee schedule to be used for this transaction posting. Refer to User-defined Table 0024 - Fee Schedule in chapter 2C, Code Tables, for suggested values.

FT1-18: Patient Type (CWE) 00148

(Definition from PV1.18 in Ch. 3)

Definition: This field contains site-specific values that identify the patient type. Refer to User-defined Table 0018 - Patient Type in Chapter 2C, Code Tables, for suggested values.

(Definition from FT1.18 in Ch. 6)

Definition: This field contains the type code assigned to the patient for this episode of care (visit or stay). Refer to User-defined Table 0018 - Patient Type in Chapter 2C, Code Tables, for suggested values. This is for use when the patient type for billing purposes is different than the visit patient type in PV1-18 - Patient Type.

FT1-19: Diagnosis Code - FT1 (CWE) 00371

Definition: This field contains the primary diagnosis code for billing purposes. ICD9-CM is assumed for all diagnosis codes. This is the most current diagnosis code that has been assigned to the patient. ICD10 can also be used. The name of coding system (third component) indicates which coding system is used. Refer to User-defined Table 0051 - Diagnosis Code in Chapter 2C, Code Tables, for suggested values.

FT1-20: Performed By Code (XCN) 00372

Definition: This field contains the composite number/name of the person/group that performed the test/procedure/transaction, etc. This is the service provider. Refer to User-defined Table 0084 - Performed by in Chapter 2C, Code Tables, for suggested values. As of v 2.7, if XCN.1 - ID Number is populated, then the XCN.13 - Identifier Type Code and the XCN.9 - Assigning Authority or XCN.22 - Assigning Jurisdiction or XCN.23 - Assigning Agency or Department are required. If XCN.2 - Family Name is populated, then the XCN.10 - Name Type Code is required. No assumptions can be safely made based on position or sequence. Specification of meaning based on sequence is deprecated.

FT1-21: Ordered By Code (XCN) 00373

Definition: This field contains the composite number/name of the person/group that ordered the test/ procedure/transaction, etc. As of v 2.7, if XCN.1 - ID Number is populated, then the XCN.13 - Identifier Type Code and the XCN.9 - Assigning Authority or XCN.22 - Assigning Jurisdiction or XCN.23 - Assigning Agency or Department are required. If XCN.2 - Family Name is populated, then the XCN.10 - Name Type Code is required. No assumptions can be safely made based on position or sequence. Specification of meaning based on sequence is deprecated. .

FT1-22: Unit Cost (CP) 00374

Definition: This field contains the unit cost of transaction. The cost of a single item.

FT1-23: Filler Order Number (EI) 00217

(Definition from ORC.3 in Ch. 4)

Definition: This field is the order number associated with the filling application. It is a case of the Entity Identifier data type (Section 2.A.28). Its first component is a string that identifies an order detail segment (i.e., ORC segment and associated order detail segment). It is assigned by the order filler (receiving) application. This string must uniquely identify the order (as specified in the order detail segment) from other orders in a particular filling application (e.g., clinical laboratory). This uniqueness must persist over time.

The second through fourth components contain the filler application ID, in the form of the HD data type (see Section 2.A.36, "HD – hierarchic designator"). The second component is a user-defined coded value that uniquely defines the application from other applications on the network. A limit of six (6) characters is suggested but not required. The second component of the filler order number always identifies the actual filler of an order.

A given institution or group of intercommunicating institutions should establish a list of applications that may be potential placers and fillers of orders and assign each a unique application ID. The application ID list becomes one of the institution's master dictionary lists that is documented in Chapter 8. Since third- party applications (those other than the placer and filler of an order) can send and receive ORM and ORR messages, the filler application ID in this field may not be the same as any sending and receiving application on the network (as identified in the MSH segment).

The conditions which make this field required are divided into two main issues. The data in ORC-2 and OBR-2 are logically the same thing: a placer id. The data in ORC-3 and OBR-3 are logically the same thing: the filler id.

From that perspective each message must have either a placer or a filler id with an exception for the case of a "Send Number" control code since its purpose is to request a placer id.

If both ORC and OBR are present in a message, then only one of the Segments must contain the value(s). Note that if both ORC-2 and OBR-2 are valued, then they must be valued the same; as well, if both ORC-3 and OBR-3 are valued, then they must be valued the same. The sending system can include both the filler and the placer number in both the ORC and OBR segments as long as the data is the same between the two segments. It is recommended that the initiating system should provide a unique number for the placer order number when a new order is placed or a unique number for the filler order number when an unsolicited result is initially communicated.

The filler order number (OBR-3 or ORC-3) also uniquely identifies an order and its associated observations. For example, suppose that an institution collects observations from several ancillary applications into a common database and this common database is queried by yet another application for observations. In this case, the filler order number and placer order number transmitted by the common database application would be that of the original filler and placer, respectively, rather than a new one assigned by the common database application.

Similarly, if a third-party application, not the filler or placer, of an order were authorized to modify the status of an order (say, cancel it), the third-party application would send the filler an ORM message containing an ORC segment with ORC-1-order control equal to "CA" and containing the original placer order number and filler order number, rather than assign either itself.

(Definition from OBR.3 in Ch. 4)

Definition: This field is the order number associated with the filling application. This is a permanent identifier for an order and its associated observations. It is a special case of the Entity Identifier data type (see Chapter 2, section 2.A.28, "EI – entity identifier").

The first component is a string that identifies an individual order segment (i.e., ORC segment and associated order detail segment). It is assigned by the order filling (receiving) application. It identifies an order uniquely among all orders from a particular filling application (e.g., clinical laboratory). This uniqueness must persist over time.

The second through fourth components contain the filler application ID, in the form of the HD data type (see section 2.A.36, "HD – hierarchic designator"). The second component is a user-defined coded value that uniquely defines the application from other applications on the network. A limit of six (6) characters is suggested but not required. The second component of the filler order number always identifies the actual filler of an order.

See ORC-3-filler order number for information on when this field must be valued.

The conditions which make this field required are divided into two main issues. The data in ORC-2 and OBR-2 are logically the same thing: a placer id. The data in ORC-3 and OBR-3 are logically the same thing: the filler id.

From that perspective, each message must have either a placer or a filler id with an exception for the case of a "Send Number" control code since its purpose is to request a placer id.

If both ORC and OBR are present in a message, then only one of the Segments must contain the value(s). If both segments contain either ORC-2/OBR-2 or ORC-3/OBR-3, then each pair must be a matching pair. The sending system can include both the filler and the placer number in both the ORC and OBR segments as long as the data is the same between the two segments.

It is recommended that the initiating system should provide a unique number when a new order or unsolicited result is initially communicated.

The filler order number (OBR-3 or ORC-3) also uniquely identifies an order and its associated observations. For example, suppose that an institution collects observations from several ancillary applications into a common database and this common database is queried by yet another application for observations. In this case, the filler order number and placer order number transmitted by the common database application would be that of the original filler and placer, respectively, rather than a new one assigned by the common database application.

Similarly, if a third-party application, not the filler or placer, of an order were authorized to modify the status of an order (say, cancel it), the third-party application would send the filler an ORM message containing an ORC segment with ORC-1-order control equal to "CA" and containing the original placer order number and filler order number, rather than assign either itself.

(Definition from FT1.23 in Ch. 6)

Definition: This field is used when the billing system is requesting observational reporting justification for a charge. This is the number used by a filler to uniquely identify a result. See Chapter 4 for a complete description.

(Definition from OBR.3 in Ch. 7)

Definition: This field is the order number associated with the filling application. This is a permanent identifier for an order and its associated observations. It is a special case of the Entity Identifier data type (see Chapter 2, section 2.A.28, "EI – entity identifier").

The first component is a string that identifies an individual order segment (i.e., ORC segment and associated order detail segment). It is assigned by the order filling (receiving) application. It identifies an order uniquely among all orders from a particular filling application (e.g., clinical laboratory). This uniqueness must persist over time.

The second through fourth components contain the filler application ID, in the form of the HD data type (see section 2.A.36, "HD – hierarchic designator"). The second component is a user-defined coded value that uniquely defines the application from other applications on the network. A limit of six (6) characters is suggested but not required. The second component of the filler order number always identifies the actual filler of an order.

See ORC-3-filler order number for information on when this field must be valued.

The conditions which make this field required are divided into two main issues. The data in ORC-2 and OBR-2 are logically the same thing: a placer id. The data in ORC-3 and OBR-3 are logically the same thing: the filler id.

From that perspective, each message must have either a placer or a filler id with an exception for the case of a "Send Number" control code since its purpose is to request a placer id.

If both ORC and OBR are present in a message, then only one of the Segments must contain the value(s). If both segments contain either ORC-2/OBR-2 or ORC-3/OBR-3, then each pair must be a matching pair. The sending system can include both the filler and the placer number in both the ORC and OBR segments as long as the data is the same between the two segments.

It is recommended that the initiating system should provide a unique number when a new order or unsolicited result is initially communicated.

The filler order number (OBR-3 or ORC-3) also uniquely identifies an order and its associated observations. For example, suppose that an institution collects observations from several ancillary applications into a common database and this common database is queried by yet another application for observations. In this case, the filler order number and placer order number transmitted by the common database application would be that of the original filler and placer, respectively, rather than a new one assigned by the common database application.

Similarly, if a third-party application, not the filler or placer, of an order were authorized to modify the status of an order (say, cancel it), the third-party application would send the filler an ORM message containing an ORC segment with ORC-1-order control equal to "CA" and containing the original placer order number and filler order number, rather than assign either itself.

(Definition from TXA.15 in Ch. 9)

Definition: This field is the order number associated with the filling application. Where a transcription service or similar organization creates the document and uses an internally unique identifier, that number should be inserted in this field. Its first component is a string of characters that identifies an order detail segment (i.e., OBR). This string must uniquely identify the order (as specified in the order detail segment) from other orders in a particular filling application (i.e., transcription service). This uniqueness must persist over time. Where a number is reused over time, a date can be affixed to the non-unique number to make it unique.

The second through fourth components contains the (filler) assigning authority. The (filler) assigning authority is a string of characters that uniquely defines the application from other applications on the network. The second through fourth components of the filler order number always identify the actual filler of an order.

TXA-15 - Condition: If corresponding ORC and/or OBR segments are present in the message and ORC-3 or OBR-3 is valued, this field must be blank. If TXA-14 is valued while ORC-3 or OBR-3 is valued it shall be ignored. See message definitions including TXA for further guidanceon which ORC/OBR pairs to consider.

For further details, please see the definitions provided in Chapter 4, "Orders".

(Definition from ARQ.25 in Ch. 10)

Definition: This field is the order number assigned by the filler application for the order associated with this scheduling request.

This field is described in detail in Chapter 4, section 4.5.1.3, "ORC-3 – Filler Order Number.” It is conditionally mandatory depending on the presence of the Placer order number (ARQ-24 – Placer Order Number). This conditionally mandatory requirement addresses the concern that a Scheduling system cannot and should not create or fill an order. Therefore, an order must have been accepted by the filler application before scheduling the resources associated with that order.

(Definition from SCH.27 in Ch. 10)

Definition: This field is the order number assigned by the filler application for the order associated with this scheduling filler response.

This field is described in detail in Chapter 4, Orders, section 4.5.1.3. It is conditionally mandatory depending on the presence of the placer order number (section 10.6.2.26). This conditionally mandatory requirement addresses the concern that a Scheduling system cannot and should not create or fill an order. Therefore, an order must have been accepted by the order filler application before scheduling the resources associated with that order.

FT1-24: Entered By Code (XCN) 00765

Definition: This field identifies the composite number/name of the person who entered the insurance information.

FT1-25: Procedure Code (CNE) 00393

(Definition from OBR.44 in Ch. 4)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined table 0088 – Procedure code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from FT1.25 in Ch. 6)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of v 2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Coding Systems (from HL7 Table 0396)

Code

Description

Comment / Source

C4

CPT-4

American Medical Association, P.O. Box 10946, Chicago IL 60610.

C5

CPT-5

(under development – same contact as above)

HCPCS

CMS (formerly HCFA) Common Procedure Coding System

HCPCS: contains codes for medical equipment, injectable drugs, transportation services, and other services not found in CPT4.

HPC

CMS (formerly HCFA )Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.

I10P

ICD-10 Procedure Codes

Procedure Coding System (ICD-10-PCS.) See http://www/hcfa.gov/stats/icd10.icd10.htm for more information.


(Definition from PR1.3 in Ch. 6)

Definition: This field contains a unique identifier assigned to the procedure. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems.

(Definition from OBR.44 in Ch. 7)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined table 0088 – Procedure code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from CDM.7 in Ch. 8)

Definition: This field contains the procedure code for procedure, if any, associated with this charge description. Repeating field allows for different procedure coding systems such as CPT4, ICD9. Coded entry made up of code plus coding schema. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values.

(Definition from IIM.14 in Ch. 17)

Definition: This field contains a unique identifier assigned to the service item, if any, associated with the charge. In the United States this is often the HCPCS code. Refer to Externally Defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Coding Systems

Coding System

Description

Comment

C4

CPT-4

American Medical Association, P.O. Box 10946, Chicago IL 60610.

C5

CPT-5

(under development – same contact as above)

HCPCS

CMS (formerly HCFA) Common Procedure Coding System

HCPCS: contains codes for medical equipment, injectable drugs, transportation services, and other services not found in CPT4.

HPC

CMS (formerly HCFA) Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.


(Definition from ITM.27 in Ch. 17)

Definition: This field contains a unique identifier assigned to the service item, if any, associated with the charge. In the United States this is often the HCPCS code. Refer to Externally defined Table 0088 - Procedure code for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems. Refer to HL7 Table 0088 – Procedure Coding Systems in Chapter 2C, Code Tables, for valid values.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

(Definition from SCD.32 in Ch. 17)

Definition: The unique identifier indicating the type of procedure performed on the patient with the supplies being sterilized.

Refer to HL7 Table 0088 – Procedure Code in Chapter 2C, Code Tables, for suggested values.

As of v2.6, the known applicable external coding systems include those in the referenced table. If the code set you are using is in this table, then you must use that designation.

FT1-26: Procedure Code Modifier (CNE) 01316

(Definition from OBR.45 in Ch. 4)

Definition: This field contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. In the USA, this is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally- defined table 0340 – Procedure code modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if OBR-44 – procedure code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from FT1.26 in Ch. 6)

Definition: This field contains the procedure code modifier to the procedure code reported in FT1-25 - Procedure Code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. This is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if FT1-25 - Procedure Code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of v 2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Modifier Coding Systems (From HL7 Table 0396)

Code

Description

Comment / Source

CPTM

CPT Modifier Code

Available for the AMA at the address listed for CPT above. These codes are found in Appendix A of CPT 2000 Standard Edition. (CPT 2000 Standard Edition, American Medical Association, Chicago, IL).

HPC

CMS (formerly HCFA )Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.

I10P

ICD-10 Procedure Codes

Procedure Coding System (ICD-10-PCS.) See http://www/hcfa.gov/stats/icd10.icd10.htm for more information.

I9C

ICD-9CM

Commission on Professional and Hospital Activities, 1968 Green Road, Ann Arbor, MI 48105 (includes all procedures and diagnostic tests).

ICD10AM

ICD-10 Australian modification

ICD10CA

ICD-10 Canada


(Definition from PR1.16 in Ch. 6)

Definition: This field contains the procedure code modifier to the procedure code reported in field 3, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

(Definition from OBR.45 in Ch. 7)

Definition: This field contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. In the USA, this is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally- defined table 0340 – Procedure code modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if OBR-44 – procedure code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from IIM.15 in Ch. 17)

Definition: This field contains the procedure code modifier to the procedure code reported in IIM-14 Procedure Code, when applicable. Procedure code modifiers are defined by USA regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

(Definition from ITM.28 in Ch. 17)

Definition: This field contains the procedure code modifier to the procedure code reported in ITM-27, Procedure Code, when applicable. Procedure code modifiers are defined by USA regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

FT1-27: Advanced Beneficiary Notice Code (CWE) 01310

(Definition from ORC.20 in Ch. 4)

Definition: This field indicates the status of the patient's or the patient's representative's consent for responsibility to pay for potentially uninsured services. This element is introduced to satisfy CMS Medical Necessity requirements for outpatient services. This element indicates (a) whether the associated diagnosis codes for the service are subject to medical necessity procedures, (b) whether, for this type of service, the patient has been informed that they may be responsible for payment for the service, and (c) whether the patient agrees to be billed for this service. The values for this field are drawn from User-Defined Table 0339 – Advanced Beneficiary Notice Code in Chapter 2C, Code Tables.

(Definition from FT1.27 in Ch. 6)

Definition: This field indicates the status of the patient's or the patient's representative's consent for responsibility to pay for potentially uninsured services. This element is introduced to satisfy CMS Medical Necessity requirements for outpatient services. This element indicates (a) whether the associated diagnosis codes for the service are subject to medical necessity procedures, (b) whether, for this type of service, the patient has been informed that they may be responsible for payment for the service, and (c) whether the patient agrees to be billed for this service. Refer to User-defined Table 0339 - Advanced Beneficiary Notice Code in Chapter 2C, Code Tables, for suggested values.

FT1-28: Medically Necessary Duplicate Procedure Reason (CWE) 01646

(Definition from OBR.48 in Ch. 4)

Definition: This field is used to document why the procedure found in OBR-44 - Procedure Code is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary. The reason may be coded or it may be a free text entry.

This field is intended to provide financial systems information on who to bill for duplicate procedures.

Refer to User-Defined Table 0476 – Medically Necessary Duplicate Procedure Reason in Chapter 2C, Code Tables, for suggested values.

(Definition from FT1.28 in Ch. 6)

Definition: This field is used to document why the procedure found in FT1-25 - Procedure Code is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary. The reason may be coded or it may be a free text entry. This field is intended to provide financial systems information on who to bill for duplicate procedures. Refer to User-Defined Table 0476 – Medically Necessary Duplicate Procedure Reason in Chapter 2C, Code Tables, for suggested values.

(Definition from OBR.48 in Ch. 7)

Definition: This field is used to document why the procedure found in OBR-44 - Procedure Code is a duplicate of one ordered/charged previously for the same patient within the same date of service and has been determined to be medically necessary. The reason may be coded or it may be a free text entry.

This field is intended to provide financial systems information on who to bill for duplicate procedures.

Refer to User-Defined Table 0476 – Medically Necessary Duplicate Procedure Reason in Chapter 2C, Code Tables, for suggested values.

FT1-29: NDC Code (CWE) 01845

Definition: This field has been defined for NDC codes that are required by HIPAA for electronic claims for Pharmacy charges. Refer to Externally-defined Table 0549- NDC Codes in Chapter 2C, Code Tables, for suggested values.

If a system supports multiple NDC codes for a charge, this information will be sent in OBX segments. FT1-29 and FT1-43 can be used for single NDC codes and quantities instead of using OBX.

FT1-30: Payment Reference ID (CX) 01846

Definition: The payment reference number of the payment medium reported in FT1-7 - Transaction Code.

FT1-31: Transaction Reference Key (SI) 01847

Definition: The reference key linking the payment to the corresponding charge in an e-claim. This field should contain the FT1-1 - Set ID FT1 that identifies the charge corresponding to the payment. This field is repeating to allow a payment to be posted against multiple charges.

FT1-32: Performing Facility (XON) 02361

Definition: This field contains the name of the Facility where the service is performed by the Provider Person/Group identified in FT1-20 – Performed By Code.

FT1-33: Ordering Facility (XON) 02362

Definition: This field contains the name of the Facility where the service is ordered by the Ordering Provider/Group identified in FT1-21 – Ordered By Code.

FT1-34: Item Number (CWE) 02363

Definition: This field contains the Item Number for a product. If valued, this field will override the value in the Service Catalog. Item Number (along with Model Number) can be seen as a supplemental number for specific equipment or inventory-related charges.

FT1-35: Model Number (ST) 02364

Definition: This field contains the Model Number for a product. If valued, this field will override the value in the Service Catalog. Model Number (along with Item Number) can be seen as a supplemental number for specific equipment or inventory-related charges.

FT1-36: Special Processing Code (CWE) 02365

Definition: This field contains a Special Processing Code that is available in reimbursement expressions. If valued, this field will override the value in the Service Catalog.

FT1-37: Clinic Code (CWE) 02366

Definition: This field contains the state specific or payer specific type of service or place of service.

FT1-38: Referral Number (CX) 02367

Definition: This field contains the Referral Number associated with the charge.

FT1-39: Authorization Number (CX) 02368

Definition: This field contains an authorization number assigned to the referral charge.

FT1-40: Service Provider Taxonomy Code (CWE) 02369

Definition: This field contains the Taxonomy code for the Service Provider. It allows the provider to identify their specialty category for the particular service.

FT1-41: Revenue Code (CWE) 01600

(Definition from FT1.41 in Ch. 6)

Definition: This field contains the Revenue Code for the charge. If valued, this field will override the value in the Service Catalog. Refer to User-defined Table 0456 – Revenue Code in Chapter 2C, Code Tables, for suggested values.

(Definition from GP1.2 in Ch. 6)

Definition: This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field identifies revenue codes that are not linked to a HCPCS/CPT code. It is used for claiming for non-medical services such as telephone, TV or cafeteria charges, etc. There can be many per visit or claim. This field is defined by CMS or other regulatory agencies.

There can also be a revenue code linked to a HCPCS/CPT code. These are found in GP2-1 - Revenue Code. Refer to UB92 specifications.

(Definition from GP2.1 in Ch. 6)

Definition: This field identifies a specific ancillary service for each HCPC/CPT This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

FT1-42: Prescription Number (ST) 00325

(Definition from RXE.15 in Ch. 4A)

Definition: This field contains the prescription number as assigned by the pharmacy or treatment application. Equivalent in uniqueness to the pharmacy/treatment filler order number. At some sites, this may be the pharmacy or treatment system (internal) sequential form. At other sites, this may be an external form. This is a required field in RXE when used in pharmacy/treatment messages, but it is not required when used in product experience messages (see Chapter 7).

(Definition from RXD.7 in Ch. 4A)

Definition: This field is equivalent in uniqueness to the pharmacy/treatment supplier filler order number. At some sites, this may be the pharmacy/treatment supplier (internal) sequential form. At other sites, this may be an external number.

(Definition from FT1.42 in Ch. 6)

Definition: This field contains the prescription number as assigned by the pharmacy or treatment application. Equivalent in uniqueness to the pharmacy/treatment filler order number. At some sites, this may be the pharmacy or treatment system (internal) sequential form. At other sites, this may be an external form.

FT1-43: NDC Qty and UOM (CQ) 02370

Definition: This field contains the Drug Code Quantity and the Units of Measurement for the corresponding NDC-Code in FT1-29 – NDC Code.

FT1-44: DME Certificate of Medical Necessity Transmission Code (CWE) 03496

Definition: This code defines the timing, transmission method, or format by which a DME Certificate of Medical Necessity report is to be sent for the service.

For the US realm, the ANSI ASC X12 PWK DMERC CMN Indicator Segment, reference element PWK02, listed below is suggested to map to the X12 837 values:

AB

Previously Submitted to Payer

AD

Certification Included in this Claim

AF

Narrative Segment Included in this Claim

AG

No Documentation is Required

NS

Not Specified


FT1-45: DME Certification Type Code (CWE) 03497

Definition: This code identifies the type of certification for the durable medical equipment service.

For the US realm, the ANSI ASC X12 CR3 Durable Medical Equipment Certification Segment, reference element CR301, listed below is suggested to map to the X12 837 values:

I

Initial

R

Renewal

S

Revised


FT1-46: DME Duration Value (NM) 03498

Definition: This is the length of time, in months, the durable medical equipment is needed.

FT1-47: DME Certification Revision Date (DT) 03499

Definition: This is the durable medical equipment certification revision/recertification date. It is required when the DME Certification Type Code is set to Renewal or Revised.

FT1-48: DME Initial Certification Date (DT) 03500

Definition: This is durable medical equipment initial certification date. It is used to indicate the beginning of therapy and the DME Certification Type Code is set to Initial.

FT1-49: DME Last Certification Date (DT) 03501

Definition: This is the durable medical equipment last certification date. This is required if it is necessary to include supporting documentation in an electronic form for Medicare DMERC claims for which the provider is required to obtain a Certificate of Medical Necessity (CMN) from the physician.

FT1-50: DME Length of Medical Necessity Days (NM) 03502

Definition: This is the length of duration, in days, of medical necessity for the purchased or rental durable medical equipment service.

FT1-51: DME Rental Price (MO) 03503

Definition: This is the rental price of the durable medical equipment.

FT1-52: DME Purchase Price (MO) 03504

Definition: This is the purchase price for the durable medical equipment.

FT1-53: DME Frequency Code (CWE) 03505

Definition: This is the frequency or type of payment for the rental of durable medical equipment.

For the US realm, the ANSI ASC X12 SV5 Durable Medical Equipment Service Segment, reference element SV506, listed below is suggested to map to the X12 837 values:

1

Weekly

4

Monthly

6

Daily


FT1-54: DME Certification Condition Indicator (ID) 03506

Definition: This field indicates if the DME Condition Codes apply to the service. Refer to HL7 Table 0136 - Yes/no Indicator for valid values. A "Y" value indicates the condition codes apply. An "N" value indicates the condition codes do not apply.

FT1-55: DME Condition Indicator Code (CWE) 03507

Definition: This the condition indicator code for durable medical equipment. It is used on the claim service line when this information is necessary for adjudication. Two occurrences are supported.

For the US realm, the ANSI ASC X12 CRC DMERC Condition Indicator Segment, reference element CRC03, listed below is suggested to map to the X12 837 values:

38

Certification signed by the physician is on file at the supplier’s office

ZV

Replacement Item


FT1-56: Service Reason Code (CWE) 03508

Definition: This field contains the reason why the service has been performed. Refer to User-defined Table HL70964 –Service Reason Code for suggested values.

DG1 - Diagnosis Segment

The DG1 segment contains patient diagnosis information of various types, for example, admitting, primary, etc. The DG1 segment is used to send multiple diagnoses (for example, for medical records encoding). It is also used when the FT1-19 - Diagnosis Code - FT1 does not provide sufficient information for a billing system. This diagnosis coding should be distinguished from the clinical problem segment used by caregivers to manage the patient (see Chapter 12, Patient Care). Coding methodologies are also defined.

HL7 Attribute Table - DG1 - Diagnosis Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
DG1
1 00375 Set ID - DG1 SHALL [1..1] [1..4] SI
2 00376 Diagnosis Coding Method SHALL NOT W [0..0]
3 00377 Diagnosis Code - DG1 SHALL [1..1] CWE
4 00378 Diagnosis Description SHALL NOT W [0..0]
5 00379 Diagnosis Date/Time [0..1] DTM
6 00380 Diagnosis Type SHALL [1..1] CWE
7 00381 Major Diagnostic Category SHALL NOT W [0..0] CNE
8 00382 Diagnostic Related Group SHALL NOT W [0..0] CNE
9 00383 DRG Approval Indicator SHALL NOT W [0..0] ID
10 00384 DRG Grouper Review Code SHALL NOT W [0..0] CWE
11 00385 Outlier Type SHALL NOT W [0..0] CWE
12 00386 Outlier Days SHALL NOT W [0..0] NM
13 00387 Outlier Cost SHALL NOT W [0..0] CP
14 00388 Grouper Version And Type SHALL NOT W [0..0]
15 00389 Diagnosis Priority = [0..1] 2 NM
16 00390 Diagnosing Clinician [0..*] XCN
17 00766 Diagnosis Classification [0..1] CWE
18 00767 Confidential Indicator [0..1] [1..1] ID
19 00768 Attestation Date/Time [0..1] DTM
20

01850 Diagnosis Identifier MAY
True:
False:
C
[1..1]
[0..1]
EI
21

01894 Diagnosis Action Code MAY
True:
False:
C
[1..1]
[0..1]
[1..1] ID
22

02152 Parent Diagnosis MAY
True:
False:
C
[1..1]
[0..1]
EI
23 02153 DRG CCL Value Code [0..1] CWE
24 02154 DRG Grouping Usage [0..1] [1..1] ID
25 02155 DRG Diagnosis Determination Status [0..1] CWE
26 02288 Present On Admission [0..1] CWE

DG1-1: Set ID - DG1 (SI) 00375

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment the sequence number shall be 1, for the second occurrence it shall be 2, etc.

DG1-2: Diagnosis Coding Method

Attention: DG1-2 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6 .

DG1-3: Diagnosis Code - DG1 (CWE) 00377

Definition: DG1-3 - Diagnosis Code - DG1 contains the diagnosis code assigned to this diagnosis. Refer to User-defined Table 0051 - Diagnosis Code in Chapter 2C, Code Tables, for suggested values. This field is a CWE data type for compatibility with clinical and ancillary systems. Either DG1-3.1-Identifier or DG1-3.2-Text is required. When a code is used in DG1-3.1-Identifier, a coding system is required in DG1-3.3-Name of Coding System.

Names of various diagnosis coding systems are listed in Chapter 2, Section 2.16.4, "Coding system table."

DG1-4: Diagnosis Description

Attention: DG1-4 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

DG1-5: Diagnosis Date/Time (DTM) 00379

Definition: This field contains the date/time that the diagnosis was determined.

DG1-6: Diagnosis Type (CWE) 00380

Definition: This field contains a code that identifies the type of diagnosis being sent. Refer to User-defined Table 0052 - Diagnosis Type in Chapter 2C, Code Tables, for suggested values. This field should no longer be used to indicate "DRG" because the DRG fields have moved to the new DRG segment.

DG1-7: Major Diagnostic Category

(Definition from DG1.7 in Ch. 6)

Attention: DG1-7 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6 .

(Definition from DMI.2 in Ch. 8)

Definition: This field indicates the determined Major Diagnostic Category (MDC) value. Refer to External Table 0118 – Major Diagnostic Category in Chapter 2C, Code Tables, for suggested values.

DG1-8: Diagnostic Related Group

(Definition from DG1.8 in Ch. 6)

Attention: DG1-8 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

(Definition from DRG.1 in Ch. 6)

Definition: This field contains the DRG for the transaction. Interim DRG's could be determined for an encounter. Refer to Externally-defined Table 0055 – Diagnosis Related Group in Chapter 2C, Code Tables, for suggested values.

(Definition from DMI.1 in Ch. 8)

Definition: This field contains the DRG for the transaction. Interim DRG's could be determined for an encounter. Refer to External Table 0055 – Diagnosis Related Group in Chapter 2C, Code Tables, for suggested values.

DG1-9: DRG Approval Indicator

(Definition from DG1.9 in Ch. 6)

Attention: DG1-9 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.3 in Ch. 6)

Definition: This field indicates if the DRG has been approved by a reviewing entity. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    the DRG has been approved by a reviewing entity

  • N    the DRG has not been approved

DG1-10: DRG Grouper Review Code

(Definition from DG1.10 in Ch. 6)

Attention: DG1-10 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.4 in Ch. 6)

Definition: This code indicates that the grouper results have been reviewed and approved. Refer to User-defined Table 0056 - DRG Grouper Review Code in Chapter 2C, Code Tables, for suggested values.

DG1-11: Outlier Type

(Definition from DG1.11 in Ch. 6)

Attention: DG1-11 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.5 in Ch. 6)

Definition: Refers to the type of outlier (i.e., period of care beyond DRG-standard stay in facility) that has been paid. Refer to User-defined Table 0083 - Outlier Type in Chapter 2C, code Tables, for suggested values.

DG1-12: Outlier Days

(Definition from DG1.12 in Ch. 6)

Attention: DG1-12 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.6 in Ch. 6)

Definition: This field contains the number of days that have been approved as an outlier payment.

DG1-13: Outlier Cost

(Definition from DG1.13 in Ch. 6)

Attention: DG1-13 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.7 in Ch. 6)

Definition: This field contains the amount of money that has been approved for an outlier payment.

(Definition from GP1.5 in Ch. 6)

Definition: This field contains the amount that exceeds the outlier limitation as defined by APC regulations. This field is analogous to DRG-7 - Outlier Cost; however, the definition in this field note supersedes the DRG-7 definition.

DG1-14: Grouper Version And Type

Attention: DG1-14 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

DG1-15: Diagnosis Priority (NM) 00389

Definition: This field contains the number that identifies the significance or priority of the diagnosis code. Refer to HL7 Table 0359 - Diagnosis Priority in Chapter 2C, Code Tables, for suggested values.

Note: As of v 2.7, the data type has been changed to numeric. The meaning of the values remains the same as those in HL7 Table 0418 – Procedure Priority, The value 0 conveys that this procedure is not included in the ranking. The value 1 means that this is the primary procedure. Values 2-99 convey ranked secondary procedures.

DG1-16: Diagnosing Clinician (XCN) 00390

Definition: This field contains the individual responsible for generating the diagnosis information. As of v 2.7, if XCN.1 - ID Number is populated, then the XCN.13 - Identifier Type Code and the XCN.9 - Assigning Authority or XCN.22 - Assigning Jurisdiction or XCN.23 - Assigning Agency or Department are required. If XCN.2 - Family Name is populated, then the XCN.10 - Name Type Code is required. No assumptions can be safely made based on position or sequence. Specification of meaning based on sequence is deprecated.

DG1-17: Diagnosis Classification (CWE) 00766

Definition: This field indicates if the patient information is for a diagnosis or a non-diagnosis code. Refer to User-defined Table 0228 - Diagnosis Classification in Chapter 2C, Code Tables, for suggested values.

DG1-18: Confidential Indicator (ID) 00767

(Definition from DG1.18 in Ch. 6)

Definition: This field indicates whether the diagnosis is confidential. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, "Code Tables", for valid values.

  • Y    the diagnosis is a confidential diagnosis

  • N    the diagnosis does not contain a confidential diagnosis

(Definition from DRG.10 in Ch. 6)

Definition: This field indicates if the DRG contains a confidential diagnosis. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the DRG contains a confidential diagnosis

  • N    the DRG does not contain a confidential diagnosis

DG1-19: Attestation Date/Time (DTM) 00768

Definition: This field contains the time stamp that indicates the date and time that the attestation was signed.

DG1-20: Diagnosis Identifier (EI) 01850

Definition: This field contains a value that uniquely identifies a single diagnosis for an encounter. It is unique across all segments and messages for an encounter. This field is required in all implementations employing Update Diagnosis/Procedures (P12) messages.

DG1-21: Diagnosis Action Code (ID) 01894

Definition: This field defines the action to be taken for this diagnosis. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, "Code Tables", for valid values. This field is required for the update diagnosis/procedures (P12) message. In all other events it is optional.

DG1-22: Parent Diagnosis (EI) 02152

Definition: This field contains the entity identifier for the parent diagnosis. This field links the "current" manifestation diagnosis ("*") to the entity identifier of the "parent" etiological diagnosis ("+").

DG1-23: DRG CCL Value Code (CWE) 02153

Definition: This field indicates the CCL value for the determined DRG for this diagnosis. Refer to Externally-defined Table 0728 - CCL Value in Chapter 2C, Code Tables, for suggested values.

DG1-24: DRG Grouping Usage (ID) 02154

Definition: This field identifies whether this particular diagnosis has been used for the DRG determination. Refer to HL7 Table 0136 – Yes/No Indicator in Chapter 2C, Code Tables, for suggested values. The values have the following meaning for this field:

Y    Yes - Indicates that the diagnosis has been used for the DRG determination

N    No – Indicates that the diagnosis has not been used for the DRG determination

DG1-25: DRG Diagnosis Determination Status (CWE) 02155

Definition: This field contains the status of this particular diagnosis for the DRG determination. Refer to User-defined Table 0731 – DRG Diagnosis Determination Status in Chapter 2C, Code Tables, for suggested values.

DG1-26: Present On Admission (CWE) 02288

Definition: This field contains the present on admission indicator for this particular diagnosis. US reimbursement formulas for some states and Medicare have mandated that each diagnosis code be flagged as to whether it was present on admission or not. Refer to User-defined Table 0895 – Present On Admission (POA) Indicator in Chapter 2C, Code Tables, for suggested values.

DRG - Diagnosis Related Group Segment

The DRG segment contains diagnoses-related grouping information of various types. The DRG segment is used to send the DRG information, for example, for billing and medical records encoding.

HL7 Attribute Table - DRG - Diagnosis Related Group Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
DRG
1 00382 Diagnostic Related Group [0..1] CNE
2 00769 DRG Assigned Date/Time [0..1] DTM
3 00383 DRG Approval Indicator [0..1] ID
4 00384 DRG Grouper Review Code [0..1] CWE
5 00385 Outlier Type [0..1] CWE
6 00386 Outlier Days [0..1] NM
7 00387 Outlier Cost [0..1] CP
8 00770 DRG Payor [0..1] CWE
9 00771 Outlier Reimbursement [0..1] CP
10 00767 Confidential Indicator [0..1] [1..1] ID
11 01500 DRG Transfer Type [0..1] CWE
12 02156 Name of Coder [0..1] XPN
13 02157 Grouper Status [0..1] CWE
14 02158 PCCL Value Code [0..1] CWE
15 02159 Effective Weight # [0..1] 5 NM
16 02160 Monetary Amount [0..1] MO
17 02161 Status Patient [0..1] CWE
18 02162 Grouper Software Name # [0..1] 100 ST
19 02282 Grouper Software Version # [0..1] 100 ST
20 02163 Status Financial Calculation [0..1] CWE
21 02164 Relative Discount/Surcharge [0..1] MO
22 02165 Basic Charge [0..1] MO
23 02166 Total Charge [0..1] MO
24 02167 Discount/Surcharge [0..1] MO
25 02168 Calculated Days = [0..1] 5 NM
26 02169 Status Gender [0..1] CWE
27 02170 Status Age [0..1] CWE
28 02171 Status Length of Stay [0..1] CWE
29 02172 Status Same Day Flag [0..1] CWE
30 02173 Status Separation Mode [0..1] CWE
31 02174 Status Weight at Birth [0..1] CWE
32 02175 Status Respiration Minutes [0..1] CWE
33 02176 Status Admission [0..1] CWE

DRG-1: Diagnostic Related Group (CNE) 00382

(Definition from DG1.8 in Ch. 6)

Attention: DG1-8 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

(Definition from DRG.1 in Ch. 6)

Definition: This field contains the DRG for the transaction. Interim DRG's could be determined for an encounter. Refer to Externally-defined Table 0055 – Diagnosis Related Group in Chapter 2C, Code Tables, for suggested values.

(Definition from DMI.1 in Ch. 8)

Definition: This field contains the DRG for the transaction. Interim DRG's could be determined for an encounter. Refer to External Table 0055 – Diagnosis Related Group in Chapter 2C, Code Tables, for suggested values.

DRG-2: DRG Assigned Date/Time (DTM) 00769

Definition: This field contains the time stamp to indicate the date and time that the DRG was assigned.

DRG-3: DRG Approval Indicator (ID) 00383

(Definition from DG1.9 in Ch. 6)

Attention: DG1-9 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.3 in Ch. 6)

Definition: This field indicates if the DRG has been approved by a reviewing entity. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    the DRG has been approved by a reviewing entity

  • N    the DRG has not been approved

DRG-4: DRG Grouper Review Code (CWE) 00384

(Definition from DG1.10 in Ch. 6)

Attention: DG1-10 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.4 in Ch. 6)

Definition: This code indicates that the grouper results have been reviewed and approved. Refer to User-defined Table 0056 - DRG Grouper Review Code in Chapter 2C, Code Tables, for suggested values.

DRG-5: Outlier Type (CWE) 00385

(Definition from DG1.11 in Ch. 6)

Attention: DG1-11 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.5 in Ch. 6)

Definition: Refers to the type of outlier (i.e., period of care beyond DRG-standard stay in facility) that has been paid. Refer to User-defined Table 0083 - Outlier Type in Chapter 2C, code Tables, for suggested values.

DRG-6: Outlier Days (NM) 00386

(Definition from DG1.12 in Ch. 6)

Attention: DG1-12 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.6 in Ch. 6)

Definition: This field contains the number of days that have been approved as an outlier payment.

DRG-7: Outlier Cost (CP) 00387

(Definition from DG1.13 in Ch. 6)

Attention: DG1-13 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.7 in Ch. 6)

Definition: This field contains the amount of money that has been approved for an outlier payment.

(Definition from GP1.5 in Ch. 6)

Definition: This field contains the amount that exceeds the outlier limitation as defined by APC regulations. This field is analogous to DRG-7 - Outlier Cost; however, the definition in this field note supersedes the DRG-7 definition.

DRG-8: DRG Payor (CWE) 00770

Definition: This field indicates the associated DRG Payor. Refer to User-defined Table 0229 - DRG Payor in Chapter 2C, Code Tables, for suggested values.

DRG-9: Outlier Reimbursement (CP) 00771

Definition: Where applicable, the outlier reimbursement amount indicates the part of the total reimbursement designated for reimbursement of outlier conditions (day or cost).

DRG-10: Confidential Indicator (ID) 00767

(Definition from DG1.18 in Ch. 6)

Definition: This field indicates whether the diagnosis is confidential. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, "Code Tables", for valid values.

  • Y    the diagnosis is a confidential diagnosis

  • N    the diagnosis does not contain a confidential diagnosis

(Definition from DRG.10 in Ch. 6)

Definition: This field indicates if the DRG contains a confidential diagnosis. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the DRG contains a confidential diagnosis

  • N    the DRG does not contain a confidential diagnosis

DRG-11: DRG Transfer Type (CWE) 01500

Definition: This field indicates the type of hospital receiving a transfer patient, which affects how a facility is reimbursed under diagnosis related group (DRG's), for example, exempt or non-exempt. Refer to User-defined Table 0415 - DRG Transfer Type in Chapter 2C, code Tables, for suggested values.

DRG-12: Name of Coder (XPN) 02156

Definition: This field holds the name of the person ("coder") who supervised or undertook the determination of the DRG code.

DRG-13: Grouper Status (CWE) 02157

Definition: This field indicates the grouper status in general. Refer to Externally-defined Table 0734 - Grouper Status in Chapter 2C, Code Tables, for suggested values.

DRG-14: PCCL Value Code (CWE) 02158

Definition: This field indicates the PCCL (Patient Clinical Complexity Level) value for the calculated DRG as a single value. This value is calculated based on all individual CCL values calculated so far in relation to the basic DRG. Refer to Externally-defined Table 0728 - CCL Value in Chapter 2C, Code Tables, for suggested values.

DRG-15: Effective Weight (NM) 02159

Definition: This field contains the effective weight as calculated for this DRG. When exceeding the upper or lower trim point the effective weight is lower or higher.

DRG-16: Monetary Amount (MO) 02160

Definition: This field contains the monetary amount as calculated for this DRG, i.e., the sum of money the insurance company will pay.

DRG-17: Status Patient (CWE) 02161

Definition: This field contains the status of the patient concerning the financial aspects. It indicates whether the length of stay is normal or respectively shorter or longer than normal. Refer to User-defined Table 0739 – DRG Status Patient in Chapter 2C, Code Tables, for suggested values.

This field is also used along with DRG-23 and DRG-24 as an indication of whether a surcharge (long length of stay) or a discount (short length of stay) has been determined.

DRG-18: Grouper Software Name (ST) 02162

Definition: This field contains the name of the software used for grouping.

DRG-19: Grouper Software Version (ST) 02282

Definition: This field contains the version information of the software used for grouping.

DRG-20: Status Financial Calculation (CWE) 02163

Definition: This field contains the status of the DRG calculation regarding the financial aspects. Refer to User-defined Table 0742 – DRG Status Financial Calculation in Chapter 2C, Code Tables, for suggested values.

DRG-21: Relative Discount/Surcharge (MO) 02164

Definition: There will be a discount/surcharge for the calculated price due to a very short stay, early referral or a very long stay. This field contains the discount or surcharge that is included in the final price.

DRG-22: Basic Charge (MO) 02165

Definition: The basic charge is calculated as a multiplication of the relative weight with the base rate.

DRG-23: Total Charge (MO) 02166

Definition: This field contains the total charge including surcharges or discounts.

DRG-24: Discount/Surcharge (MO) 02167

Definition: This field contains the discount/surcharge as determined for this DRG. The addition/reduction is indicated by DRG-17 - Status Patient.

DRG-25: Calculated Days (NM) 02168

Definition: This field contains the number of days, for which a surcharge/discount has been determined. The addition/reduction is indicated by DRG-17 - Status Patient.

DRG-26: Status Gender (CWE) 02169

Definition: This field contains the status of the use of the gender information for DRG determination. Refer to User-defined Table 0749 – DRG Grouping Status in Chapter 2C, Code Tables, for suggested values.

DRG-27: Status Age (CWE) 02170

Definition: This field contains the status of the use of the age information for DRG determination. Refer to User-defined Table 0749 – DRG Grouping Status in Chapter 2C, Code Tables, for suggested values.

DRG-28: Status Length of Stay (CWE) 02171

Definition: This field contains the status of the DRG calculation for the length of stay information. Refer to User-defined Table 0749 – DRG Grouping Status in Chapter 2C, Code Tables, for suggested values.

DRG-29: Status Same Day Flag (CWE) 02172

Definition: This field contains the status of the use of the same day information for DRG determination. Refer to User-defined Table 0749 – DRG Grouping Status in Chapter 2C, Code Tables, for suggested values.

DRG-30: Status Separation Mode (CWE) 02173

Definition: This field contains the status of the use of the separation mode information for DRG determination. Refer to User-defined Table 0749 – DRG Grouping Status in Chapter 2C, Code Tables, for suggested values.

DRG-31: Status Weight at Birth (CWE) 02174

Definition: This field contains the status of the use of the weight at birth information for DRG determination. Refer to User-defined Table 0755 – DRG Status Weight At Birth in Chapter 2C, Code Tables, for suggested values.

DRG-32: Status Respiration Minutes (CWE) 02175

Definition: This field contains the status of the use of the respiration minutes information for DRG determination. Refer to User-defined Table 0757 – DRG Status Respiration Minutes in Chapter 2C, Code Tables, for suggested values.

DRG-33: Status Admission (CWE) 02176

Definition: This field contains the admission status for the DRG determination. Refer to User-defined Table 0759 – Status Admission in Chapter 2C, Code Tables, for suggested values.

PR1 - Procedures Segment

The PR1 segment contains information relative to various types of procedures that can be performed on a patient. The PR1 segment can be used to send procedure information, for example: Surgical, Nuclear Medicine, X-ray with contrast, etc. The PR1 segment is used to send multiple procedures, for example, for medical records encoding or for billing systems.

HL7 Attribute Table - PR1 - Procedures Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
PR1
1 00391 Set ID - PR1 SHALL [1..1] [1..4] SI
2 00392 Procedure Coding Method SHALL NOT W [0..0]
3 00393 Procedure Code SHALL [1..1] CNE
4 00394 Procedure Description SHALL NOT W [0..0]
5 00395 Procedure Date/Time SHALL [1..1] DTM
6 00396 Procedure Functional Type [0..1] CWE
7 00397 Procedure Minutes = [0..1] 4 NM
8 00398 Anesthesiologist SHALL NOT W [0..0]
9 00399 Anesthesia Code [0..1] CWE
10 00400 Anesthesia Minutes = [0..1] 4 NM
11 00401 Surgeon SHALL NOT W [0..0]
12 00402 Procedure Practitioner SHALL NOT W [0..0]
13 00403 Consent Code [0..1] CWE
14 00404 Procedure Priority [0..1] [1..2] NM
15 00772 Associated Diagnosis Code [0..1] CWE
16 01316 Procedure Code Modifier [0..*] CNE
17 01501 Procedure DRG Type [0..1] CWE
18 01502 Tissue Type Code [0..*] CWE
19

01848 Procedure Identifier MAY
True:
False:
C
[1..1]
[0..1]
EI
20

01849 Procedure Action Code MAY
True:
False:
C
[1..1]
[0..1]
[1..1] ID
21 02177 DRG Procedure Determination Status [0..1] CWE
22 02178 DRG Procedure Relevance [0..1] CWE
23 02371 Treating Organizational Unit [0..*] PL
24 02372 Respiratory Within Surgery [0..1] [1..1] ID
25 02373 Parent Procedure ID [0..1] EI

PR1-1: Set ID - PR1 (SI) 00391

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment the sequence number shall be 1, for the second occurrence it shall be 2, etc.

PR1-2: Procedure Coding Method

Attention: PR1-2 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

PR1-3: Procedure Code (CNE) 00393

(Definition from OBR.44 in Ch. 4)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined table 0088 – Procedure code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from FT1.25 in Ch. 6)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of v 2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Coding Systems (from HL7 Table 0396)

Code

Description

Comment / Source

C4

CPT-4

American Medical Association, P.O. Box 10946, Chicago IL 60610.

C5

CPT-5

(under development – same contact as above)

HCPCS

CMS (formerly HCFA) Common Procedure Coding System

HCPCS: contains codes for medical equipment, injectable drugs, transportation services, and other services not found in CPT4.

HPC

CMS (formerly HCFA )Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.

I10P

ICD-10 Procedure Codes

Procedure Coding System (ICD-10-PCS.) See http://www/hcfa.gov/stats/icd10.icd10.htm for more information.


(Definition from PR1.3 in Ch. 6)

Definition: This field contains a unique identifier assigned to the procedure. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems.

(Definition from OBR.44 in Ch. 7)

Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the charge. Refer to Externally-defined table 0088 – Procedure code in Chapter 2C, Code Tables, for suggested values. This field is a coded data type for compatibility with clinical and ancillary systems.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from CDM.7 in Ch. 8)

Definition: This field contains the procedure code for procedure, if any, associated with this charge description. Repeating field allows for different procedure coding systems such as CPT4, ICD9. Coded entry made up of code plus coding schema. Refer to Externally-defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values.

(Definition from IIM.14 in Ch. 17)

Definition: This field contains a unique identifier assigned to the service item, if any, associated with the charge. In the United States this is often the HCPCS code. Refer to Externally Defined Table 0088 - Procedure Code in Chapter 2C, Code Tables, for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Coding Systems

Coding System

Description

Comment

C4

CPT-4

American Medical Association, P.O. Box 10946, Chicago IL 60610.

C5

CPT-5

(under development – same contact as above)

HCPCS

CMS (formerly HCFA) Common Procedure Coding System

HCPCS: contains codes for medical equipment, injectable drugs, transportation services, and other services not found in CPT4.

HPC

CMS (formerly HCFA) Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.


(Definition from ITM.27 in Ch. 17)

Definition: This field contains a unique identifier assigned to the service item, if any, associated with the charge. In the United States this is often the HCPCS code. Refer to Externally defined Table 0088 - Procedure code for suggested values. This field is a CNE data type for compatibility with clinical and ancillary systems. Refer to HL7 Table 0088 – Procedure Coding Systems in Chapter 2C, Code Tables, for valid values.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

(Definition from SCD.32 in Ch. 17)

Definition: The unique identifier indicating the type of procedure performed on the patient with the supplies being sterilized.

Refer to HL7 Table 0088 – Procedure Code in Chapter 2C, Code Tables, for suggested values.

As of v2.6, the known applicable external coding systems include those in the referenced table. If the code set you are using is in this table, then you must use that designation.

PR1-4: Procedure Description

Attention: PR1-4 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

PR1-5: Procedure Date/Time (DTM) 00395

Definition: This field contains the date/time that the procedure was performed.

PR1-6: Procedure Functional Type (CWE) 00396

Definition: This field contains the optional code that further defines the type of procedure. Refer to User-defined Table 0230 - Procedure Functional Type in Chapter 2C, Code Tables, for suggested values.

PR1-7: Procedure Minutes (NM) 00397

Definition: This field indicates the length of time in whole minutes that the procedure took to complete. The duration starts with the point in time in PR1-5.

PR1-8: Anesthesiologist

Attention: PR1-8 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

PR1-9: Anesthesia Code (CWE) 00399

Definition: This field contains a unique identifier of the anesthesia used during the procedure. Refer to User-defined Table 0019 - Anesthesia Code in Chapter 2C, Code Tables, for suggested values.

PR1-10: Anesthesia Minutes (NM) 00400

Definition: This field contains the length of time in minutes that the anesthesia was administered.

PR1-11: Surgeon

Attention: PR1-11 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

PR1-12: Procedure Practitioner

Attention: PR1-12 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

PR1-13: Consent Code (CWE) 00403

Definition: This field contains the type of consent that was obtained for permission to treat the patient. Refer to User-defined Table 0059 - Consent Code in Chapter 2C, Code Tables, for suggested values.

PR1-14: Procedure Priority (NM) 00404

Definition: This field contains a number that identifies the significance or priority of the procedure code. Refer to HL7 Table 0418 - Procedure Priority in Chapter 2C, Code Tables, for valid values.

Note: As of v 2.7, the data type has been changed to numeric. The meaning of the values remain the same as those in HL7 Table 0418 – Procedure Priority, The value 0 conveys that this procedure is not included in the ranking. The value 1 means that this is the primary procedure. Values 2-99 convey ranked secondary procedures.

PR1-15: Associated Diagnosis Code (CWE) 00772

Definition: This field contains the diagnosis that is the primary reason this procedure was performed, e.g., in the US, Medicare wants to know for which diagnosis this procedure is submitted for inclusion on CMS 1500 form. Refer to User-defined Table 0051 - Diagnosis Code in Chapter 2C, Code Tables, for suggested values.

PR1-16: Procedure Code Modifier (CNE) 01316

(Definition from OBR.45 in Ch. 4)

Definition: This field contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. In the USA, this is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally- defined table 0340 – Procedure code modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if OBR-44 – procedure code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from FT1.26 in Ch. 6)

Definition: This field contains the procedure code modifier to the procedure code reported in FT1-25 - Procedure Code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. This is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if FT1-25 - Procedure Code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of v 2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Procedure Code Modifier Coding Systems (From HL7 Table 0396)

Code

Description

Comment / Source

CPTM

CPT Modifier Code

Available for the AMA at the address listed for CPT above. These codes are found in Appendix A of CPT 2000 Standard Edition. (CPT 2000 Standard Edition, American Medical Association, Chicago, IL).

HPC

CMS (formerly HCFA )Procedure Codes (HCPCS)

Health Care Financing Administration (HCFA) Common Procedure Coding System (HCPCS) including modifiers.

I10P

ICD-10 Procedure Codes

Procedure Coding System (ICD-10-PCS.) See http://www/hcfa.gov/stats/icd10.icd10.htm for more information.

I9C

ICD-9CM

Commission on Professional and Hospital Activities, 1968 Green Road, Ann Arbor, MI 48105 (includes all procedures and diagnostic tests).

ICD10AM

ICD-10 Australian modification

ICD10CA

ICD-10 Canada


(Definition from PR1.16 in Ch. 6)

Definition: This field contains the procedure code modifier to the procedure code reported in field 3, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

(Definition from OBR.45 in Ch. 7)

Definition: This field contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable. Procedure code modifiers are defined by regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. The modifiers are sequenced in priority according to user entry. In the USA, this is a requirement of the UB and the 1500 claim forms. Multiple modifiers are allowed and the order placed on the form affects reimbursement. Refer to Externally- defined table 0340 – Procedure code modifier in Chapter 2C, Code Tables, for suggested values.

Usage Rule: This field can only be used if OBR-44 – procedure code contains certain procedure codes that require a modifier in order to be billed or performed. For example, HCPCS codes that require a modifier to be precise.

As of version 2.6, applicable external coding systems include those in the referenced table. If the code set used is in the referenced table, then the coding scheme designation in the table shall be used.

(Definition from IIM.15 in Ch. 17)

Definition: This field contains the procedure code modifier to the procedure code reported in IIM-14 Procedure Code, when applicable. Procedure code modifiers are defined by USA regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

(Definition from ITM.28 in Ch. 17)

Definition: This field contains the procedure code modifier to the procedure code reported in ITM-27, Procedure Code, when applicable. Procedure code modifiers are defined by USA regulatory agencies such as CMS and the AMA. Multiple modifiers may be reported. Refer to Externally-defined Table 0340 - Procedure Code Modifier in Chapter 2C, Code Tables, for suggested values.

PR1-17: Procedure DRG Type (CWE) 01501

Definition: This field indicates a procedure's priority ranking relative to its DRG. Refer to User-defined Table 0416 - Procedure DRG Type in Chapter 2C, Code Tables, for suggested values.

PR1-18: Tissue Type Code (CWE) 01502

Definition: Code representing type of tissue removed from a patient during this procedure. Refer to User-defined Table 0417 - Tissue Type Code in Chapter 2C, Code Tables, for suggested values.

PR1-19: Procedure Identifier (EI) 01848

This field contains a value that uniquely identifies a single procedure for an encounter. It is unique across all segments and messages for an encounter. This field is required in all implementations employing Update Diagnosis/Procedures (P12) messages.

PR1-20: Procedure Action Code (ID) 01849

This field defines the action to be taken for this procedure. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values. This field is required for the Update Diagnosis/Procedures (P12) message. In all other events it is optional.

PR1-21: DRG Procedure Determination Status (CWE) 02177

Definition: This field contains the status of the use of this particular procedure for the DRG determination. Refer to User-defined Table 0761 – DRG Procedure Determination Status in Chapter 2C, Code Tables, for suggested values.

PR1-22: DRG Procedure Relevance (CWE) 02178

Definition: This field contains the relevance of this particular procedure for the DRG determination. Refer to User-defined Table 0763 – DRG Procedure Relevance in Chapter 2C, code Tables, for suggested values.

PR1-23: Treating Organizational Unit (PL) 02371

Definition: This field contains information about the organizational unit that has performed the procedure.

PR1-24: Respiratory Within Surgery (ID) 02372

Definition: This field indicates whether or not a respiratory procedure has occurred during a surgery. This field is optional and only needs to be valued for respiratory procedures. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code TableS, for valid values.

PR1-25: Parent Procedure ID (EI) 02373

Definitions: This field contains a procedure ID which points to the procedure group (e.g., complete surgery) in which this instance belongs.

GT1 - Guarantor Segment

The GT1 segment contains guarantor (e.g., the person or the organization with financial responsibility for payment of a patient account) data for patient and insurance billing applications.

HL7 Attribute Table - GT1 - Guarantor Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
GT1
1 00405 Set ID - GT1 SHALL [1..1] [1..4] SI
2 00406 Guarantor Number [0..*] CX
3 00407 Guarantor Name SHALL [1..*] XPN
4 00408 Guarantor Spouse Name [0..*] XPN
5 00409 Guarantor Address [0..*] XAD
6 00410 Guarantor Ph Num – Home [0..*] XTN
7 00411 Guarantor Ph Num – Business [0..*] XTN
8 00412 Guarantor Date/Time Of Birth [0..1] DTM
9 00413 Guarantor Administrative Sex [0..1] CWE
10 00414 Guarantor Type [0..1] CWE
11 00415 Guarantor Relationship [0..1] CWE
12 00416 Guarantor SSN = [0..1] 11 ST
13 00417 Guarantor Date - Begin [0..1] DT
14 00418 Guarantor Date - End [0..1] DT
15 00419 Guarantor Priority [0..1] [1..2] NM
16 00420 Guarantor Employer Name [0..*] XPN
17 00421 Guarantor Employer Address [0..*] XAD
18 00422 Guarantor Employer Phone Number [0..*] XTN
19 00423 Guarantor Employee ID Number [0..*] CX
20 00424 Guarantor Employment Status [0..1] CWE
21 00425 Guarantor Organization Name [0..*] XON
22 00773 Guarantor Billing Hold Flag [0..1] [1..1] ID
23 00774 Guarantor Credit Rating Code [0..1] CWE
24 00775 Guarantor Death Date And Time [0..1] DTM
25 00776 Guarantor Death Flag [0..1] [1..1] ID
26 00777 Guarantor Charge Adjustment Code [0..1] CWE
27 00778 Guarantor Household Annual Income [0..1] CP
28 00779 Guarantor Household Size = [0..1] 3 NM
29 00780 Guarantor Employer ID Number [0..*] CX
30 00781 Guarantor Marital Status Code [0..1] CWE
31 00782 Guarantor Hire Effective Date [0..1] DT
32 00783 Employment Stop Date [0..1] DT
33 00755 Living Dependency [0..1] CWE
34 00145 Ambulatory Status [0..*] CWE
35 00129 Citizenship [0..*] CWE
36 00118 Primary Language [0..1] CWE
37 00742 Living Arrangement [0..1] CWE
38 00743 Publicity Code [0..1] CWE
39 00744 Protection Indicator [0..1] [1..1] ID
40 00745 Student Indicator [0..1] CWE
41 00120 Religion [0..1] CWE
42 00109 Mother's Maiden Name [0..*] XPN
43 00739 Nationality [0..1] CWE
44 00125 Ethnic Group [0..*] CWE
45 00748 Contact Person's Name [0..*] XPN
46 00749 Contact Person's Telephone Number [0..*] XTN
47 00747 Contact Reason [0..1] CWE
48 00784 Contact Relationship [0..1] CWE
49 00785 Job Title # [0..1] 20 ST
50 00786 Job Code/Class [0..1] JCC
51 01299 Guarantor Employer's Organization Name [0..*] XON
52 00753 Handicap [0..1] CWE
53 00752 Job Status [0..1] CWE
54 01231 Guarantor Financial Class [0..1] FC
55 01291 Guarantor Race [0..*] CWE
56 01851 Guarantor Birth Place # [0..1] 100 ST
57 00146 VIP Indicator [0..1] CWE

GT1-1: Set ID - GT1 (SI) 00405

Definition: GT1-1 - Set ID contains a number that identifies this transaction. For the first occurrence of the segment the sequence shall be 1, for the second occurrence it shall be 2, etc.

GT1-2: Guarantor Number (CX) 00406

Definition: This field contains the primary identifier, or other identifiers, assigned to the guarantor. The assigning authority and identifier type code are strongly recommended for all CX data types.

GT1-3: Guarantor Name (XPN) 00407

Definition: This field contains the name of the guarantor. Multiple names for the same guarantor may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

Beginning with version 2.3, if the guarantor is an organization, send a Delete Indication value ("") in GT1-3 - Guarantor Name and put the organization name in GT1-21 - Guarantor Organization Name. Either guarantor name or guarantor organization name is required.

GT1-4: Guarantor Spouse Name (XPN) 00408

Definition: This field contains the name of the guarantor's spouse. Multiple names for the same guarantor spouse may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-5: Guarantor Address (XAD) 00409

Definition: This field contains the guarantor's address. Multiple addresses for the same person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-6: Guarantor Ph Num – Home (XTN) 00410

Definition: This field contains the guarantor's home phone number. All personal phone numbers for the guarantor may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated. .

GT1-7: Guarantor Ph Num – Business (XTN) 00411

Definition: This field contains the guarantor's business phone number. All business phone numbers for the guarantor may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-8: Guarantor Date/Time Of Birth (DTM) 00412

Definition: This field contains the guarantor's date of birth.

GT1-9: Guarantor Administrative Sex (CWE) 00413

Definition: This field contains the guarantor's gender. Refer to User-defined Table 0001 - Administrative Sex in Chapter 2C, Code Tables, for suggested values.

GT1-10: Guarantor Type (CWE) 00414

Definition: This field indicates the type of guarantor, e.g., individual, institution, etc. Refer to User-defined Table 0068 - Guarantor Type in Chapter 2C, Code Tables, for suggested values.

GT1-11: Guarantor Relationship (CWE) 00415

Definition: This field indicates the relationship of the guarantor with the patient, e.g., parent, child, etc. Refer to User-defined Table 0063 - Relationship in Chapter 2C, Code Tables, for suggested values.

GT1-12: Guarantor SSN (ST) 00416

Definition: This field contains the guarantor's social security number.

GT1-13: Guarantor Date - Begin (DT) 00417

Definition: This field contains the date that the guarantor becomes responsible for the patient's account.

GT1-14: Guarantor Date - End (DT) 00418

Definition: This field contains the date that the guarantor stops being responsible for the patient's account.

GT1-15: Guarantor Priority (NM) 00419

Definition: This field is used to determine the order in which the guarantors are responsible for the patient's account.

  • "1" = primary guarantor

  • "2" = secondary guarantor, etc.

GT1-16: Guarantor Employer Name (XPN) 00420

Definition: This field contains the name of the guarantor's employer, if the employer is a person. When the guarantor's employer is an organization, use GT1-51 - Guarantor Employer's Organization Name. Multiple names for the same person may be sent in this field, not multiple employers. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-17: Guarantor Employer Address (XAD) 00421

Definition: This field contains the guarantor's employer's address. Multiple addresses for the same employer may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-18: Guarantor Employer Phone Number (XTN) 00422

Definition: This field contains the guarantor's employer's phone number. Multiple phone numbers for the same employer may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated. .

GT1-19: Guarantor Employee ID Number (CX) 00423

Definition: This field contains the guarantor's employee number. The assigning authority and identifier type code are strongly recommended for all CX data types.

GT1-20: Guarantor Employment Status (CWE) 00424

Definition: This field contains the code that indicates the guarantor's employment status. Refer to User-Defined Table 0066 - Employment Status in Chapter 2C, Code Tables, for suggested values.

GT1-21: Guarantor Organization Name (XON) 00425

Definition: This field contains the name of the guarantor when the guarantor is an organization. Multiple names for the same guarantor may be sent in this field, not multiple guarantors. .Specification of meaning based on sequence is deprecated

Beginning with version 2.3, if the guarantor is a person, send a Delete Indication value ("") in GT1-21 - Guarantor Organization Name and put the person name in GT1-3 - Guarantor Name. Either guarantor person name or guarantor organization name is required.

GT1-22: Guarantor Billing Hold Flag (ID) 00773

Definition: Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values. This field indicates whether or not a system should suppress printing of the guarantor's bills.

  • Y    a system should suppress printing of guarantor's bills

  • N    a system should not suppress printing of guarantor's bills

GT1-23: Guarantor Credit Rating Code (CWE) 00774

Definition: This field contains the guarantor's credit rating. Refer to User-defined Table 0341 - Guarantor Credit Rating Code in Chapter 2C, Code Tables, for suggested values.

GT1-24: Guarantor Death Date And Time (DTM) 00775

Definition: This field is used to indicate the date and time at which the guarantor's death occurred.

GT1-25: Guarantor Death Flag (ID) 00776

Definition: This field indicates whether or not the guarantor is deceased. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the guarantor is deceased

  • N    the guarantor is living

GT1-26: Guarantor Charge Adjustment Code (CWE) 00777

Definition: This field contains user-defined codes that indicate which adjustments should be made to this guarantor's charges. For example, when the hospital agrees to adjust this guarantor's charges to a sliding scale. Refer to User-defined Table 0218 - Patient Charge Adjustment in Chapter 2C, Code Tables, for suggested values.

Example: This field would contain the value used for sliding-fee scale processing.

GT1-27: Guarantor Household Annual Income (CP) 00778

Definition: This field contains the combined annual income of all members of the guarantor's household.

GT1-28: Guarantor Household Size (NM) 00779

Definition: This field specifies the number of people living at the guarantor's primary residence.

GT1-29: Guarantor Employer ID Number (CX) 00780

Definition: This is a code that uniquely identifies the guarantor's employer when the employer is a person. It may be a user-defined code or a code defined by a government agency (Federal Tax ID#).

When further breakdowns of employer information are needed, such as a division or plant, it is recommended that the coding scheme incorporate the relationships (e.g., define separate codes for each division). The assigning authority and identifier type code are strongly recommended for all CX data types.

GT1-30: Guarantor Marital Status Code (CWE) 00781

Definition: This field contains the marital status of the guarantor. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

GT1-31: Guarantor Hire Effective Date (DT) 00782

Definition: This field contains the date that the guarantor's employment began.

GT1-32: Employment Stop Date (DT) 00783

(Definition from GT1.32 in Ch. 6)

Definition: This field indicates the date on which the guarantor's employment with a particular employer ended.

(Definition from IN2.45 in Ch. 6)

Definition: This field indicates the date on which the person's employment with a particular employer ended.

GT1-33: Living Dependency (CWE) 00755

(Definition from NK1.17 in Ch. 3)

Definition: This field identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. Examples might include Spouse Dependent, Medical Supervision Required, Small Children Dependent. This field repeats because, for example, "spouse dependent" and "medical supervision required" can apply at the same time. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.1 in Ch. 3)

Definition: This field identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. This field repeats because, for example, "spouse dependent" and "medical supervision required" can apply at the same time. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.33 in Ch. 6)

Definition: Identifies the specific living conditions of the guarantor. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.31 in Ch. 6)

Definition: This field identifies the specific living conditions for the insured. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

GT1-34: Ambulatory Status (CWE) 00145

(Definition from PV1.15 in Ch. 3)

Definition: This field indicates any permanent or transient handicapped conditions. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested entries.

(Definition from NK1.18 in Ch. 3)

Definition: This field identifies the transient rate of mobility for the next of kin/associated party. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables for suggested values.

(Definition from GT1.34 in Ch. 6)

Definition: Identifies the transient state of mobility for the guarantor. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.32 in Ch. 6)

Definition: This field identifies the insured's state of mobility. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested values.

GT1-35: Citizenship (CWE) 00129

(Definition from PID.26 in Ch. 3)

This field contains the information related to a person's country citizenship. For country citizenship HL7 recommends using ISO table 3166. For a local definition, User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables, should be used.

This field repeats since persons can be citizens of more than one country. The Name of Coding System component(s) of the CWE datatype should be used to identify the table from which citizenship membership is drawn.

In the Netherlands, this field is used for "Nationaliteit".

(Definition from NK1.19 in Ch. 3)

Definition: This field contains the code to identify the next of kin/associated party's citizenship. HL7 recommends using ISO 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from GT1.35 in Ch. 6)

Definition: This field contains the code to identify the guarantor's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from IN2.33 in Ch. 6)

Definition: This field contains the code that identifies the insured's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship defined in Chapter 2C, Code Tables.

(Definition from STF.30 in Ch. 15)

Definition: This field contains the staff person's current country of citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship (in Chapter 2C, Code Tables).

GT1-36: Primary Language (CWE) 00118

(Definition from PID.15 in Ch. 3)

Definition: This field contains the patient's primary language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language within Chapter 2C, Code Tables.

(Definition from NK1.20 in Ch. 3)

Definition: This field identifies the next of kin/associated party's primary speaking language. HL7 recommends using ISO 639 as the suggested values in User-defined Table 0296 - Language in Chapter 2C, Code Tables.

(Definition from GT1.36 in Ch. 6)

Definition: This field identifies the guarantor's primary speaking language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language defined in Chapter 2C, Code Tables.

(Definition from IN2.34 in Ch. 6)

Definition: This field identifies the insured's primary speaking language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language defined in Chapter 2C, Code Tables.

GT1-37: Living Arrangement (CWE) 00742

(Definition from NK1.21 in Ch. 3)

Definition: This field identifies the situation that the associated party lives in at his/her residential address. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.2 in Ch. 3)

Definition: This field identifies the situation in which the patient lives at his residential address. Examples might include Alone, Family, Relatives, Institution, etc. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.37 in Ch. 6)

Definition: This field identifies the situation in which the person lives at his residential address. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.35 in Ch. 6)

Definition: This field indicates the situation in which the insured person lives at his primary residence. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

GT1-38: Publicity Code (CWE) 00743

(Definition from NK1.22 in Ch. 3)

Definition: This field indicates what level of publicity is allowed (e.g., No Publicity, Family Only) for the next of kin/associated party. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.11 in Ch. 3)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for the patient. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values. Refer to PV2-21 - Visit Publicity Code for visit level code.

(Definition from GT1.38 in Ch. 6)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for a guarantor. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.36 in Ch. 6)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for the insured. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

GT1-39: Protection Indicator (ID) 00744

(Definition from NK1.23 in Ch. 3)

Definition: This field identifies that next of kin/associated party's protection that determines, in turn, whether access to information about this person should be kept from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/No Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    protect access to next-of-kin information

  • N    normal access

(Definition from PD1.12 in Ch. 3)

Definition: From V2.6 onward, this field has been retained for backward compatibility only. Use the ARV segment instead. This field identifies the patient's protection that determines, in turn, whether access to information about this person should be kept from users who do not have adequate authority for the patient. Refer to HL7 Table 0136 - Yes/No Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    protect access to information

  • N    normal access

Refer to PV2-22 - Visit Protection Indicator for visit level code.

(Definition from GT1.39 in Ch. 6)

Definition: This field identifies the guarantor's protection, which determines whether or not access to information about this enrollee should be restricted from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    restrict access

  • N    do not restrict access

(Definition from IN2.37 in Ch. 6)

Definition: This field identifies the insured's protection, which determines whether or not access to information about this enrollee should be restricted from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Restrict access

  • N    Do not restrict access

GT1-40: Student Indicator (CWE) 00745

(Definition from NK1.24 in Ch. 3)

Definition: This field identifies whether the next of kin/associated party is currently a student or not, and whether the next of kin/associated party is a full- or a part-time student. This field does not indicate the degree (high school, college) of the student or the field of study. Refer to User-defined Table 0231 - Student Status in chapter 2C, for suggested values.

(Definition from PD1.5 in Ch. 3)

Definition: This field indicates if the patient is currently a student or not, and whether the patient is a full-time or a part-time student. This field does not indicate the student's degree level (high school, college, elementary) or the student's field of study (accounting, engineering, etc.). Refer to User-defined Table 0231 - Student Status in chapter 2C, for suggested values.

(Definition from GT1.40 in Ch. 6)

Definition: This field indicates whether the guarantor is currently a student, and whether the guarantor is a full-time or part-time student. This field does not indicate the degree level (high school, college) of the student, or his/her field of study (accounting, engineering, etc.). Refer to User-defined Table 0231- Student Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.38 in Ch. 6)

Definition: This field identifies whether the insured is currently a student or not, and whether the insured is a full-time or a part-time student. This field does not indicate the degree level (high school, college) of student, or his/her field of study (accounting, engineering, etc.). Refer to User-defined Table 0231 - Student Status in Chapter 2C, Code Tables, for suggested values.

GT1-41: Religion (CWE) 00120

(Definition from PID.17 in Ch. 3)

Definition: This field contains the patient's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.25 in Ch. 3)

Definition: This field indicates the type of religion practiced by the next of kin/associated party. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.41 in Ch. 6)

Definition: This field indicates the type of religion practiced by the guarantor. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.39 in Ch. 6)

Definition: This field indicates the type of religion practiced by the insured. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.40 in Ch. 15)

Definition: This field contains the staff member's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

GT1-42: Mother's Maiden Name (XPN) 00109

(Definition from PID.6 in Ch. 3)

Definition: This field contains the family name under which the mother was born (i.e., before marriage). It is used to distinguish between patients with the same last name.

(Definition from NK1.26 in Ch. 3)

Definition: This field indicates the maiden name of the next of kin/associated party's mother.

(Definition from GT1.42 in Ch. 6)

Definition: This field indicates the guarantor's mother's maiden name.

(Definition from IN2.40 in Ch. 6)

Definition: This field indicates the insured's mother's maiden name.

GT1-43: Nationality (CWE) 00739

(Definition from PID.28 in Ch. 3)

Attention: The PID-28 field was retained for backward compatibility only as of v 2.4 and was withdrawn and removed from this message structure as of v 2.7. It is recommended to refer to PID-10 - Race, PID-22 - Ethnic group and PID-26 - Citizenship.

(Definition from NK1.27 in Ch. 3)

Definition: This field identifies the nation or national group to which the next of kin/associated party belongs. This information may be different than the person's citizenship in countries in which multiple nationalities are recognized (e.g., Spain: Basque, Catalan, etc.). Refer to User-defined Table 0212 - Nationality in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.43 in Ch. 6)

Definition: This field contains a code that identifies the nation or national grouping to which the person belongs. This may be different from a person's citizenship in countries in which multiple nationalities are recognized (for example, Spain: Basque, Catalan, etc.). HL7 recommends using ISO table 3166 as suggested values in User-defined Table 0212 - Nationality in Chapter 2C, Code Tables.

(Definition from IN2.41 in Ch. 6)

Definition: This field contains a code that identifies the nation or national grouping to which the insured person belongs. This information may be different from a person's citizenship in countries in which multiple nationalities are recognized (for example, Spain: Basque, Catalan, etc.). HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0212 - Nationality in Chapter 2C, Code Tables.

GT1-44: Ethnic Group (CWE) 00125

(Definition from PID.22 in Ch. 3)

Definition: This field further defines the patient's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from NK1.28 in Ch. 3)

Definition: This field contains the next of kin/associated party's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from GT1.44 in Ch. 6)

Definition: This field contains the guarantor's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from IN2.42 in Ch. 6)

Definition: This field indicates the insured's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from STF.28 in Ch. 15)

  • Definition: This field further defines the person's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second couplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the United States, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

GT1-45: Contact Person's Name (XPN) 00748

(Definition from NK1.30 in Ch. 3)

Definition: This field contains one or more of the names of the person to contact, depending on the value of the relationship defined in NK1-3 - Relationship. This field is typically needed when the NK1 is an organization. The XPN.7 Name Type Code, and not the order, conveys how the name should be interpreted. As of v2.7, Name Type Code is required. Refer to HL7 Table 0200 - Name Type in Chapter 2C, Code Tables, for valid values. Specification of meaning based on sequence is deprecated.

In addition to allowing repetition of this field for transmitting multiple names with different Name Type Codes, repetition also allows for representing the same name in different character sets based on the value in XPN.8 Name Representation Code.

(Definition from GT1.45 in Ch. 6)

Definition: This field contains the name of the person who should be contacted regarding the guarantor bills, etc. This may be someone other than the guarantor. (E.g., Contact guarantor's wife regarding all bills - guarantor lives out of country.)

This is a repeating field that allows for multiple names for the same person. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-46: Contact Person's Telephone Number (XTN) 00749

(Definition from NK1.31 in Ch. 3)

Attention: The NK1-31 field was retained for backward compatibility as of v2.7 and withdrawn as of v 2.9 The reader is referred to section 3.3.5.41 NK-41 Contact Person’s Telecommunication Information instead. This field contains the telephone numbers of the contact person depending on the value of the relationship defined in NK1-3 - Relationship. This field is typically needed when the NK1 is an organization. The primary telephone number must be sent in the first sequence. If the primary telephone number is not sent, then a repeat delimiter must be sent in the first sequence. Refer to HL7 Table 0201 - Telecommunication Use Code and HL7 Table 0202 - Telecommunication Equipment Type in Chapter 2C, Code Tables, for valid values.

(Definition from GT1.46 in Ch. 6)

Definition: This field contains the telephone number of the guarantor (person) to contact regarding guarantor bills, etc. Multiple phone numbers for that person may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

GT1-47: Contact Reason (CWE) 00747

(Definition from NK1.29 in Ch. 3)

Definition: This field identifies how the contact should be used (e.g., contact employer if patient is unable to work). Refer to User-defined Table 0222 - Contact Reason in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.47 in Ch. 6)

Definition: This field contains a user-defined code that identifies the reason for contacting the guarantor, for example, to phone the guarantor if payments are late. Refer to User-defined Table 0222 - Contact reason in Chapter 2C, Code Tables, for suggested values.

GT1-48: Contact Relationship (CWE) 00784

Definition: Identifies the guarantor relationship to the contact person specified above. Refer to User-defined Table 0063 - Relationship in Chapter 2C, Code Tables, for suggested values. Examples include wife, attorney, power of attorney, self, and organization.

GT1-49: Job Title (ST) 00785

(Definition from GT1.49 in Ch. 6)

Definition: This field contains a descriptive name of the guarantor's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

(Definition from IN2.46 in Ch. 6)

Definition: This field contains a descriptive name for the insured's occupation (for example, Sr. Systems Analyst, Sr. Accountant).

(Definition from STF.18 in Ch. 15)

Definition: This field contains a descriptive name of the staff member's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

GT1-50: Job Code/Class (JCC) 00786

(Definition from GT1.50 in Ch. 6)

Definition: This field contains the guarantor's job code and employee classification.

(Definition from IN2.47 in Ch. 6)

Definition: This field indicates a code that identifies the insured's job code (for example, programmer, analyst, doctor, etc.).

(Definition from STF.19 in Ch. 15)

Definition: This field contains the staff member's job code and employee classification. Refer to User-defined Table 0327 - Job Code and User-defined Table 0328 - Employee Classification in Chapter 2C, Code Tables, for suggested values.

GT1-51: Guarantor Employer's Organization Name (XON) 01299

Definition: This field contains the name of the guarantor's employer when the guarantor's employer is an organization. When the guarantor's employer is a person, use GT1-16 - Guarantor Employer Name. Multiple names for the same guarantor may be sent in this field Specification of meaning based on sequence is deprecated.

GT1-52: Handicap (CWE) 00753

(Definition from NK1.36 in Ch. 3)

Definition: This field contains the code that describes an associated party's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.6 in Ch. 3)

Definition: This field indicates the nature of the patient's permanent handicapped condition (e.g., deaf, blind). A handicapped condition is defined as a physical or mental disability that is permanent. Transient handicapped conditions should be sent in the ambulatory status. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.52 in Ch. 6)

Definition: This field contains a code to describe the guarantor's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from IN1.48 in Ch. 6)

Definition: This field contains a code to describe the insured's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

GT1-53: Job Status (CWE) 00752

(Definition from NK1.34 in Ch. 3)

Definition: This field identifies the next of kin/associated party's job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.53 in Ch. 6)

Definition: This field contains a code that identifies the guarantor's current job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.48 in Ch. 6)

Definition: This field indicates a code that identifies the insured's current job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

GT1-54: Guarantor Financial Class (FC) 01231

Definition: This field contains the financial class (FC) assigned to the guarantor for the purpose of identifying sources of reimbursement. It can be different than that of the patient. When the FC of the guarantor is different than the FC of the patient, and the guarantor's coverage for that patient has been exhausted, the source of reimbursement falls back onto the FC of the patient.

GT1-55: Guarantor Race (CWE) 01291

Definition: This field refers to the guarantor's race. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

GT1-56: Guarantor Birth Place (ST) 01851

Definition: This field contains the description of the guarantor's birth place, for example "St. Francis Community Hospital of Lower South Side." The actual address is reported in GT1-5 – Guarantor Address with an identifier of "N".

GT1-57: VIP Indicator (CWE) 00146

(Definition from PV1.16 in Ch. 3)

Definition: This field identifies the type of VIP. Refer to User-defined Table 0099 - VIP Indicator in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.39 in Ch. 3)

Definition: This field identifies the type of VIP for the next-of-kin. Refer to User-defined Table 0099 – VIP Indicator in Chapter 2C, Code Tables.

(Definition from GT1.57 in Ch. 6)

Definition: This field identifies the type of VIP for the guarantor. Refer to User-defined Table 0099 – VIP Indicator in Chapter 2C, Code Tables, for suggested values.

IN1 - Insurance Segment

The IN1 segment contains insurance policy coverage information necessary to produce properly pro-rated and patient and insurance bills.

HL7 Attribute Table - IN1 - Insurance Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
IN1
1 00426 Set ID - IN1 SHALL [1..1] [1..4] SI
2 00368 Health Plan ID SHALL [1..1] CWE
3 00428 Insurance Company ID SHALL [1..*] CX
4 00429 Insurance Company Name [0..*] XON
5 00430 Insurance Company Address [0..*] XAD
6 00431 Insurance Co Contact Person [0..*] XPN
7 00432 Insurance Co Phone Number [0..*] XTN
8 00433 Group Number = [0..1] 12 ST
9 00434 Group Name [0..*] XON
10 00435 Insured's Group Emp ID [0..*] CX
11 00436 Insured's Group Emp Name [0..*] XON
12 00437 Plan Effective Date [0..1] DT
13 00438 Plan Expiration Date [0..1] DT
14 00439 Authorization Information [0..1] AUI
15 00440 Plan Type [0..1] CWE
16 00441 Name Of Insured [0..*] XPN
17 00442 Insured's Relationship To Patient [0..1] CWE
18 00443 Insured's Date Of Birth [0..1] DTM
19 00444 Insured's Address [0..*] XAD
20 00445 Assignment Of Benefits [0..1] CWE
21 00446 Coordination Of Benefits [0..1] CWE
22 00447 Coord Of Ben. Priority = [0..1] 2 ST
23 00448 Notice Of Admission Flag [0..1] [1..1] ID
24 00449 Notice Of Admission Date [0..1] DT
25 00450 Report Of Eligibility Flag [0..1] [1..1] ID
26 00451 Report Of Eligibility Date [0..1] DT
27 00452 Release Information Code [0..1] CWE
28 00453 Pre-Admit Cert = [0..1] 15 ST
29 00454 Verification Date/Time [0..1] DTM
30 00455 Verification By [0..*] XCN
31 00456 Type Of Agreement Code [0..1] CWE
32 00457 Billing Status [0..1] CWE
33 00458 Lifetime Reserve Days = [0..1] 4 NM
34 00459 Delay Before L.R. Day = [0..1] 4 NM
35 00460 Company Plan Code [0..1] CWE
36 00461 Policy Number = [0..1] 15 ST
37 00462 Policy Deductible [0..1] CP
38 00463 Policy Limit - Amount SHALL NOT W [0..0]
39 00464 Policy Limit - Days = [0..1] 4 NM
40 00465 Room Rate - Semi-Private SHALL NOT W [0..0]
41 00466 Room Rate - Private SHALL NOT W [0..0]
42 00467 Insured's Employment Status [0..1] CWE
43 00468 Insured's Administrative Sex [0..1] CWE
44 00469 Insured's Employer's Address [0..*] XAD
45 00470 Verification Status = [0..1] 2 ST
46 00471 Prior Insurance Plan ID [0..1] CWE
47 01227 Coverage Type [0..1] CWE
48 00753 Handicap [0..1] CWE
49 01230 Insured's ID Number [0..*] CX
50 01854 Signature Code [0..1] CWE
51 01855 Signature Code Date [0..1] DT
52 01899 Insured's Birth Place [0..1] ST
53 01852 VIP Indicator [0..1] CWE
54 03292 External Health Plan Identifiers [0..*] CX
55 03335 Insurance Action Code [0..1] [1..*] ID

IN1-1: Set ID - IN1 (SI) 00426

Definition: IN1-1 - set ID - IN1 contains the number that identifies this transaction. For the first occurrence the sequence number shall be 1, for the second occurrence it shall be 2, etc. The Set ID in the IN1 segment is used to aggregate the grouping of insurance segments. For example, a patient with two insurance plans would have two groupings of insurance segments. IN1, IN2, and IN3 segments for Insurance Plan A with set ID 1, followed by IN1, IN2, and IN3 segments for Insurance Plan B, with set ID 2. There is no set ID in the IN2 segment because it is contained in the IN1, IN2, IN3 grouping, and is therefore not needed. The set ID in the IN3 segment is provided because there can be multiple repetitions of the IN3 segment if there are multiple certifications for the same insurance plan, e.g., IN1 (Set ID 1), IN2, IN3 (Set ID 1), IN3 (Set ID 2), IN3 (Set ID 3)

IN1-2: Health Plan ID (CWE) 00368

(Definition from FT1.14 in Ch. 6)

Definition: This field contains the identifier of the primary insurance plan with which this transaction should be associated. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values.

(Definition from IN1.2 in Ch. 6)

Definition: This field contains a unique identifier for the insurance plan. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values. To eliminate a plan, the plan could be sent with Delete Indication values in each subsequent element. If the respective systems can support it, a Delete Indication value can be sent in the plan field.

The assigning authority for IN1-2, Health Plan ID is assumed to be the Entity named in IN1-3, Insurance Company ID.

(Definition from PM1.1 in Ch. 8)

Definition: This field contains a unique identifier for the insurance plan. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values. To eliminate a plan, the plan could be sent with null values in each subsequent element. If the respective systems can support it, a null value can be sent in the plan field.

The assigning authority for PM1-1, Health Plan ID is assumed to be the Entity named in PM1-2, Insurance Company ID.

IN1-3: Insurance Company ID (CX) 00428

(Definition from IN1.3 in Ch. 6)

Definition: This field contains unique identifiers for the insurance company. The assigning authority and identifier type code are strongly recommended for all CX data types.

(Definition from PM1.2 in Ch. 8)

Definition: This field contains unique identifiers for the insurance company. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN1-4: Insurance Company Name (XON) 00429

(Definition from IN1.4 in Ch. 6)

Definition: This field contains the name of the insurance company. Multiple names for the same insurance company may be sent in this field. Specification of meaning based on sequence is deprecated.

(Definition from PM1.3 in Ch. 8)

Definition: This field contains the name of the insurance company. Multiple names for the same insurance company may be sent in this field.

IN1-5: Insurance Company Address (XAD) 00430

(Definition from IN1.5 in Ch. 6)

Definition: This field contains the address of the insurance company. Multiple addresses for the same insurance company may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

(Definition from PM1.4 in Ch. 8)

Definition: This field contains the address of the insurance company. Multiple addresses for the same insurance company may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-6: Insurance Co Contact Person (XPN) 00431

(Definition from IN1.6 in Ch. 6)

Definition: This field contains the name of the person who should be contacted at the insurance company. Multiple names for the same contact person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

(Definition from PM1.5 in Ch. 8)

Definition: This field contains the name of the person who should be contacted at the insurance company. Multiple names for the same contact person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-7: Insurance Co Phone Number (XTN) 00432

(Definition from IN1.7 in Ch. 6)

Definition: This field contains the phone number of the insurance company. Multiple phone numbers for the same insurance company may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

(Definition from PM1.6 in Ch. 8)

Definition: This field contains the phone number of the insurance company. Multiple phone numbers for the same insurance company may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-8: Group Number (ST) 00433

(Definition from IN1.8 in Ch. 6)

Definition: This field contains the group number of the insured's insurance.

(Definition from PM1.7 in Ch. 8)

Definition: This field contains the group number of the insured's insurance.

IN1-9: Group Name (XON) 00434

(Definition from IN1.9 in Ch. 6)

Definition: This field contains the group name of the insured's insurance.

(Definition from PM1.8 in Ch. 8)

Definition: This field contains the group name of the insured's insurance.

IN1-10: Insured's Group Emp ID (CX) 00435

Definition: This field holds the group employer ID for the insured's insurance. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN1-11: Insured's Group Emp Name (XON) 00436

Definition: This field contains the name of the employer that provides the employee's insurance. Multiple names for the same employer may be sent in this sequence Specification of meaning based on sequence is deprecated.

IN1-12: Plan Effective Date (DT) 00437

(Definition from IN1.12 in Ch. 6)

Definition: This field contains the date that the insurance goes into effect.

(Definition from PM1.9 in Ch. 8)

Definition: This field contains the date that the insurance goes into effect.

IN1-13: Plan Expiration Date (DT) 00438

(Definition from IN1.13 in Ch. 6)

Definition: This field indicates the last date of service that the insurance will cover or be responsible for.

(Definition from PM1.10 in Ch. 8)

Definition: This field indicates the last date of service that the insurance will cover or be responsible for.

IN1-14: Authorization Information (AUI) 00439

Definition: Based on the type of insurance, some coverage plans require that an authorization number or code be obtained prior to all non-emergency admissions, and within 48 hours of an emergency admission. Insurance billing would not be permitted without this number. The date and source of authorization are the components of this field.

IN1-15: Plan Type (CWE) 00440

Definition: This field contains the coding structure that identifies the various plan types, for example, Medicare, Medicaid, Blue Cross, HMO, etc. Refer to User-defined Table 0086 - Plan ID in Chapter 2C, Code Tables, for suggested values.

IN1-16: Name Of Insured (XPN) 00441

Definition: This field contains the name of the insured person. The insured is the person who has an agreement with the insurance company to provide healthcare services to persons covered by the insurance policy. Multiple names for the same insured person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-17: Insured's Relationship To Patient (CWE) 00442

Definition: This field indicates the insured's relationship to the patient. Refer to User-defined Table 0063 - Relationship in Chapter 2C, Code Tables, for suggested values.

IN1-18: Insured's Date Of Birth (DTM) 00443

Definition: This field contains the date of birth of the insured.

IN1-19: Insured's Address (XAD) 00444

Definition: This field contains the address of the insured person. The insured is the person who has an agreement with the insurance company to provide healthcare services to persons covered by an insurance policy. Multiple addresses for the same insured person may be in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-20: Assignment Of Benefits (CWE) 00445

Definition: This field indicates whether the insured agreed to assign the insurance benefits to the healthcare provider. If so, the insurance will pay the provider directly. Refer to User-defined Table 0135 - Assignment of Benefits in Chapter 2C, Code Tables, for suggested values.

IN1-21: Coordination Of Benefits (CWE) 00446

Definition: This field indicates whether this insurance works in conjunction with other insurance plans, or if it provides independent coverage and payment of benefits regardless of other insurance that might be available to the patient. Refer to User-defined Table 0173 - Coordination of Benefits in Chapter 2C, Code Tables, for suggested values.

IN1-22: Coord Of Ben. Priority (ST) 00447

Definition: If the insurance works in conjunction with other insurance plans, this field contains priority sequence. Values are: 1, 2, 3, etc.

IN1-23: Notice Of Admission Flag (ID) 00448

Definition: This field indicates whether the insurance company requires a written notice of admission from the healthcare provider. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    written notice of admission required

  • N    no notice required

IN1-24: Notice Of Admission Date (DT) 00449

Definition: If a notice is required, this field indicates the date that it was sent.

IN1-25: Report Of Eligibility Flag (ID) 00450

Definition: This field indicates whether this insurance carrier sends a report that indicates that the patient is eligible for benefits and whether it identifies those benefits. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    eligibility report is sent

  • N    no eligibility report is sent

IN1-26: Report Of Eligibility Date (DT) 00451

Definition: This field indicates whether a report of eligibility (ROE) was received, and also indicates the date that it was received.

IN1-27: Release Information Code (CWE) 00452

Definition: This field indicates whether the healthcare provider can release information about the patient, and what information can be released. Refer to User-defined Table 0093 - Release Information in Chapter 2C, Code Tables, for suggested values.

IN1-28: Pre-Admit Cert (ST) 00453

Definition: This field contains the pre-admission certification code. If the admission must be certified before the admission, this is the code associated with the admission.

IN1-29: Verification Date/Time (DTM) 00454

Definition: This field contains the date/time that the healthcare provider verified that the patient has the indicated benefits.

IN1-30: Verification By (XCN) 00455

Definition: Refers to the person who verified the benefits. Multiple names for the same insured person may be sent in this field Specification of meaning based on sequence is deprecated.

IN1-31: Type Of Agreement Code (CWE) 00456

Definition: This field is used to further identify an insurance plan. Refer to User-defined Table 0098 - Type of Agreement in Chapter 2C, Code Tables, for suggested values.

IN1-32: Billing Status (CWE) 00457

Definition: This field indicates whether the particular insurance has been billed and, if so, the type of bill. Refer to User-defined Table 0022 - Billing Status in Chapter 2C, Code Tables, for suggested values.

IN1-33: Lifetime Reserve Days (NM) 00458

Definition: This field contains the number of days left for a certain service to be provided or covered under an insurance policy.

IN1-34: Delay Before L.R. Day (NM) 00459

Definition: This field indicates the delay before lifetime reserve days.

IN1-35: Company Plan Code (CWE) 00460

Definition: This field contains optional information to further define the data in IN1-3 - Insurance Company ID. Refer to User-defined Table 0042 - Company Plan Code in Chapter 2C, Code Tables, for suggested values. This table contains codes used to identify an insurance company plan uniquely.

IN1-36: Policy Number (ST) 00461

Definition: This field contains the individual policy number of the insured to uniquely identify this patient's plan. For special types of insurance numbers, there are also special fields in the IN2 segment for Medicaid, Medicare, Champus (i.e., IN2-6 - Medicare Health Ins Card Number, IN2-8 - Medicaid Case Number, IN2-10 - Military ID Number). But we recommend that this field (IN1-36 - Policy Number) be filled even when the patient's insurance number is also passed in one of these other fields.

IN1-37: Policy Deductible (CP) 00462

Definition: This field contains the amount specified by the insurance plan that is the responsibility of the guarantor (i.e., deductible, excess, etc.).

IN1-38: Policy Limit - Amount

Attention: IN1-38 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

IN1-39: Policy Limit - Days (NM) 00464

Definition: This field contains the maximum number of days that the insurance policy will cover.

IN1-40: Room Rate - Semi-Private

Attention: IN1-40 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

IN1-41: Room Rate - Private

Attention: IN1-41 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

IN1-42: Insured's Employment Status (CWE) 00467

Definition: This field holds the employment status of the insured. Refer to User-defined Table 0066 - Employment Status in Chapter 2C, Code Tables, for suggested values. This field contains UB92 field 64. For this field element, values from the US CMS UB92 and others are used.

IN1-43: Insured's Administrative Sex (CWE) 00468

Definition: This field contains the gender of the insured. Refer to User-defined Table 0001 - Administrative Sex in Chapter 2C, Code Tables, for suggested values.

IN1-44: Insured's Employer's Address (XAD) 00469

Definition: This field contains the address of the insured employee's employer. Multiple addresses for the same employer may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN1-45: Verification Status (ST) 00470

Definition: This field contains the status of this patient's relationship with this insurance carrier.

IN1-46: Prior Insurance Plan ID (CWE) 00471

Definition: This field uniquely identifies the prior insurance plan when the plan ID changes. Refer to User-defined Table 0072 - Insurance Plan ID in Chapter 2C, Code Tables, for suggested values.

IN1-47: Coverage Type (CWE) 01227

Definition: This field contains the coding structure that identifies the type of insurance coverage, or what types of services are covered for the purposes of a billing system. For example, a physician billing system will only want to receive insurance information for plans that cover physician/professional charges. Refer to User-defined Table 0309 - Coverage Type in Chapter 2C, Code Tables, for suggested values.

IN1-48: Handicap (CWE) 00753

(Definition from NK1.36 in Ch. 3)

Definition: This field contains the code that describes an associated party's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.6 in Ch. 3)

Definition: This field indicates the nature of the patient's permanent handicapped condition (e.g., deaf, blind). A handicapped condition is defined as a physical or mental disability that is permanent. Transient handicapped conditions should be sent in the ambulatory status. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.52 in Ch. 6)

Definition: This field contains a code to describe the guarantor's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

(Definition from IN1.48 in Ch. 6)

Definition: This field contains a code to describe the insured's disability. Refer to User-defined Table 0295 - Handicap in Chapter 2C, Code Tables, for suggested values.

IN1-49: Insured's ID Number (CX) 01230

Definition: This data element contains a healthcare institution's identifiers for the insured. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN1-50: Signature Code (CWE) 01854

Definition: This field contains the code to indicate how the patient/subscriber authorization signature was obtained and how it is being retained by the provider. Refer to User-defined Table 0535 - Signature Code in Chapter 2C, Code Tables, for suggested values.

IN1-51: Signature Code Date (DT) 01855

Definition: The date the patient/subscriber authorization signature was obtained.

IN1-52: Insured's Birth Place (ST) 01899

Definition: This field contains the description of the insured's birth place, for example "St. Francis Community Hospital of Lower South Side." The actual address is reported in IN1-19 – Insured's Address with an identifier of "N".

IN1-53: VIP Indicator (CWE) 01852

Definition: This field identifies the type of VIP for the insured. Refer to User-defined Table 0099 – VIP Indicator in Chapter 2C, Code Tables, for suggested values.

IN1-54: External Health Plan Identifiers (CX) 03292

Definition: This field contains the external Health Plan Identifiers that correspond to the internal Health Plan ID in IN1-2 – Health Plan ID. The assigning authority and identifier type code are strongly recommended for al CX data types.

IN1-55: Insurance Action Code (ID) 03335

Definition: The Insurance Action Code Defines the action to be taken for this insurance. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values. When this field is valued, the IN1, IN2, and IN3 are not in "snapshot mode", rather in "action mode".

IN2 - Insurance Additional Information Segment

The IN2 segment contains additional insurance policy coverage and benefit information necessary for proper billing and reimbursement. Fields used by this segment are defined by CMS or other regulatory agencies.

HL7 Attribute Table - IN2 - Insurance Additional Information Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
IN2
1 00472 Insured's Employee ID [0..*] CX
2 00473 Insured's Social Security Number = [0..1] 11 ST
3 00474 Insured's Employer's Name and ID [0..*] XCN
4 00475 Employer Information Data [0..1] CWE
5 00476 Mail Claim Party [0..*] CWE
6 00477 Medicare Health Ins Card Number = [0..1] 15 ST
7 00478 Medicaid Case Name [0..*] XPN
8 00479 Medicaid Case Number = [0..1] 15 ST
9 00480 Military Sponsor Name [0..*] XPN
10 00481 Military ID Number = [0..1] 20 ST
11 00482 Dependent Of Military Recipient [0..1] CWE
12 00483 Military Organization = [0..1] 25 ST
13 00484 Military Station = [0..1] 25 ST
14 00485 Military Service [0..1] CWE
15 00486 Military Rank/Grade [0..1] CWE
16 00487 Military Status [0..1] CWE
17 00488 Military Retire Date [0..1] DT
18 00489 Military Non-Avail Cert On File [0..1] [1..1] ID
19 00490 Baby Coverage [0..1] [1..1] ID
20 00491 Combine Baby Bill [0..1] [1..1] ID
21 00492 Blood Deductible = [0..1] 1 ST
22 00493 Special Coverage Approval Name [0..*] XPN
23 00494 Special Coverage Approval Title # [0..1] 30 ST
24 00495 Non-Covered Insurance Code [0..*] CWE
25 00496 Payor ID [0..*] CX
26 00497 Payor Subscriber ID [0..*] CX
27 00498 Eligibility Source [0..1] CWE
28 00499 Room Coverage Type/Amount [0..*] RMC
29 00500 Policy Type/Amount [0..*] PTA
30 00501 Daily Deductible [0..1] DDI
31 00755 Living Dependency [0..1] CWE
32 00145 Ambulatory Status [0..*] CWE
33 00129 Citizenship [0..*] CWE
34 00118 Primary Language [0..1] CWE
35 00742 Living Arrangement [0..1] CWE
36 00743 Publicity Code [0..1] CWE
37 00744 Protection Indicator [0..1] [1..1] ID
38 00745 Student Indicator [0..1] CWE
39 00120 Religion [0..1] CWE
40 00109 Mother's Maiden Name [0..*] XPN
41 00739 Nationality [0..1] CWE
42 00125 Ethnic Group [0..*] CWE
43 00119 Marital Status [0..*] CWE
44 00787 Insured's Employment Start Date [0..1] DT
45 00783 Employment Stop Date [0..1] DT
46 00785 Job Title # [0..1] 20 ST
47 00786 Job Code/Class [0..1] JCC
48 00752 Job Status [0..1] CWE
49 00789 Employer Contact Person Name [0..*] XPN
50 00790 Employer Contact Person Phone Number [0..*] XTN
51 00791 Employer Contact Reason [0..1] CWE
52 00792 Insured's Contact Person's Name [0..*] XPN
53 00793 Insured's Contact Person Phone Number [0..*] XTN
54 00794 Insured's Contact Person Reason [0..*] CWE
55 00795 Relationship to the Patient Start Date [0..1] DT
56 00796 Relationship to the Patient Stop Date [0..*] DT
57 00797 Insurance Co Contact Reason [0..1] CWE
58 00798 Insurance Co Contact Phone Number [0..*] XTN
59 00799 Policy Scope [0..1] CWE
60 00800 Policy Source [0..1] CWE
61 00801 Patient Member Number [0..1] CX
62 00802 Guarantor's Relationship to Insured [0..1] CWE
63 00803 Insured's Phone Number - Home [0..*] XTN
64 00804 Insured's Employer Phone Number [0..*] XTN
65 00805 Military Handicapped Program [0..1] CWE
66 00806 Suspend Flag [0..1] [1..1] ID
67 00807 Copay Limit Flag [0..1] [1..1] ID
68 00808 Stoploss Limit Flag [0..1] [1..1] ID
69 00809 Insured Organization Name and ID [0..*] XON
70 00810 Insured Employer Organization Name and ID [0..*] XON
71 00113 Race [0..*] CWE
72 00811 Patient's Relationship to Insured [0..1] CWE
73 01620 Co-Pay Amount [0..1] CP

IN2-1: Insured's Employee ID (CX) 00472

Definition: This field contains the employee ID of the insured. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN2-2: Insured's Social Security Number (ST) 00473

Definition: This field contains the social security number of the insured.

IN2-3: Insured's Employer's Name and ID (XCN) 00474

Definition: This field contains the name and ID of the insured's employer or the person who purchased the insurance for the insured, if the employer is a person. Multiple names and identifiers for the same person may be sent in this field, not multiple persons Specification of meaning based on sequence is deprecated. When the employer is an organization use IN2-70 - Insured Employer Organization Name and ID.

IN2-4: Employer Information Data (CWE) 00475

Definition: This field contains the required employer information data for UB82 form locator 71. Refer to User-defined Table 0139 - Employer Information Data in Chapter 2C, Code Tables, for suggested values.

IN2-5: Mail Claim Party (CWE) 00476

Definition: This field contains the party to which the claim should be mailed. Refer to User-defined Table 0137 - Mail Claim Party in Chapter 2C, Code Tables, for suggested values.

IN2-6: Medicare Health Ins Card Number (ST) 00477

Definition: This field contains the Medicare Health Insurance Number (HIN), defined by CMS or other regulatory agencies.

IN2-7: Medicaid Case Name (XPN) 00478

Definition: This field contains the Medicaid case name, defined by CMS or other regulatory agencies. Multiple names for the same person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-8: Medicaid Case Number (ST) 00479

Definition: This field contains the Medicaid case number, defined by CMS or other regulatory agencies, which uniquely identifies a patient's Medicaid policy.

IN2-9: Military Sponsor Name (XPN) 00480

Definition: This field is defined by CMS or other regulatory agencies. Multiple names for the same person may be sent in this field. Specification of meaning based on sequence is deprecated.

IN2-10: Military ID Number (ST) 00481

Definition: This field contains the military ID number, defined by CMS or other regulatory agencies, which uniquely identifies a patient's military policy.

IN2-11: Dependent Of Military Recipient (CWE) 00482

Definition: This field is defined by CMS or other regulatory agencies. Refer to User-defined Table 0342 - Military Recipient in Chapter 2C, Code Tables, for suggested values.

IN2-12: Military Organization (ST) 00483

Definition: This field is defined by CMS or other regulatory agencies.

IN2-13: Military Station (ST) 00484

Definition: This field is defined by CMS or other regulatory agencies.

IN2-14: Military Service (CWE) 00485

Definition: This field is defined by CMS or other regulatory agencies and refers to the military branch of service. Refer to User-defined Table 0140 - Military Service in Chapter 2C, Code Tables, for suggested values. The UB codes listed may not represent a complete list; refer to a UB specification for additional information.

IN2-15: Military Rank/Grade (CWE) 00486

(Definition from PD1.20 in Ch. 3)

Definition: This user-defined field identifies the military rank/grade of the patient. Refer to User-defined Table 0141 - Military Rank/Grade in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.15 in Ch. 6)

Definition: This user-defined field identifies the military rank/grade of the insured. Refer to User-defined Table 0141 - Military Rank/Grade in Chapter 2C, Code Tables, for suggested values.

IN2-16: Military Status (CWE) 00487

Definition: This field is defined by CMS or other regulatory agencies. Refer to User-defined Table 0142 - Military Status in Chapter 2C, Code Tables, for suggested values. The UB codes listed may not represent a complete list; refer to a UB specification for additional information

IN2-17: Military Retire Date (DT) 00488

Definition: This field is defined by CMS or other regulatory agencies.

IN2-18: Military Non-Avail Cert On File (ID) 00489

Definition: Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Certification on file

  • N    Certification not on file

IN2-19: Baby Coverage (ID) 00490

Definition: Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Baby coverage

  • N    No baby coverage

IN2-20: Combine Baby Bill (ID) 00491

Definition: Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Combine bill

  • N    Normal billing

IN2-21: Blood Deductible (ST) 00492

Definition: Use this field instead of UB1-2 - Blood Deductible, as the blood deductible can be associated with the specific insurance plan via this field.

IN2-22: Special Coverage Approval Name (XPN) 00493

Definition: This field contains the name of the individual who approves any special coverage. Multiple names for the same person may be sent in this field. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-23: Special Coverage Approval Title (ST) 00494

Definition: This field contains the title of the person who approves special coverage.

IN2-24: Non-Covered Insurance Code (CWE) 00495

Definition: This field contains the code that describes why a service is not covered. Refer to User-defined Table 0143 - Non-covered Insurance Code in Chapter 2C, Code Tables, for suggested values.

IN2-25: Payor ID (CX) 00496

Definition: In the US this field is required for ENVOY Corporation (a US claims clearing house) processing, and it identifies the organization from which reimbursement is expected. This field can also be used to report the National Health Plan ID. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN2-26: Payor Subscriber ID (CX) 00497

Definition: In the US this field is required for ENVOY Corporation processing, and it identifies the specific office within the insurance carrier that is designated as responsible for the claim. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN2-27: Eligibility Source (CWE) 00498

Definition: In the US this field is required for ENVOY Corporation processing, and it identifies the source of information about the insured's eligibility for benefits. Refer to User-defined Table 0144 - Eligibility Source in Chapter 2C, Code Tables, for suggested values.

IN2-28: Room Coverage Type/Amount (RMC) 00499

Definition: Use this field instead of IN1-40 - Room Rate - Semi-Private and IN1-41 - Room Rate - Private. This field contains room type (e.g., private, semi-private), amount type (e.g., limit, percentage) and amount covered by the insurance.

IN2-29: Policy Type/Amount (PTA) 00500

Definition: This field contains the policy type (e.g., ancillary, major medical) and amount (e.g., amount, percentage, limit) covered by the insurance. Use this field instead of IN1-38 - Policy Limit - Amount.

IN2-30: Daily Deductible (DDI) 00501

Definition: This field contains the number of days after which the daily deductible begins, the amount of the deductible, and the number of days to apply the deductible.

If "number of days" is not valued, the deductible is ongoing.

IN2-31: Living Dependency (CWE) 00755

(Definition from NK1.17 in Ch. 3)

Definition: This field identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. Examples might include Spouse Dependent, Medical Supervision Required, Small Children Dependent. This field repeats because, for example, "spouse dependent" and "medical supervision required" can apply at the same time. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.1 in Ch. 3)

Definition: This field identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. This field repeats because, for example, "spouse dependent" and "medical supervision required" can apply at the same time. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.33 in Ch. 6)

Definition: Identifies the specific living conditions of the guarantor. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.31 in Ch. 6)

Definition: This field identifies the specific living conditions for the insured. Refer to User-defined Table 0223 - Living Dependency in Chapter 2C, Code Tables, for suggested values.

IN2-32: Ambulatory Status (CWE) 00145

(Definition from PV1.15 in Ch. 3)

Definition: This field indicates any permanent or transient handicapped conditions. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested entries.

(Definition from NK1.18 in Ch. 3)

Definition: This field identifies the transient rate of mobility for the next of kin/associated party. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables for suggested values.

(Definition from GT1.34 in Ch. 6)

Definition: Identifies the transient state of mobility for the guarantor. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.32 in Ch. 6)

Definition: This field identifies the insured's state of mobility. Refer to User-defined Table 0009 - Ambulatory Status in Chapter 2C, Code Tables, for suggested values.

IN2-33: Citizenship (CWE) 00129

(Definition from PID.26 in Ch. 3)

This field contains the information related to a person's country citizenship. For country citizenship HL7 recommends using ISO table 3166. For a local definition, User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables, should be used.

This field repeats since persons can be citizens of more than one country. The Name of Coding System component(s) of the CWE datatype should be used to identify the table from which citizenship membership is drawn.

In the Netherlands, this field is used for "Nationaliteit".

(Definition from NK1.19 in Ch. 3)

Definition: This field contains the code to identify the next of kin/associated party's citizenship. HL7 recommends using ISO 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from GT1.35 in Ch. 6)

Definition: This field contains the code to identify the guarantor's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from IN2.33 in Ch. 6)

Definition: This field contains the code that identifies the insured's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship defined in Chapter 2C, Code Tables.

(Definition from STF.30 in Ch. 15)

Definition: This field contains the staff person's current country of citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship (in Chapter 2C, Code Tables).

IN2-34: Primary Language (CWE) 00118

(Definition from PID.15 in Ch. 3)

Definition: This field contains the patient's primary language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language within Chapter 2C, Code Tables.

(Definition from NK1.20 in Ch. 3)

Definition: This field identifies the next of kin/associated party's primary speaking language. HL7 recommends using ISO 639 as the suggested values in User-defined Table 0296 - Language in Chapter 2C, Code Tables.

(Definition from GT1.36 in Ch. 6)

Definition: This field identifies the guarantor's primary speaking language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language defined in Chapter 2C, Code Tables.

(Definition from IN2.34 in Ch. 6)

Definition: This field identifies the insured's primary speaking language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language defined in Chapter 2C, Code Tables.

IN2-35: Living Arrangement (CWE) 00742

(Definition from NK1.21 in Ch. 3)

Definition: This field identifies the situation that the associated party lives in at his/her residential address. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.2 in Ch. 3)

Definition: This field identifies the situation in which the patient lives at his residential address. Examples might include Alone, Family, Relatives, Institution, etc. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.37 in Ch. 6)

Definition: This field identifies the situation in which the person lives at his residential address. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.35 in Ch. 6)

Definition: This field indicates the situation in which the insured person lives at his primary residence. Refer to User-defined Table 0220 - Living Arrangement in Chapter 2C, Code Tables, for suggested values.

IN2-36: Publicity Code (CWE) 00743

(Definition from NK1.22 in Ch. 3)

Definition: This field indicates what level of publicity is allowed (e.g., No Publicity, Family Only) for the next of kin/associated party. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

(Definition from PD1.11 in Ch. 3)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for the patient. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values. Refer to PV2-21 - Visit Publicity Code for visit level code.

(Definition from GT1.38 in Ch. 6)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for a guarantor. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.36 in Ch. 6)

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for the insured. Refer to User-defined Table 0215 - Publicity Code in Chapter 2C, Code Tables, for suggested values.

IN2-37: Protection Indicator (ID) 00744

(Definition from NK1.23 in Ch. 3)

Definition: This field identifies that next of kin/associated party's protection that determines, in turn, whether access to information about this person should be kept from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/No Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    protect access to next-of-kin information

  • N    normal access

(Definition from PD1.12 in Ch. 3)

Definition: From V2.6 onward, this field has been retained for backward compatibility only. Use the ARV segment instead. This field identifies the patient's protection that determines, in turn, whether access to information about this person should be kept from users who do not have adequate authority for the patient. Refer to HL7 Table 0136 - Yes/No Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    protect access to information

  • N    normal access

Refer to PV2-22 - Visit Protection Indicator for visit level code.

(Definition from GT1.39 in Ch. 6)

Definition: This field identifies the guarantor's protection, which determines whether or not access to information about this enrollee should be restricted from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    restrict access

  • N    do not restrict access

(Definition from IN2.37 in Ch. 6)

Definition: This field identifies the insured's protection, which determines whether or not access to information about this enrollee should be restricted from users who do not have adequate authority. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Restrict access

  • N    Do not restrict access

IN2-38: Student Indicator (CWE) 00745

(Definition from NK1.24 in Ch. 3)

Definition: This field identifies whether the next of kin/associated party is currently a student or not, and whether the next of kin/associated party is a full- or a part-time student. This field does not indicate the degree (high school, college) of the student or the field of study. Refer to User-defined Table 0231 - Student Status in chapter 2C, for suggested values.

(Definition from PD1.5 in Ch. 3)

Definition: This field indicates if the patient is currently a student or not, and whether the patient is a full-time or a part-time student. This field does not indicate the student's degree level (high school, college, elementary) or the student's field of study (accounting, engineering, etc.). Refer to User-defined Table 0231 - Student Status in chapter 2C, for suggested values.

(Definition from GT1.40 in Ch. 6)

Definition: This field indicates whether the guarantor is currently a student, and whether the guarantor is a full-time or part-time student. This field does not indicate the degree level (high school, college) of the student, or his/her field of study (accounting, engineering, etc.). Refer to User-defined Table 0231- Student Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.38 in Ch. 6)

Definition: This field identifies whether the insured is currently a student or not, and whether the insured is a full-time or a part-time student. This field does not indicate the degree level (high school, college) of student, or his/her field of study (accounting, engineering, etc.). Refer to User-defined Table 0231 - Student Status in Chapter 2C, Code Tables, for suggested values.

IN2-39: Religion (CWE) 00120

(Definition from PID.17 in Ch. 3)

Definition: This field contains the patient's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.25 in Ch. 3)

Definition: This field indicates the type of religion practiced by the next of kin/associated party. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.41 in Ch. 6)

Definition: This field indicates the type of religion practiced by the guarantor. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.39 in Ch. 6)

Definition: This field indicates the type of religion practiced by the insured. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.40 in Ch. 15)

Definition: This field contains the staff member's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

IN2-40: Mother's Maiden Name (XPN) 00109

(Definition from PID.6 in Ch. 3)

Definition: This field contains the family name under which the mother was born (i.e., before marriage). It is used to distinguish between patients with the same last name.

(Definition from NK1.26 in Ch. 3)

Definition: This field indicates the maiden name of the next of kin/associated party's mother.

(Definition from GT1.42 in Ch. 6)

Definition: This field indicates the guarantor's mother's maiden name.

(Definition from IN2.40 in Ch. 6)

Definition: This field indicates the insured's mother's maiden name.

IN2-41: Nationality (CWE) 00739

(Definition from PID.28 in Ch. 3)

Attention: The PID-28 field was retained for backward compatibility only as of v 2.4 and was withdrawn and removed from this message structure as of v 2.7. It is recommended to refer to PID-10 - Race, PID-22 - Ethnic group and PID-26 - Citizenship.

(Definition from NK1.27 in Ch. 3)

Definition: This field identifies the nation or national group to which the next of kin/associated party belongs. This information may be different than the person's citizenship in countries in which multiple nationalities are recognized (e.g., Spain: Basque, Catalan, etc.). Refer to User-defined Table 0212 - Nationality in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.43 in Ch. 6)

Definition: This field contains a code that identifies the nation or national grouping to which the person belongs. This may be different from a person's citizenship in countries in which multiple nationalities are recognized (for example, Spain: Basque, Catalan, etc.). HL7 recommends using ISO table 3166 as suggested values in User-defined Table 0212 - Nationality in Chapter 2C, Code Tables.

(Definition from IN2.41 in Ch. 6)

Definition: This field contains a code that identifies the nation or national grouping to which the insured person belongs. This information may be different from a person's citizenship in countries in which multiple nationalities are recognized (for example, Spain: Basque, Catalan, etc.). HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0212 - Nationality in Chapter 2C, Code Tables.

IN2-42: Ethnic Group (CWE) 00125

(Definition from PID.22 in Ch. 3)

Definition: This field further defines the patient's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from NK1.28 in Ch. 3)

Definition: This field contains the next of kin/associated party's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from GT1.44 in Ch. 6)

Definition: This field contains the guarantor's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from IN2.42 in Ch. 6)

Definition: This field indicates the insured's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from STF.28 in Ch. 15)

  • Definition: This field further defines the person's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second couplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the United States, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

IN2-43: Marital Status (CWE) 00119

(Definition from PID.16 in Ch. 3)

Definition: This field contains the patient's marital (civil) status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.14 in Ch. 3)

Definition: This field contains the next of kin/associated party's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.43 in Ch. 6)

Definition: This field contains the insured's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.17 in Ch. 15)

Definition: This field contains the staff member's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values. Same values as those for PID-16 Marital Status.

IN2-44: Insured's Employment Start Date (DT) 00787

Definition: This field indicates the date on which the insured's employment with a particular employer began.

IN2-45: Employment Stop Date (DT) 00783

(Definition from GT1.32 in Ch. 6)

Definition: This field indicates the date on which the guarantor's employment with a particular employer ended.

(Definition from IN2.45 in Ch. 6)

Definition: This field indicates the date on which the person's employment with a particular employer ended.

IN2-46: Job Title (ST) 00785

(Definition from GT1.49 in Ch. 6)

Definition: This field contains a descriptive name of the guarantor's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

(Definition from IN2.46 in Ch. 6)

Definition: This field contains a descriptive name for the insured's occupation (for example, Sr. Systems Analyst, Sr. Accountant).

(Definition from STF.18 in Ch. 15)

Definition: This field contains a descriptive name of the staff member's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

IN2-47: Job Code/Class (JCC) 00786

(Definition from GT1.50 in Ch. 6)

Definition: This field contains the guarantor's job code and employee classification.

(Definition from IN2.47 in Ch. 6)

Definition: This field indicates a code that identifies the insured's job code (for example, programmer, analyst, doctor, etc.).

(Definition from STF.19 in Ch. 15)

Definition: This field contains the staff member's job code and employee classification. Refer to User-defined Table 0327 - Job Code and User-defined Table 0328 - Employee Classification in Chapter 2C, Code Tables, for suggested values.

IN2-48: Job Status (CWE) 00752

(Definition from NK1.34 in Ch. 3)

Definition: This field identifies the next of kin/associated party's job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.53 in Ch. 6)

Definition: This field contains a code that identifies the guarantor's current job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.48 in Ch. 6)

Definition: This field indicates a code that identifies the insured's current job status. Refer to User-defined Table 0311 - Job Status in Chapter 2C, Code Tables, for suggested values.

IN2-49: Employer Contact Person Name (XPN) 00789

Definition: This field contains the name of the contact person that should be contacted at the insured's place of employment. (Joe Smith is the insured. He works at GTE. Contact Sue Jones at GTE regarding Joe Smith's policy). Multiple names for the same person may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-50: Employer Contact Person Phone Number (XTN) 00790

Definition: This field contains the telecommunications contact for the employer contact person. Multiple phone numbers for the same contact person may be sent in this sequence, not multiple contacts. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-51: Employer Contact Reason (CWE) 00791

Definition: Definition: This field contains the reason(s) that employer contact person should be contacted on behalf of the employee. Refer to User-defined Table 0222 - Contact Reason in Chapter 2C, Code Tables, for suggested values.

IN2-52: Insured's Contact Person's Name (XPN) 00792

Definition: This field contains the contact person for the insured.

IN2-53: Insured's Contact Person Phone Number (XTN) 00793

Definition: This field contains the telephone number for the contact person for the insured. Multiple phone numbers for the same person may be sent in this contact, not multiple contacts. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-54: Insured's Contact Person Reason (CWE) 00794

Definition: This field contains the reason(s) the person should be contacted regarding the insured. Refer to User-defined Table 0222 - Contact Reason in Chapter 2C, Code Tables, for suggested values

IN2-55: Relationship to the Patient Start Date (DT) 00795

Definition: This field indicates the date on which the insured's patient relationship (defined in IN1-17 - Insured's Relationship to Patient) became effective (began).

IN2-56: Relationship to the Patient Stop Date (DT) 00796

Definition: This field indicates the date after which the relationship (defined in IN1-17 - Insured's Relationship to Patient) is no longer effective.

IN2-57: Insurance Co Contact Reason (CWE) 00797

Definition: This field contains a user-defined code that specifies how the contact should be used. Refer to User-defined Table 0232 - Insurance Company Contact Reason in Chapter 2C, Code Tables, for suggested values.

IN2-58: Insurance Co Contact Phone Number (XTN) 00798

Definition: This field contains the telephone number of the person who should be contacted at the insurance company for questions regarding an insurance policy/claim, etc. Multiple phone numbers for the insurance company may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-59: Policy Scope (CWE) 00799

Definition: This field contains a user-defined code designating the extent of the coverage for a participating member (e.g., "single," "family," etc). Refer to User-defined Table 0312 - Policy Scope in Chapter 2C, Code Tables, for suggested values.

IN2-60: Policy Source (CWE) 00800

Definition: This user-defined field identifies how the policy information got established. Refer to User-defined Table 0313 - Policy Source in Chapter 2C, Code Tables, for suggested values.

IN2-61: Patient Member Number (CX) 00801

Definition: This field contains an identifying number assigned by the payor for each individual covered by the insurance policy issued to the insured. For example, each individual family member may have a different member number from the insurance policy number issued to the head of household. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN2-62: Guarantor's Relationship to Insured (CWE) 00802

Definition: This field specifies the relationship of the guarantor to the insurance subscriber. Refer to User-defined Table 0063 - Relationship in Chapter 2C, Code Tables, for suggested values.

IN2-63: Insured's Phone Number - Home (XTN) 00803

Definition: The value of this field represents the insured's telephone number. Multiple phone numbers may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-64: Insured's Employer Phone Number (XTN) 00804

Definition: The value of this field represents the insured's employer's telephone number. Multiple phone numbers may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN2-65: Military Handicapped Program (CWE) 00805

Definition: This field indicates the military program for the handicapped in which the patient is enrolled. Refer to User-defined Table 0343 - Military Handicapped Program Code in Chapter 2C, Code Tables, for suggested values.

IN2-66: Suspend Flag (ID) 00806

Definition: This field indicates whether charges should be suspended for a patient. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    charges should be suspended

  • N    charges should NOT be suspended

IN2-67: Copay Limit Flag (ID) 00807

Definition: This field indicates if the patient has reached the co-pay limit so that no more co-pay charges should be calculated for the patient. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the patient is at or exceeds the co-pay limit

  • N    the patient is under the co-pay limit

IN2-68: Stoploss Limit Flag (ID) 00808

Definition: This field indicates if the patient has reached the stoploss limit established in the Contract Master. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the patient has reached the stoploss limit

  • N    the patient has not reached the stoploss limit

IN2-69: Insured Organization Name and ID (XON) 00809

Definition: This field indicates the name of the insured if the insured/subscriber is an organization. Multiple names for the insured may be sent in this sequence, not multiple insured people Specification of meaning based on sequence is deprecated.

IN2-70: Insured Employer Organization Name and ID (XON) 00810

Definition: This field indicates the name of the insured's employer, or the organization that purchased the insurance for the insured, if the employer is an organization. Multiple names and identifiers for the same organization may be sent in this field, not multiple organizations. Specification of meaning based on sequence is deprecated.

IN2-71: Race (CWE) 00113

(Definition from PID.10 in Ch. 3)

Definition: This field refers to the patient's race. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from NK1.35 in Ch. 3)

Definition: This field identifies the race of the next of kin/associated party. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from IN2.71 in Ch. 6)

Definition: Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from STF.27 in Ch. 15)

Definition: This field refers to the person's race. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

IN2-72: Patient's Relationship to Insured (CWE) 00811

Definition: This field indicates the relationship of the patient to the insured, as defined by CMS or other regulatory agencies. Refer to User-defined Table 0344 - Patient's Relationship to Insured in Chapter 2C, Code Tables, for suggested values. The UB codes listed may not represent a complete list; refer to a UB specification for additional information.

IN2-73: Co-Pay Amount (CP) 01620

(Definition from IN2.73 in Ch. 6)

Definition: This field contains the patient's Co-pay amount for visit.

(Definition from GP2.13 in Ch. 6)

Definition: This field contains the patient's Co-pay amount for the line item.

IN3 - Insurance Additional Information, Certification Segment

The IN3 segment contains additional insurance information for certifying the need for patient care. Fields used by this segment are defined by CMS, or other regulatory agencies.

HL7 Attribute Table - IN3 - Insurance Additional Information, Certification Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
IN3
1 00502 Set ID - IN3 SHALL [1..1] [1..4] SI
2 00503 Certification Number [0..1] CX
3 00504 Certified By [0..*] XCN
4 00505 Certification Required [0..1] [1..1] ID
5 00506 Penalty [0..1] MOP
6 00507 Certification Date/Time [0..1] DTM
7 00508 Certification Modify Date/Time [0..1] DTM
8 00509 Operator [0..*] XCN
9 00510 Certification Begin Date [0..1] DT
10 00511 Certification End Date [0..1] DT
11 00512 Days [0..1] DTN
12 00513 Non-Concur Code/Description [0..1] CWE
13 00514 Non-Concur Effective Date/Time [0..1] DTM
14 00515 Physician Reviewer [0..*] XCN
15 00516 Certification Contact # [0..1] 48 ST
16 00517 Certification Contact Phone Number [0..*] XTN
17 00518 Appeal Reason [0..1] CWE
18 00519 Certification Agency [0..1] CWE
19 00520 Certification Agency Phone Number [0..*] XTN
20 00521 Pre-Certification Requirement [0..*] ICD
21 00522 Case Manager # [0..1] 48 ST
22 00523 Second Opinion Date [0..1] DT
23 00524 Second Opinion Status [0..1] CWE
24 00525 Second Opinion Documentation Received [0..*] CWE
25 00526 Second Opinion Physician [0..*] XCN
26 03336 Certification Type [0..1] CWE
27 03337 Certification Category [0..1] CWE
28 02483 Online Verification Date/Time [0..1] DTM
29

02484 Online Verification Result MAY
True:
False:
C(R/X)
[1..1]
[0..1]
CWE
30

02485 Online Verification Result Error Code MAY
True:
False:
C(RE/X)
[1..1]
[0..1]
CWE
31 02486 Online Verification Result Check Digit MAY
True:
False:
C(R/X)
[1..1]
[0..1]
ST

IN3-1: Set ID - IN3 (SI) 00502

Definition: IN3-1 - Set ID - IN3 contains the number that identifies this transaction. For the first occurrence of the segment the sequence number shall be 1, for the second occurrence it shall be 2, etc. The set ID in the IN3 segment is used when there are multiple certifications for the insurance plan identified in IN1-2.

IN3-2: Certification Number (CX) 00503

Definition: This field contains the number assigned by the certification agency. The assigning authority and identifier type code are strongly recommended for all CX data types.

IN3-3: Certified By (XCN) 00504

Definition: This field contains the party that approved the certification. Multiple names and identifiers for the same person may be sent in this sequence Specification of meaning based on sequence is deprecated.

IN3-4: Certification Required (ID) 00505

Definition: This field indicates whether certification is required. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    certification required

  • N    certification not required

IN3-5: Penalty (MOP) 00506

Definition: This field contains the penalty, in dollars or a percentage that will be assessed if the pre-certification is not performed.

IN3-6: Certification Date/Time (DTM) 00507

Definition: This field contains the date and time stamp that indicates when insurance was certified to exist for the patient.

IN3-7: Certification Modify Date/Time (DTM) 00508

Definition: This field contains the date/time that the certification was modified.

IN3-8: Operator (XCN) 00509

Definition: This field contains the name party who is responsible for sending this certification information. Multiple names for the same person may be sent in this sequence. Specification of meaning based on sequence is deprecated.

IN3-9: Certification Begin Date (DT) 00510

Definition: This field contains the date that this certification begins.

IN3-10: Certification End Date (DT) 00511

Definition: This field contains date that this certification ends.

IN3-11: Days (DTN) 00512

Definition: This field contains the number of days for which this certification is valid. This field applies to denied, pending, or approved days.

IN3-12: Non-Concur Code/Description (CWE) 00513

Definition: This field contains the non-concur code and description for a denied request. Refer to User-defined Table 0233 - Non-Concur Code/Description in Chapter 2C, Code Tables, for suggested values.

IN3-13: Non-Concur Effective Date/Time (DTM) 00514

Definition: This field contains the effective date of the non-concurrence classification.

IN3-14: Physician Reviewer (XCN) 00515

Definition: This field contains the physician who works with and reviews cases that are pending physician review for the certification agency. Multiple names for the same person may be sent in this sequence. Specification of meaning based on sequence is deprecated. Refer to User-defined Table 0010 - Physician ID in Chapter 2C, Code Tables, for suggested values.

IN3-15: Certification Contact (ST) 00516

Definition: This field contains the name of the party contacted at the certification agency who granted the certification and communicated the certification number.

IN3-16: Certification Contact Phone Number (XTN) 00517

Definition: This field contains the phone number of the certification contact. Multiple phone numbers for the same certification contact may be sent in this sequence. As of v 2.7, no assumptions can be made based on position or sequence. Specification of meaning based on sequence is deprecated.

IN3-17: Appeal Reason (CWE) 00518

Definition: This field contains the reason that an appeal was made on a non-concur for certification. Refer to User-defined Table 0345 - Appeal Reason in Chapter 2C, Code Tables, for suggested values.

IN3-18: Certification Agency (CWE) 00519

Definition: This field contains the certification agency. Refer to User-defined Table 0346 - Certification Agency in Chapter 2C, Code Tables, for suggested values.

IN3-19: Certification Agency Phone Number (XTN) 00520

Definition: This field contains the phone number of the certification agency.

IN3-20: Pre-Certification Requirement (ICD) 00521

Definition: This field indicates whether pre-certification is required for particular patient types, and the time window for obtaining the certification. The following components of this field are defined as follows:

  • pre-certification required refers to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    pre-certification required

  • N    no pre-certification required

  • pre-certification window is the date/time by which the pre-certification must be obtained.

IN3-21: Case Manager (ST) 00522

Definition: This field contains the name of the entity, which is handling this particular patient's case (e.g., UR nurse, or a specific healthcare facility location).

IN3-22: Second Opinion Date (DT) 00523

Definition: This field contains the date that the second opinion was obtained.

IN3-23: Second Opinion Status (CWE) 00524

Definition: This field contains the code that represents the status of the second opinion. Refer to User-defined Table 0151 - Second Opinion Status in Chapter 2C, Code Tables, for suggested values.

IN3-24: Second Opinion Documentation Received (CWE) 00525

Definition: Use this field if accompanying documentation has been received by the provider. Refer to User-defined Table 0152 - Second Opinion Documentation Receivedin Chapter 2C, Code Tables,for suggested values.

IN3-25: Second Opinion Physician (XCN) 00526

Definition: This field contains an identifier and name of the physician who provided the second opinion. Multiple names and identifiers for the same person may be sent in this sequence. Specification of meaning based on sequence is deprecated. Refer to User-defined Table 0010 - Physician ID in Chapter 2C, Code Tables, for suggested values.

IN3-26: Certification Type (CWE) 03336

Definition: This field contains the certification type code for a specific certification. Refer to User-defined Table 0921 – Certification Type Code in Chapter 2C, Code Tables, for suggested values.

IN3-27: Certification Category (CWE) 03337

Definition: This field contains the certification category code for a specific certification. Refer to User-defined Table 0922 – Certification Category Code in Chapter 2C, Code Tables, for suggested values.

IN3-28: Online Verification Date/Time (DTM) 02483

Definition: This field contains the timestamp of the online verification of the insurance information.

IN3-29: Online Verification Result (CWE) 02484

Definition: This field contains the result of the online verification. Refer to User-defined Table 0970 – Online Verification Result in Chapter 2C, Code Tables, for suggested values. This field is required if IN3-28 is populated.

IN3-30: Online Verification Result Error Code (CWE) 02485

Definition: This field contains the error code for the result of the online verification. Refer to User-defined Table 0791 – Online Verification Result Error Code in Chapter 2C, Code Tables, for suggested values. This field is required if IN3-28 is populated and an error status is returned.

IN3-31: Online Verification Result Check Digit (ST) 02486

Definition: This field contains the check digit for the online verification of the insurance information. This field is required if IN3-28 is populated.

ACC - Accident Segment

The ACC segment contains patient information relative to an accident in which the patient has been involved.

HL7 Attribute Table - ACC - Accident Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
ACC
1 00527 Accident Date/Time [0..1] DTM
2 00528 Accident Code [0..1] CWE
3 00529 Accident Location # [0..1] 25 ST
4 00812 Auto Accident State B [0..1] CWE
5 00813 Accident Job Related Indicator [0..1] [1..1] ID
6 00814 Accident Death Indicator [0..1] [1..1] ID
7 00224 Entered By [0..1] XCN
8 01503 Accident Description = [0..1] 1000 ST
9 01504 Brought In By = [0..1] 80 ST
10 01505 Police Notified Indicator [0..1] [1..1] ID
11 01853 Accident Address [0..1] XAD
12 02374 Degree of patient liability # [0..1] 3 NM
13 03338 Accident Identifier [0..*] EI

ACC-1: Accident Date/Time (DTM) 00527

Definition: This field contains the date/time of the accident.

ACC-2: Accident Code (CWE) 00528

Definition: This field contains the type of accident. Refer to User-defined Table 0050 - Accident Codein Chapter 2C, Code Tables,for suggested values. ICD accident codes are recommended.

ACC-3: Accident Location (ST) 00529

Definition: This field contains the location of the accident.

ACC-4: Auto Accident State (CWE) 00812

Definition: As of Version 2.5, this field has been retained for backward compatibility only. Use ACC-11 - Accident Address instead of this field, as the state in which the accident occurred is part of the address. This field specifies the state in which the auto accident occurred. (CMS 1500 requirement in the US.) Refer to User-defined Table 0347 - State/Province in Chapter 2C, Code Tables, for suggested values.

ACC-5: Accident Job Related Indicator (ID) 00813

Definition: This field indicates if the accident was related to a job. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the accident was job related

  • N    the accident was not job related

ACC-6: Accident Death Indicator (ID) 00814

Definition: This field indicates whether or not a patient has died as a result of an accident. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the patient has died as a result of an accident

  • N    the patient has not died as a result of an accident

ACC-7: Entered By (XCN) 00224

(Definition from NTE.5 in Ch. 2)

Definition: This field contains the identity of the person who actually keyed the comment into the application. It provides an audit trail in case the comment is entered incorrectly and the ancillary department needs to clarify the comment. By local agreement, either the ID number or name component MAY be omitted.

(Definition from ORC.10 in Ch. 4)

Definition: This field was retained for backward compatibility only as of v 2.7 and the detail was withdrawn and removed from the standard as of v 2.9. The reader is referred to the PRT segment described in Chapter 7.

(Definition from ACC.7 in Ch. 6)

Definition: This field identifies the person entering the accident information.

(Definition from MFE.7 in Ch. 8)

Definition: This field contains the identity of the person who actually keyed the master file entry into the application. It provides an audit trail in case the request is entered incorrectly and the ancillary department needs to clarify the request.

(Definition from OM7.20 in Ch. 8)

Note: This field is deprecated and retained for backward compatibility as of v 2.8.

Definition: This field contains the identity of the person who actually keyed the service item into the application. It provides an audit trail in case the request is entered incorrectly and the ancillary department needs to clarify the request.

ACC-8: Accident Description (ST) 01503

Definition: Description of the accident.

ACC-9: Brought In By (ST) 01504

Definition: This field identifies the person or organization that brought in the patient.

ACC-10: Police Notified Indicator (ID) 01505

Definition: This field indicates if the police were notified. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the police were notified

  • N    the police were not notified.

ACC-11: Accident Address (XAD) 01853

Definition: This field contains the address where the accident occurred.

ACC-12: Degree of patient liability (NM) 02374

Definition: This field conveys the amount to which the patient is found to be liable for an accident. The numeric value is given as a percentage value.

If the accident is totally caused by others this value is set to "0". If it is caused by the patient, it is set to "100". Any other value in between allows for a leverage of the fault between the patient and third parties.

ACC-13: Accident Identifier (EI) 03338

Definition: This field contains the identifier of the accident report assigned by a jurisdiction that is required in the insurance accident claim.

UB1 - Uniform Billing 1 Segment

The UB1 segment contains data specific to the United States. Only billing/claims fields that do not exist in other HL7 defined segments appear in this segment. The codes listed as examples are not an exhaustive or current list.

Attention: the UB1 segment was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

HL7 Attribute Table - UB1 - Uniform Billing 1 Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
UB1
1 00530 Set ID - UB1 SHALL NOT W [0..0] SI
2 00531 Blood Deductible SHALL NOT W [0..0]
3 00532 Blood Furnished-Pints SHALL NOT W [0..0]
4 00533 Blood Replaced-Pints SHALL NOT W [0..0]
5 00534 Blood Not Replaced-Pints SHALL NOT W [0..0]
6 00535 Co-Insurance Days SHALL NOT W [0..0]
7 00536 Condition Code SHALL NOT W [0..0]
8 00537 Covered Days SHALL NOT W [0..0]
9 00538 Non Covered Days SHALL NOT W [0..0]
10 00539 Value Amount & Code SHALL NOT W [0..0]
11 00540 Number Of Grace Days SHALL NOT W [0..0]
12 00541 Special Program Indicator SHALL NOT W [0..0]
13 00542 PSRO/UR Approval Indicator SHALL NOT W [0..0]
14 00543 PSRO/UR Approved Stay-Fm SHALL NOT W [0..0]
15 00544 PSRO/UR Approved Stay-To SHALL NOT W [0..0]
16 00545 Occurrence SHALL NOT W [0..0]
17 00546 Occurrence Span SHALL NOT W [0..0]
18 00547 Occur Span Start Date SHALL NOT W [0..0]
19 00548 Occur Span End Date SHALL NOT W [0..0]
20 00549 UB-82 Locator 2 SHALL NOT W [0..0]
21 00550 UB-82 Locator 9 SHALL NOT W [0..0]
22 00551 UB-82 Locator 27 SHALL NOT W [0..0]
23 00552 UB-82 Locator 45 SHALL NOT W [0..0]

UB1-1: Set ID - UB1

Attention: UB1-2 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-2: Blood Deductible

Attention: UB1-2 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-3: Blood Furnished-Pints

Attention: UB1-3 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-4: Blood Replaced-Pints

Attention: UB1-4 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-5: Blood Not Replaced-Pints

Attention: UB1-5 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-6: Co-Insurance Days

Attention: UB1-6 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-7: Condition Code

Attention: UB1-7 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-8: Covered Days

Attention: UB1-8 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-9: Non Covered Days

Attention: UB1-9 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-10: Value Amount & Code

Attention: UB1-10 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-11: Number Of Grace Days

Attention: UB1-11 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-12: Special Program Indicator

Attention: UB1-12 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-13: PSRO/UR Approval Indicator

Attention: UB1-13 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-14: PSRO/UR Approved Stay-Fm

Attention: UB1-14 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-15: PSRO/UR Approved Stay-To

Attention: UB1-15 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-16: Occurrence

Attention: UB1-16 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-17: Occurrence Span

Attention: UB1-17 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-18: Occur Span Start Date

Attention: UB1-18 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-19: Occur Span End Date

Attention: UB1-19 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-20: UB-82 Locator 2

Attention: UB1-20 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-21: UB-82 Locator 9

Attention: UB1-21 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-22: UB-82 Locator 27

Attention: UB1-22 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB1-23: UB-82 Locator 45

Attention: UB1-23 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6.

UB2 - Ub92 Data Segment

The UB2 segment contains data necessary to complete UB92 bills specific to the United States. Realms outside the US are referred to chapter 16. Only Uniform Billing fields that do not exist in other HL7 defined segments appear in this segment. For example, Patient Name and Date of Birth are required; they are included in the PID segment and therefore do not appear here. Uniform Billing field locators are provided in parentheses ( ). The UB codes listed as examples are not an exhaustive or current list; refer to a UB specification for additional information.

HL7 Attribute Table - UB2 - UB92 Data Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
UB2
1 00553 Set ID - UB2 [0..1] [1..4] SI
2 00554 Co-Insurance Days [0..1] [1..3] ST
3 00555 Condition Code [0..7] CWE
4 00556 Covered Days [0..1] [1..3] ST
5 00557 Non-Covered Days [0..1] [1..4] ST
6 00558 Value Amount & Code [0..12] UVC
7 00559 Occurrence Code & Date [0..8] OCD
8 00560 Occurrence Span Code/Dates [0..2] OSP
9 00561 Uniform Billing Locator 2 [0..2] [1..29] ST
10 00562 Uniform Billing Locator 11 [0..2] [1..12] ST
11 00563 Uniform Billing Locator 31 [0..1] [1..5] ST
12 00564 Document Control Number [0..3] [1..23] ST
13 00565 Uniform Billing Locator 49 [0..23] [1..4] ST
14 00566 Uniform Billing Locator 56 [0..5] [1..14] ST
15 00567 Uniform Billing Locator 57 [0..1] [1..27] ST
16 00568 Uniform Billing Locator 78 [0..2] [1..2] ST
17 00815 Special Visit Count [0..1] [1..3] NM

UB2-1: Set ID - UB2 (SI) 00553

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment the sequence number shall be 1, for the second occurrence it shall be 2, etc.

UB2-2: Co-Insurance Days (ST) 00554

Definition: This field contains the number of inpatient days exceeding defined benefit coverage. In the US, this corresponds to Uniform Billing form locator 9. This field is defined by CMS or other regulatory agencies.

UB2-3: Condition Code (CWE) 00555

Definition: This field contains a code reporting conditions that may affect payer processing; for example, the condition is related to employment (Patient covered by insurance not reflected here, treatment of non-terminal condition for hospice patient). The code in this field can repeat up to seven times to correspond to Uniform Billing form locators 24-30. Refer to User-defined Table 0043 - Condition Code in Chapter 2C, Code Tables, for suggested values. Refer to a UB specification for additional information. This field is defined by CMS or other regulatory agencies.

UB2-4: Covered Days (ST) 00556

Definition: This field contains Uniform Billing field 7. This field is defined by CMS or other regulatory agencies.

UB2-5: Non-Covered Days (ST) 00557

Definition: This field contains Uniform Billing field 8. This field is defined by CMS or other regulatory agencies.

UB2-6: Value Amount & Code (UVC) 00558

Definition: This field contains a monetary amount and an associated billing code. The pair in this field can repeat up to twelve times to represent/contain UB92 form locators 39a, 39b, 39c, 39d, 40a, 40b, 40c, 40d, 41a, 41b, 41c, and 41d. This field is defined by CMS or other regulatory agencies.

UB2-7: Occurrence Code & Date (OCD) 00559

Definition: The set of values in this field can repeat up to eight times. Uniform Billing fields 32a, 32b, 33a, 33b, 34a, 34b, 35a, and 35b. This field is defined by CMS or other regulatory agencies.

UB2-8: Occurrence Span Code/Dates (OSP) 00560

UB2-9: Uniform Billing Locator 2 (ST) 00561

Definition: This field contains an occurrence span code and an associated date. This field can repeat up to two times to represent/contain Uniform Billing form locators 36a and 36b. This field is defined by CMS or other regulatory agencies.

Definition: The value in this field may repeat up to two times.

UB2-10: Uniform Billing Locator 11 (ST) 00562

Definition: The value in this field may repeat up to two times.

UB2-11: Uniform Billing Locator 31 (ST) 00563

Definition: Defined by CMS or other regulatory agencies.

UB2-12: Document Control Number (ST) 00564

Definition: This field contains the number assigned by payor that is used for rebilling/adjustment purposes. It may repeat up to three times. Refer Uniform Billing field 37.

UB2-13: Uniform Billing Locator 49 (ST) 00565

Definition: This field is defined by CMS or other regulatory agencies. This field may repeat up to twenty-three times.

UB2-14: Uniform Billing Locator 56 (ST) 00566

Definition: This field may repeat up to five times.

UB2-15: Uniform Billing Locator 57 (ST) 00567

Definition: Defined by Uniform Billing CMS specification.

UB2-16: Uniform Billing Locator 78 (ST) 00568

Definition: This field may repeat up to two times.

UB2-17: Special Visit Count (NM) 00815

Definition: This field contains the total number of special therapy visits.

ABS - Abstract Segment

This segment was created to communicate patient abstract information used for billing and reimbursement purposes. "Abstract" is a condensed form of medical history created for analysis, care planning, etc.

HL7 Attribute Table - ABS - Abstract Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
ABS
1 01514 Discharge Care Provider [0..1] XCN
2 01515 Transfer Medical Service Code [0..1] CWE
3 01516 Severity of Illness Code [0..1] CWE
4 01517 Date/Time of Attestation [0..1] DTM
5 01518 Attested By [0..1] XCN
6 01519 Triage Code [0..1] CWE
7 01520 Abstract Completion Date/Time [0..1] DTM
8 01521 Abstracted By [0..1] XCN
9 01522 Case Category Code [0..1] CWE
10 01523 Caesarian Section Indicator [0..1] [1..1] ID
11 01524 Gestation Category Code [0..1] CWE
12 01525 Gestation Period - Weeks = [0..1] 3 NM
13 01526 Newborn Code [0..1] CWE
14 01527 Stillborn Indicator [0..1] [1..1] ID

ABS-1: Discharge Care Provider (XCN) 01514

Definition: Identification number of the provider responsible for the discharge of the patient from his/her care. Refer to User-defined Table 0010 - Physician ID in Chapter 2C, Code Tables, for suggested values.

ABS-2: Transfer Medical Service Code (CWE) 01515

Definition: Medical code representing the patient's medical services when they are transferred. Refer to User-defined Table 0069 - Hospital Service in Chapter 2C, Code Tables, for suggested values.

ABS-3: Severity of Illness Code (CWE) 01516

Definition: Code representing the ranking of a patient's illness. Refer to User-defined Table 0421 - Severity of Illness Code in Chapter 2C, Code Tables, for suggested values.

ABS-4: Date/Time of Attestation (DTM) 01517

Definition: Date/time that the medical record was reviewed and accepted.

ABS-5: Attested By (XCN) 01518

Definition: Identification number of the person (usually a provider) who reviewed and accepted the abstract of the medical record.

ABS-6: Triage Code (CWE) 01519

Definition: Code representing a patient's prioritization within the context of this abstract. Refer to User-defined Table 0422 - Triage Code in Chapter 2C, Code Tables, for suggested values.

ABS-7: Abstract Completion Date/Time (DTM) 01520

Definition: Date/time the abstraction was completed.

ABS-8: Abstracted By (XCN) 01521

Definition: Identification number of the person completing the Abstract.

ABS-9: Case Category Code (CWE) 01522

Definition: Code indicating the reason a non-urgent patient presents to the Emergency Room for treatment instead of a clinic or physician office. Refer to User-defined Table 0423 - Case Category Code in Chapter 2C, Code Tables, for suggested values.

ABS-10: Caesarian Section Indicator (ID) 01523

Definition: Indicates if the delivery was by Caesarian Section. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Delivery was by Caesarian Section.

  • N    Delivery was not by Caesarian Section.

ABS-11: Gestation Category Code (CWE) 01524

Definition: The gestation category code is used to indicate the status of the birth in relation to the gestation. Refer to User-defined Table 0424 - Gestation Category Code in Chapter 2C, Code Tables, for suggested values.

ABS-12: Gestation Period - Weeks (NM) 01525

Definition: Newborn's gestation period expressed as a number of weeks.

ABS-13: Newborn Code (CWE) 01526

Definition: The newborn code is used to indicate whether the baby was born in or out of the facility. Refer to User-defined Table 0425 - Newborn Code in Chapter 2C, Code Tables, for suggested values.

ABS-14: Stillborn Indicator (ID) 01527

Definition: Indicates whether or not a newborn was stillborn. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    Stillborn.

  • N    Not stillborn.

BLC - Blood Code Segment

The BLC segment contains data necessary to communicate patient abstract blood information used for billing and reimbursement purposes. This segment is repeating to report blood product codes and the associated blood units.

HL7 Attribute Table - BLC - Blood Code Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
BLC
1 01528 Blood Product Code [0..1] CWE
2 01529 Blood Amount [0..1] CQ

BLC-1: Blood Product Code (CWE) 01528

Definition: This field reports the blood product code. Refer to User-defined Table 0426 - Blood Product Code in Chapter 2C, Code Tables, for suggested values.

BLC-2: Blood Amount (CQ) 01529

Definition: This field indicates the quantity and units administered for the blood code identified in field 1, for example, 2^pt. Standard ISO or ANSI units, as defined in Chapter 7 are recommended.

RMI - Risk Management Incident Segment

The RMI segment is used to report an occurrence of an incident event pertaining or attaching to a patient encounter.

HL7 Attribute Table - RMI - Risk Management Incident Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
RMI
1 01530 Risk Management Incident Code [0..1] CWE
2 01531 Date/Time Incident [0..1] DTM
3 01533 Incident Type Code [0..1] CWE

RMI-1: Risk Management Incident Code (CWE) 01530

Definition: A code depicting the incident that occurred during a patient's stay. Refer to User-defined Table 0427 - Risk Management Incident Code in Chapter 2C, Code Tables, for suggested values.

RMI-2: Date/Time Incident (DTM) 01531

Definition: This field contains the date and time the Risk Management Incident identified in RMI-1 - Risk Management Incident Code occurred.

RMI-3: Incident Type Code (CWE) 01533

Definition: A code depicting a classification of the incident type. Refer to User-defined Table 0428 - Incident Type Code in Chapter 2C, Code Tables, for suggested values.

GP1 - Grouping/Reimbursement - Visit Segment

These fields are used in grouping and reimbursement for CMS APCs. Please refer to the "Outpatient Prospective Payment System Final Rule" ("OPPS Final Rule") issued by CMS.

The GP1 segment is specific to the US and may not be implemented in non-US systems.

HL7 Attribute Table - GP1 - Grouping/Reimbursement - Visit Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
GP1
1 01599 Type of Bill Code SHALL [1..1] CWE
2 01600 Revenue Code [0..*] CWE
3 01601 Overall Claim Disposition Code [0..1] CWE
4 01602 OCE Edits per Visit Code [0..*] CWE
5 00387 Outlier Cost [0..1] CP

GP1-1: Type of Bill Code (CWE) 01599

Definition: This field is the same as UB92 Form Locator 4 "Type of Bill". Refer to User-defined Table 0455 - Type of Bill Code in Chapter 2C, Code Tables, for suggested values. Refer to a UB specification for additional information. This field is defined by CMS or other regulatory agencies. It is a code indicating the specific type of bill with digit 1 showing type of facility, digit 2 showing bill classification, and digit 3 showing frequency.

GP1-2: Revenue Code (CWE) 01600

(Definition from FT1.41 in Ch. 6)

Definition: This field contains the Revenue Code for the charge. If valued, this field will override the value in the Service Catalog. Refer to User-defined Table 0456 – Revenue Code in Chapter 2C, Code Tables, for suggested values.

(Definition from GP1.2 in Ch. 6)

Definition: This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field identifies revenue codes that are not linked to a HCPCS/CPT code. It is used for claiming for non-medical services such as telephone, TV or cafeteria charges, etc. There can be many per visit or claim. This field is defined by CMS or other regulatory agencies.

There can also be a revenue code linked to a HCPCS/CPT code. These are found in GP2-1 - Revenue Code. Refer to UB92 specifications.

(Definition from GP2.1 in Ch. 6)

Definition: This field identifies a specific ancillary service for each HCPC/CPT This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP1-3: Overall Claim Disposition Code (CWE) 01601

Definition: This field identifies the final status of the claim. The codes listed as examples are not an exhaustive or current list, refer to OPPS Final Rule. Refer to User-defined Table 0457 - Overall Claim Disposition Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP1-4: OCE Edits per Visit Code (CWE) 01602

Definition: This field contains the edits that result from processing the HCPCS/CPT procedures for a record after evaluating all the codes, revenue codes, and modifiers. The codes listed as examples are not an exhaustive or current list, refer to OPPS Final Rule. OCE (Outpatient Code Editor) edits also exist at the pre-procedure level. Refer to User-defined Table 0458 - OCE Edit Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP1-5: Outlier Cost (CP) 00387

(Definition from DG1.13 in Ch. 6)

Attention: DG1-13 was deprecated as of v 2.3 and the detail was withdrawn and removed from the standard as of v 2.6

(Definition from DRG.7 in Ch. 6)

Definition: This field contains the amount of money that has been approved for an outlier payment.

(Definition from GP1.5 in Ch. 6)

Definition: This field contains the amount that exceeds the outlier limitation as defined by APC regulations. This field is analogous to DRG-7 - Outlier Cost; however, the definition in this field note supersedes the DRG-7 definition.

GP2 - Grouping/Reimbursement - Procedure Line Item Segment

This segment is used for items that pertain to each HCPC/CPT line item.

The GP2 segment is specific to the US and may not be implemented in non-US systems.

HL7 Attribute Table - GP2 - Grouping/Reimbursement - Procedure Line Item Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
GP2
1 01600 Revenue Code [0..1] CWE
2 01604 Number of Service Units # [0..1] 7 NM
3 01605 Charge [0..1] CP
4 01606 Reimbursement Action Code [0..1] CWE
5 01607 Denial or Rejection Code [0..1] CWE
6 01608 OCE Edit Code [0..*] CWE
7 01609 Ambulatory Payment Classification Code [0..1] CWE
8 01610 Modifier Edit Code [0..*] CWE
9 01611 Payment Adjustment Code [0..1] CWE
10 01617 Packaging Status Code [0..1] CWE
11 01618 Expected CMS Payment Amount [0..1] CP
12 01619 Reimbursement Type Code [0..1] CWE
13 01620 Co-Pay Amount [0..1] CP
14 01621 Pay Rate per Service Unit = [0..1] 4 NM

GP2-1: Revenue Code (CWE) 01600

(Definition from FT1.41 in Ch. 6)

Definition: This field contains the Revenue Code for the charge. If valued, this field will override the value in the Service Catalog. Refer to User-defined Table 0456 – Revenue Code in Chapter 2C, Code Tables, for suggested values.

(Definition from GP1.2 in Ch. 6)

Definition: This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field identifies revenue codes that are not linked to a HCPCS/CPT code. It is used for claiming for non-medical services such as telephone, TV or cafeteria charges, etc. There can be many per visit or claim. This field is defined by CMS or other regulatory agencies.

There can also be a revenue code linked to a HCPCS/CPT code. These are found in GP2-1 - Revenue Code. Refer to UB92 specifications.

(Definition from GP2.1 in Ch. 6)

Definition: This field identifies a specific ancillary service for each HCPC/CPT This field is the same as UB92 Form Locator 42 "Revenue Code". Refer to User-defined Table 0456 - Revenue Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP2-2: Number of Service Units (NM) 01604

Definition: This field contains the quantitative count of units for each HCPC/CPT. This field is the same as UB92 Form Locator 46 "Units of Service". This field is defined by CMS or other regulatory agencies.

GP2-3: Charge (CP) 01605

Definition: This field contains the amount charged for the specific individual line item (HCPC/CPT). This field is the same as UB92 Form Locator 56. This field is defined by CMS or other regulatory agencies.

GP2-4: Reimbursement Action Code (CWE) 01606

Definition: This field identifies the action to be taken during reimbursement calculations. If valued, this code overrides the value in GP2-6 - OCE Edit Code. Refer to User-defined Table 0459 - Reimbursement Action Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies

GP2-5: Denial or Rejection Code (CWE) 01607

Definition: This field determines the OCE status of the line item. Refer to User-defined table 0460 - Denial or Rejection Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP2-6: OCE Edit Code (CWE) 01608

Definition: This field contains the edit that results from the processing of HCPCS/CPT procedures for a line item HCPCS/CPT, after evaluating all the codes, revenue codes, and modifiers. Refer to User-defined Table 0458 - OCE Edit Code in Chapter 2C, Code Tables, for suggested values.

GP2-7: Ambulatory Payment Classification Code (CWE) 01609

Definition: This field contains the derived APC code. This is the APC code used for payment, which is the same as the assigned APC, for all situations except partial hospitalization. If partial hospitalization is billed in this visit, the assigned APC will differ from the APC used for payment. Partial hospitalization is the only time an assigned APC differs from the APC used for payment. The payment APC is used for billing and should be displayed in this field. The first component contains the APC identifier. The second component reports the text description for the APC group. Refer to User-defined table 0466 - Ambulatory Payment Classification Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP2-8: Modifier Edit Code (CWE) 01610

Definition: This field contains calculated edits of the modifiers for each line or HCPCS/CPT. This field can be repeated up to five times, one edit for each of the modifiers present. This field relates to the values in PR1-16 - Procedure Code Modifier. Each repetition corresponds positionally to the order of the PR1-16 modifier codes. If no modifier code exists, use the code "U" (modifier edit code unknown) as a placeholder. The repetitions of Modifier Edit Codes must match the repetitions of Procedure Code Modifiers. For example, if PR1-16 - Procedure Code Modifier reports ...|01~02~03~04|... as modifier codes, and modifier code 03 modifier status code is unknown, GP2-8 - Modifier Edit Code would report ...|1~1~U~1|... Refer to User-defined table 0467 - Modifier Edit Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies

GP2-9: Payment Adjustment Code (CWE) 01611

Definition: This field contains any payment adjustment due to drugs or medical devices. Refer to User-defined Table 0468 - Payment Adjustment Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies

GP2-10: Packaging Status Code (CWE) 01617

Definition: This field contains the packaging status of the service. A status indicator of N may accompany this, unless it is part of a partial hospitalization. Refer to User-defined (CMS) Table 0469 - Packaging Status Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP2-11: Expected CMS Payment Amount (CP) 01618

Definition: This field contains the calculated dollar amount that CMS is expected to pay for the line item.

GP2-12: Reimbursement Type Code (CWE) 01619

Definition: This field contains the fee schedule reimbursement type applied to the line item. Refer to User-defined Table 0470 - Reimbursement Type Code in Chapter 2C, Code Tables, for suggested values. This field is defined by CMS or other regulatory agencies.

GP2-13: Co-Pay Amount (CP) 01620

(Definition from IN2.73 in Ch. 6)

Definition: This field contains the patient's Co-pay amount for visit.

(Definition from GP2.13 in Ch. 6)

Definition: This field contains the patient's Co-pay amount for the line item.

GP2-14: Pay Rate per Service Unit (NM) 01621

Definition: This field contains the calculated rate, or multiplying factor, for each service unit for the line item.

EXAMPLE TRANSACTIONS

Create a patient billing/accounts receivable record

MSH|^~VALUEamp;|PATA|01|PATB|01|19930908135031||BAR^P01^BAR_P01|641|P|2.8|
000000000000001|<cr>

EVN|P01|19930908135030||<cr>

PID|1||8064993^^^PATA1^MR^A~6045681^^^PATA1^BN^A~123456789ABC^^^US^NI~123456789^^^USSSA^SS||EVERYWOMAN^EVE^J^^^||19471007|F||1|22220018 HOMESTREET^^HOUSTON^TX^77030^USA|HAR||||S||6045681<cr>

GT1|001||JOHNSON^SAM^J||1111 HEALTHCARE DRIVE^^BALTIMORE^MD^

21234^USA|||||||193-22-1876<cr>

NK1|001|BETTERHALF^BORIS|F|2222 HOME STREET^^CUMBERLAND^MD

^28765^US|(301)555-2134<cr>

IN1|001|A357|1234|BCMD|||||    132987<cr>

A patient has been registered by the ADT system (PATA) and notification is sent to the Patient Billing system (PATB). The patient's name is Eve J. Everywoman, a female Caucasian, born on October 7, 1947. Living at 1234 Homestreet, Houston, TX.

Ms. Everywoman's medical record number is 8064993 and her billing number is 6045681. Her national identifier is 123456789ABC. Her social security number, assigned by the U.S. Social Security Administration, is 123456789. Ms. Everywoman has provided her father's name and address for next of kin. Ms. Smith is insured under plan ID A357 with an insurance company known to both systems as BCMD, with a company ID of 1234.

Post a charge to a patient's account

MSH|^~VALUEamp;|PATA|01|PATB|01|19930908135031||DFT^P03^DFT_P03|641|P|2.8|
000000000000001|<cr>

EVN|P03|19930908135030||<cr>

PID||0008064993^^^ENT^PE|0008064993^^^PAT^MR||0006045681^^^PATA^AN|EVERYWOMEN^EVE^J^^^|19471007|F||1|2222 HOMESTREET^^HOUSTON^TX^77030^USA|HAR||||S||6045681^^^PATA^AN<cr>

FT1|1|||19950715|19950716|CG|B1238^BIOPSY-SKIN^SYSTEMA|||1|||ONC|A357||||||P8765^KILDARE^BEN<cr>

A patient has been registered by the ADT system (PATA) and notification is sent to the Patient Billing system (PATB). The patient's name is Eve J. Everywoman, a female Caucasian, born on October 7, 1947. Living at 1234 Homestreet, Houston, TX.

Ms. Everywoman's patient number is 8064993 and her billing number is 6045681. This transaction is posting a charge for a skin biopsy to her account.

Update patient accounts - update UB1 information

MSH|^~VALUEamp;|UREV||PATB||19930906135030||BAR^P05^BAR_P05|MSG0018|P|2.8<cr>

EVN|P05|19930908135030

PID|||125976||EVERYMAN^ADAM^J|||||||||||||125976011<cr>

UB1|1|1|5|3|1||39|||01^500.00|||1|19880501|19880507|10^19880501<cr>

Utilization review sends data for Patient Billing to the Patient Accounting system. The patient's insurance program has a 1-pint deductible for blood; the patient received five pints of blood, and three pints were replaced, with one pint not yet replaced.

The patient has been assigned to a medically necessary private room (UB condition code 39). The hospital's most common semi-private rate is $500.00 (UB value code 01.)

The services provided for the period 05/01/88 through 05/07/88 are fully approved (PSRO/UR Approval Code 1). The patient's hospitalization is the result of an auto accident (UB occurrence code 01.)

Update patient accounts - update diagnosis and DRG information

MSH|^~VALUEamp;|UREV||PATB||19930908135030||BAR^P05^BAR_P05|MSG0018|P|2.8<cr>

EVN|P05|19930908135030

PID|||125976||EVERYMAN^ADAM^J|||||||||||||125976011<cr>

DG1|001|I9|1550|MAL NEO LIVER, PRIMARY|19880501103005|F<cr>

DRG|203|19880501103010|Y||D|5<cr>

The DG1 segment contains the information that the patient was diagnosed on May 1 as having a malignancy of the hepatobiliary system or pancreas (ICD9 code 1550). In the DRG segment, the patient has been assigned a Diagnostic Related Group (DRG) of 203 (corresponding to the ICD9 code of 1550). Also, the patient has been approved for an additional five days (five-day outlier).