999 Transaction Set Listing

008020X335 Implementation Acknowledgment for Health Care Insurance
Usage
Repeats

ISA - INTERCHANGE CONTROL HEADER

X12 Name:
Interchange Control Header
X12 Purpose:
To start and identify an interchange of zero or more functional groups and interchange-related control segments
Segment Usage:
Required
Segment Repeat:
1
TR3 Notes:
  1. All positions within each of the data elements must be filled.
  2. For compliant implementations under this implementation guide, ISA13, the interchange Control Number, must be a positive unsigned number. Therefore, the ISA segment can be considered a fixed record length segment.
  3. The first element separator defines the element separator to be used through the entire interchange.
  4. Spaces in the example interchanges are represented by "." for clarity.
  5. The ISA segment terminator defines the segment terminator used throughout the entire interchange.
TR3 Example:
ISA✱00✱..........✱01✱SECRET....✱ZZ✱SENDERS.ID.....✱ZZ✱RECEIVERS.ID...✱030101✱1253✱^✱00802✱000000905✱0✱T✱:~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
I01
Authorization Information Qualifier
M 1
ID
2
Code identifying the type of information in the Authorization Information
CODE
DEFINITION
00
No Authorization Information Present (No Meaningful Information in I02)
03
Additional Data Identification
Required
2
I02
Authorization Information
M 1
AN
10
Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)
This element is fixed in length with identical minimum and maximum lengths. Spaces are inserted to meet the minimum length in an AN data element. With the associated code 00 in ISA01 or ISA03, an all space value indicates no information.
Required
3
I03
Security Information Qualifier
M 1
ID
2
Code identifying the type of information in the Security Information
CODE
DEFINITION
00
No Security Information Present (No Meaningful Information in I04)
01
Password
Required
4
I04
Security Information
M 1
AN
10
This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)
This element is fixed in length with identical minimum and maximum lengths. Spaces are inserted to meet the minimum length in an AN data element. With the associated code 00 in ISA01 or ISA03, an all space value indicates no information.
Required
5
I05
Interchange ID Qualifier
M 1
ID
2
Code indicating the system/method of code structure used to designate the sender or receiver ID element being qualified
This ID qualifies the Sender in ISA06.
CODE
DEFINITION
01
Duns (Dun & Bradstreet)
14
Duns Plus Suffix
20
Health Industry Number (HIN)
CODE SOURCE: 121: Health Industry Number
27
Carrier Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
28
Fiscal Intermediary Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
29
Medicare Provider and Supplier Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
30
U.S. Federal Tax Identification Number
33
National Association of Insurance Commissioners Company Code (NAIC)
ZZ
Mutually Defined
Required
6
I06
Interchange Sender ID
M 1
AN
15
Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element
Required
7
I05
Interchange ID Qualifier
M 1
ID
2
Code indicating the system/method of code structure used to designate the sender or receiver ID element being qualified
This ID qualifies the Receiver in ISA08.
CODE
DEFINITION
01
Duns (Dun & Bradstreet)
14
Duns Plus Suffix
20
Health Industry Number (HIN)
CODE SOURCE: 121: Health Industry Number
27
Carrier Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
28
Fiscal Intermediary Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
29
Medicare Provider and Supplier Identification Number as assigned by Centers for Medicare & Medicaid Services (CMS)
30
U.S. Federal Tax Identification Number
33
National Association of Insurance Commissioners Company Code (NAIC)
ZZ
Mutually Defined
Required
8
I07
Interchange Receiver ID
M 1
AN
15
Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them
Required
9
I08
Interchange Date
M 1
DT
6
Date of the interchange
The date format is YYMMDD.
Required
10
I09
Interchange Time
M 1
TM
4
Time of the interchange
The time format is HHMM.
Required
11
I65
Repetition Separator
M 1
Type is not applicable; the repetition separator is a delimiter and not a data element; this field provides the delimiter used to separate repeated occurrences of a simple data element or a composite data structure; this value must be different than the data element separator, component element separator, and the segment terminator
Required
12
I11
Interchange Control Version Number Code
M 1
ID
5
Code specifying the version number of the interchange control segments, the version of the data elements within the control segments, and the code values within those data elements.
INDUSTRY NAME: Interchange Control Version Number
CODE
DEFINITION
00802
00802 Standards Approved for Publication by ASC X12 Procedures Review Board through December 2020
Required
13
I12
Interchange Control Number
M 1
N
9
A control number assigned by the interchange sender
  1. The Interchange Control Number, ISA13, must be identical to the associated Interchange Trailer IEA02.
  2. Must be a positive unsigned number and must be identical to the value in IEA02.
Required
14
I13
Acknowledgment Requested Code
M 1
ID
1
Code indicating sender's request for an interchange acknowledgment
INDUSTRY NAME: Acknowledgment Requested
X12.5 - Interchange Control Structure provides the purpose of the TA1 segment. The X12 Acknowledgment Reference Model provides considerable information about the TA1 segment.
CODE
DEFINITION
0
No Interchange Acknowledgment Requested
Use when the interchange contains ONLY acknowledgment Functional Groups (e.g. 999 or 824) or a TA1.
1
Interchange Acknowledgment Requested (TA1)
Use when batch process requires the return of a TA1 for the interchange.
2
Interchange Acknowledgment Requested only when Interchange is "Rejected Because Of Errors"
Use when the transaction is for real-time processing.
3
Interchange Acknowledgment Requested only when Interchange is "Rejected Because Of Errors" or "Accepted but Errors are Noted"
Use when batch processing requires the return of a TA1 for the interchange only when errors are noted.
Required
15
I14
Interchange Usage Indicator Code
M 1
ID
1
Code indicating whether data enclosed by this interchange envelope is test, production or information
INDUSTRY NAME: Interchange Usage Indicator
CODE
DEFINITION
I
Information
Use when the interchange contains ONLY a TA1.
P
Production Data
T
Test Data
Required
16
I15
Component Element Separator
M 1
Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator

TA1 - INTERCHANGE ACKNOWLEDGMENT

X12 Name:
Interchange Acknowledgment
X12 Purpose:
To report the status of the processing of an interchange header and trailer by the addressed receiver or the non-delivery by a network provider
Segment Usage:
Situational
Segment Repeat:
1
Situational Rule:
Required when requested by the sender as indicated in the ISA14 of the submitted interchange. If not required by this implementation guide, do not send.
TR3 Notes:
When used, the TA1 segment must either be included in the same interchange as the 999 transaction set, or sent within its own interchange (i.e. ISA-TA1-IEA). When included in the same interchange as the 999 transaction set, the TA1 segment must be included within the interchange (ISA/IEA) and outside of any included functional groups (GS/GE). It is recommended that the TA1 segment be placed between the ISA and first occurrence of the GS segment.
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
I12
Interchange Control Number
M 1
N
9
A control number assigned by the interchange sender
This is the value in ISA13 from the interchange to which this TA1 is responding.
Required
2
I08
Interchange Date
M 1
DT
6
Date of the interchange
Required
3
I09
Interchange Time
M 1
TM
4
Time of the interchange
Required
4
I17
Interchange Acknowledgment Code
M 1
ID
1
Code indicating the status of the receipt of the interchange control structure
CODE
DEFINITION
A
The Transmitted Interchange Control Structure Header and Trailer Have Been Received and Have No Errors.
E
The Transmitted Interchange Control Structure Header and Trailer Have Been Received and Are Accepted But Errors Are Noted. This Means the Sender Must Not Resend This Data.
R
The Transmitted Interchange Control Structure Header and Trailer are Rejected Because of Errors.
Required
5
I18
Interchange Note Code
M 1
ID
3
Code specifying the error found processing the interchange control structure
CODE
DEFINITION
000
No error
001
The Interchange Control Number in the Header and Trailer Do Not Match. The Value From the Header is Used in the Acknowledgment.
002
This Standard as Noted in the Control Standards Identifier is Not Supported.
003
This Version of the Controls is Not Supported
004
The Segment Terminator is Invalid
005
Invalid Interchange ID Qualifier for Sender
006
Invalid Interchange Sender ID
007
Invalid Interchange ID Qualifier for Receiver
008
Invalid Interchange Receiver ID
009
Unknown Interchange Receiver ID
010
Invalid Authorization Information Qualifier Value
011
Invalid Authorization Information Value
012
Invalid Security Information Qualifier Value
013
Invalid Security Information Value
014
Invalid Interchange Date Value
015
Invalid Interchange Time Value
016
Invalid Interchange Standards Identifier Value
017
Invalid Interchange Version ID Value
018
Invalid Interchange Control Number Value
019
Invalid Acknowledgment Requested Value
020
Invalid Test Indicator Value
021
Invalid Number of Included Groups Value
022
Invalid Control Structure
023
Improper (Premature) End-of-File (Transmission)
024
Invalid Interchange Content (e.g., Invalid GS Segment)
025
Duplicate Interchange Control Number
026
Invalid Data Element Separator
027
Invalid Component Element Separator
028
Invalid Delivery Date in Deferred Delivery Request
029
Invalid Delivery Time in Deferred Delivery Request
030
Invalid Delivery Time Code in Deferred Delivery Request
031
Invalid Grade of Service Code
032
Invalid Repetition Separator

GS*FA - FUNCTIONAL GROUP HEADER

X12 Name:
Functional Group Header
X12 Purpose:
To indicate the beginning of a functional group and to provide control information
X12 Comments:
A functional group of related transaction sets, within the scope of X12 standards, consists of a collection of similar transaction sets enclosed by a functional group header and a functional group trailer.
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
GS✱XX✱SENDER CODE✱RECEIVER CODE✱19991231✱0802✱1✱X✱008020X335~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
479
Functional Identifier Code
M 1
ID
2
Code identifying a group of application related transaction sets
This is the 2-character Functional Identifier Code assigned to each transaction set by X12. The specific code for a transaction set defined by this implementation guide is presented in Section 1.2, Version Information.
CODE
DEFINITION
FA
Functional or Implementation Acknowledgment Transaction Sets (997, 999)
Required
2
142
Application Sender's Code
M 1
AN
2/15
Code identifying party sending transmission; codes agreed to by trading partners
Use this code to identify the unit sending the information.
Required
3
124
Application Receiver's Code
M 1
AN
2/15
Code identifying party receiving transmission; codes agreed to by trading partners
Use this code to identify the unit receiving the information.
Required
4
373
Date
M 1
DT
8
Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year
SEMANTIC: GS04 is the group date.
Use this date for the functional group creation date.
Required
5
337
Time
M 1
TM
4/8
Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)
SEMANTIC: GS05 is the group time.
Use this time for the creation time. The recommended format is HHMM.
Required
6
28
Group Control Number
M 1
N
1/9
Assigned number originated and maintained by the sender
SEMANTIC: The data interchange control number GS06 in this header must be identical to the same data element in the associated functional group trailer, GE02.
For implementations compliant with this guide, GS06 must be unique within a single transmission (that is, within a single ISA to IEA enveloping structure). The authors recommend that GS06 be unique within all transmissions over a period of time to be determined by the sender.
Required
7
455
Responsible Agency Code
M 1
ID
1/2
Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480
CODE
DEFINITION
X
Accredited Standards Committee X12
Required
8
480
Version / Release / Industry Identifier Code
M 1
AN
1/12
Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed
INDUSTRY NAME: Version, Release, or Industry Identifier Code
This is the unique Version/Release/Industry Identifier Code assigned to an implementation by X12N. The specific code for a transaction set defined by this implementation guide is presented in Section 1.2, Version Information.
CODE SOURCE 881: Version / Release / Industry Identifier Code
CODE
DEFINITION
008020X335
Implementation Acknowledgment for Health Care Insurance

ST*999 - TRANSACTION SET HEADER

X12 Name:
Transaction Set Header
X12 Purpose:
To indicate the start of a transaction set and to assign a control number
X12 Set Notes:
  1. NOTE: Neither the 997 nor the 999 Acknowledgment shall be acknowledged, thereby preventing an endless cycle of acknowledgments of acknowledgments. Nor shall a Implementation Acknowledgment be sent to report errors in a previous Implementation Acknowledgment.
  2. NOTE: There is only one Implementation Acknowledgment Transaction Set per acknowledged functional group.
  3. NOTE: Only one acknowledgement can be sent for each functional group. The acknowledgment can be either a single Transaction Set 997 or a single Transaction Set 999 as mutually agreed upon by the trading partners. Different Functional Groups may have different acknowledgements, e.g. some Functional Groups, within the same interchange, may be acknowledged with the 997 and others with the 999.
Segment Usage:
Required
Segment Repeat:
1
TR3 Notes:
When acknowledging a Health Care Implementation Guide (TR3) based functional group and its transactions, only a single transaction set 999 can be used; the transaction set 997 must not be used.
TR3 Example:
ST✱999✱0002✱008020X335~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
143
Transaction Set Identifier Code
M 1
ID
3
Code identifying a Transaction Set
SEMANTIC: The transaction set identifier (ST01) is used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
CODE
DEFINITION
999
Implementation Acknowledgment
Required
2
329
Transaction Set Control Number
M 1
AN
4/9
Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
The Transaction Set Control Numbers in ST02 and SE02 must be identical and must be a numeric value. The number (i.e. numeric value) is assigned by the originator and must be unique within a functional group (GS-GE). For example, start with the numeric value 0001 and increment from there. The Transaction Set Control Number also aids in error resolution research.
Required
3
1705
Implementation Convention Reference
O 1
AN
1/35
Reference assigned to identify Implementation Convention
SEMANTIC: The implementation convention reference (ST03) is used by the translation routines of the interchange partners to select the appropriate implementation convention to match the transaction set definition. When used, this implementation convention reference takes precedence over the implementation reference specified in the GS08.
This field contains the same value as data element GS08. This value is always 006020X290 when this implementation guide is used. Some translator products strip off the ISA and GS segments prior to application processing. Providing the information from GS08 at this level will help ensure the appropriate application mapping is utilized at translation time.
CODE
DEFINITION
008020X335
Implementation Acknowledgment for Health Care Insurance

AK1 - FUNCTIONAL GROUP RESPONSE HEADER

X12 Name:
Functional Group Response Header
X12 Purpose:
To start acknowledgment of a functional group
X12 Set Notes:
  1. NOTE: AK1 is used to respond to the functional group header and to start the acknowledgment for a functional group. There shall be one AK1 segment for the functional group that is being acknowledged.
  2. NOTE: The Implementation Acknowledgement is generated at the point of translation, intended for the originator (not any intermediate parties).
  3. NOTE: The Functional Group Header Segment (GS) is used to start the envelope for the Implementation Acknowledgment Transaction Sets. In preparing the functional group of acknowledgments, the application sender's code and the application receiver's code, taken from the functional group being acknowledged, are exchanged; therefore, one acknowledgment functional group responds to only those functional groups from one application receiver's code to one application sender's code.
Segment Usage:
Required
Segment Repeat:
1
TR3 Notes:
AK101, AK102, and AK103 are used to identify a functional group by reporting GS01, GS06, and GS08 from the functional group being acknowledged. If the value of GS01, GS06, or GS08 would cause AK101, AK102, or AK103 to be invalid, reject the entire interchange with a TA1 using TA105 code value 024 meaning "Invalid Interchange Content (e.g., Invalid GS Segment)".
TR3 Example:
AK1✱HC✱0001✱008020X323~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
479
Functional Identifier Code
M 1
ID
2
Code identifying a group of application related transaction sets
SEMANTIC: AK101 is the functional ID found in the GS segment (GS01) in the functional group being acknowledged.
Use the value in GS01 from the functional group to which this 999 transaction set is responding.
Required
2
28
Group Control Number
M 1
N
1/9
Assigned number originated and maintained by the sender
SEMANTIC: AK102 is the functional group control number found in the GS segment in the functional group being acknowledged.
Use the value in GS06 from the functional group to which this 999 transaction set is responding.
Required
3
480
Version / Release / Industry Identifier Code
O 1
AN
1/12
Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed
SEMANTIC: AK103 is the version release industry identifier code in the GS segment (GS08) in the functional group being acknowledged.
INDUSTRY NAME: Version, Release, or Industry Identifier Code
This value must be the value in GS08 from the functional group to which this 999 transaction set is responding.
CODE SOURCE 881: Version / Release / Industry Identifier Code

AK2 - TRANSACTION SET RESPONSE HEADER

X12 Name:
Transaction Set Response Header
X12 Purpose:
To start acknowledgment of a single transaction set
X12 Set Notes:
NOTE: AK2 is used to start the acknowledgment of a transaction set within the received functional group. The AK2 segments shall appear in the same order as the transaction sets in the functional group that has been received and is being acknowledged.
Loop:
Loop Usage:
Situational
Segment Usage:
Required
Segment Repeat:
1
Situational Rule:
Required when an error is present in a transaction set contained in the functional group to which this 999 transaction set is responding. If not required by this implementation guide, may be provided at the sender's discretion but cannot be required by the receiver.
TR3 Notes:
  1. While it is not required that an AK2 loop be included for each transaction set received, it is required that an AK2 loop be included for each transaction set that contains an error. When AK2 loops are included in this transaction set, they must be in the same order as received in the functional group to which this 999 is responding.
  2. AK201, AK202, and AK203 are used to identify a transaction set by reporting ST01, ST02, and ST03 from the transaction set being acknowledged. If the value of ST01, ST02, or ST03 would cause AK201, AK202, or AK203 to be invalid, reject the transaction set with an IK501 value of R meaning "Rejected" and IK502 of 6 meaning "Missing or Invalid Transaction Set Identifier", 7 meaning "Missing or Invalid Transaction Set Control Number", or 19 meaning "Invalid Transaction Set Implementation Convention Reference" (use IK503 and IK504 if more than one value is appropriate).
TR3 Example:
AK2✱837✱0001✱008020X323~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
143
Transaction Set Identifier Code
M 1
ID
3
Code identifying a Transaction Set
SEMANTIC: AK201 is the transaction set ID found in the ST segment (ST01) in the transaction set being acknowledged.
  1. Use the value in ST01 from the transaction set to which this 999 transaction set is responding.
  2. If the value of ST01 exceeds the maximum length of AK201, truncate to the maximum length of AK201. If the value of ST01 would cause AK201 to be invalid, use "999" for AK201. A value of "999" is only used when the AK201 would be invalid. A 999 should not be acknowledged with another 999.
Required
2
329
Transaction Set Control Number
M 1
AN
4/9
Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
SEMANTIC: AK202 is the transaction set control number found in the ST segment in the transaction set being acknowledged.
  1. Use the value in ST02 from the transaction set to which this 999 transaction set is responding.
  2. If the value of ST02 exceeds the maximum length of AK202, truncate to the maximum length of AK202. If the value of ST02 would cause AK202 to be invalid, use "000000000" for AK202.
Situational
3
1705
Implementation Convention Reference
O 1
AN
1/35
Reference assigned to identify Implementation Convention
SEMANTIC: AK203 is the implementation convention reference, if any, found in the ST segment (ST03) in the transaction set being acknowledged.
SITUATIONAL RULE: Required when the ST03 is available in the transaction set to which this 999 transaction set is responding, unless the length is invalid or invalid characters are present. If not required by this Implementation Guide, do not send.
  1. When used, this is the value in ST03 from the transaction set to which this 999 transaction set is responding.
  2. If the value of ST03 exceeds the maximum length of AK203, truncate to the maximum length of AK203. If the value of ST03 would cause AK203 to be invalid, use "00000000000000000000000000000000000" for AK203.

IK3 - ERROR IDENTIFICATION

X12 Name:
Implementation Data Segment Note
X12 Purpose:
To report implementation errors in a data segment and identify the location of the data segment
X12 Set Notes:
COMMENT: The data segments of this standard are used to report the results of the syntactical analysis of the functional groups of transaction sets; they report the extent to which the syntax complies with the standards or proper subsets of transaction sets and functional groups as expressed in compliant implementation guides. They do not report on the semantic meaning of the transaction sets (for example, on the ability of the receiver to comply with the request of the sender).
Loop:
Loop Usage:
Situational
Segment Usage:
Required
Segment Repeat:
1
Situational Rule:
Required when an error is present in the transaction set identified in this AK2 loop and the location of the data segment containing the error can be identified by the submitter of this 999. If not required by this implementation guide, do not send.
TR3 Example:
IK3✱DMG✱31✱2000✱8~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
721
Segment ID Code
M 1
ID
2/3
Code specifying the segment ID of the data segment in error (See Appendix A - Number 77)
CODE SOURCE 77: X12 Directories
Required
2
719
Segment Position in Transaction Set
M 1
N
1/10
The numerical count position of this data segment from the start of the transaction set: the transaction set header is count position 1
The value to use in IK302 is the numerical count position of this data segment, relative to the transaction set instance (not the transaction set diagram), from the start of the transaction set. The transaction set header (i.e. ST) is count position 1.
Situational
3
447
Loop Identifier Code
O 1
AN
1/6
The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE
SITUATIONAL RULE: Required when the loop identifier value from the transaction set is known by the submitter of this 999. If not required by this implementation guide, do not send.
Required
4
620
Implementation Segment Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a segment
CODE
DEFINITION
1
Unrecognized segment ID
2
Unexpected segment
3
Required Segment Missing
4
Loop Occurs Over Maximum Times
5
Segment Exceeds Maximum Use
6
Segment Not in Defined Transaction Set
7
Segment Not in Proper Sequence
8
Segment Has Data Element Errors
I4
Implementation "Not Used" Segment Present
I6
Implementation Dependent Segment Missing
I7
Implementation Loop Occurs Under Minimum Times
I8
Implementation Segment Below Minimum Use
I9
Implementation Dependent "Not Used" Segment Present

CTX - SEGMENT CONTEXT

X12 Name:
Context
X12 Purpose:
Describes an event context in terms of the application or implementation contexts in force at the time the event occurred and the position in the EDI stream at which that context was activated
Loop:
Loop Usage:
Situational
Segment Usage:
Situational
Segment Repeat:
9
Situational Rule:
Required when the error identified in this IK3 loop was triggered by a situational requirement of the implementation guide and the error occurs at the segment level. If not required by this implementation guide, do not send.
TR3 Notes:
The CTX segment is used to identify the data that triggered the situational requirement.
TR3 Example:
CTX✱SITUATIONAL TRIGGER✱CLM✱43✱✱5:3~CTX✱SITUATIONAL TRIGGER✱CLM✱43✱✱2✱782~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
C998
Context Identification
M 10
Holds information to identify a context
Required
1-1
9999
Context Name
M 1
AN
1/35
Holds the name or 'tag' of a context
Always contains the value "SITUATIONAL TRIGGER".
Not Used
1-2
9998
Context Reference
O 1
AN
1/50
Required
2
721
Segment ID Code
O 1
ID
2/3
Code specifying the segment ID of the data segment in error (See Appendix A - Number 77)
CODE SOURCE 77: X12 Directories
Required
3
719
Segment Position in Transaction Set
O 1
N
1/10
The numerical count position of this data segment from the start of the transaction set: the transaction set header is count position 1
Situational
4
447
Loop Identifier Code
O 1
AN
1/6
The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE
SITUATIONAL RULE: Required when the loop identifier value from the transaction set is known by the submitter of this 999. If not required by this implementation guide, do not send.
Situational
5
C030
Position in Segment
O 1
Code indicating the relative position of the simple data element or composite data structure in error within a segment, count beginning with 1 for the position immediately following the segment ID; additionally indicating the relative position of a repeating structure in error, count beginning with 1 for the position immediately following the preceding element separator; additionally indicating the relative position of a component of a composite data structure in error, count beginning with 1 for the position following the preceding element or repetition separator
SITUATIONAL RULE: Required when the situational requirement relates to an element. If not required by this implementation guide, do not send.
Required
5-1
722
Element Position in Segment
M 1
N
1/2
This is used to indicate the relative position of a simple data element, or the relative position of a composite data structure with the relative position of the component within the composite data structure, in error; in the data segment the count starts with 1 for the simple data element or composite data structure immediately following the segment ID
Situational
5-2
1528
Component Data Element Position in Composite
O 1
N
1/2
To identify the component data element position within the composite that is in error
SITUATIONAL RULE: Required when the situational requirement relates to a component data element within a composite data structure. If not required by this implementation guide, do not send.
Situational
5-3
1686
Repeating Data Element Position
O 1
N
1/4
To identify the specific repetition of a data element that is in error
SITUATIONAL RULE: Required when the situational requirement relates to a repeating data element. If not required by this implementation guide, do not send.
Situational
6
C999
Reference in Segment
O 1
To hold the reference number of a data element and optionally a component data element within a composite
X12 COMPOSITE SEMANTIC NOTES:
  1. This element holds the reference number of the simple or composite element at segment level.
  2. This element holds the reference number of the simple element within a composite.
SITUATIONAL RULE: Required when CTX05 is used and the data element reference number of the data element identified in CTX05-1 is known by the submitter of the 999. If not required by this implementation guide, do not send.
Required
6-1
725
Data Element Reference Code
M 1
AN
1/4
Code identifying the location of the data element in the Data Element Dictionary
INDUSTRY NAME: Context Data Element Reference Number
CODE SOURCE 77: X12 Directories
Not Used
6-2
725
Data Element Reference Code
O 1
AN
1/4

CTX - ERROR LOCATION CONTEXT

X12 Name:
Context
X12 Purpose:
Describes an event context in terms of the application or implementation contexts in force at the time the event occurred and the position in the EDI stream at which that context was activated
Loop:
Loop Usage:
Situational
Segment Usage:
Situational
Segment Repeat:
1
Situational Rule:
Required when the location of the error reported in this IK3 loop can be further localized and the applicable error location context is known by the submitter of the 999. If not required by this implementation guide, do not send.
TR3 Notes:
  1. The Error Location Context segment conveys a transaction-specific data element that is used to help locate an error within an EDI transmission utilizing the segments contained in Note 2.
  2. The table below contains the Error Location Context to be used for each transaction set to which the 999 is a viable response.

    Transaction Set Description of Error Location Context Loop and element of the context
TR3 Example:
CTX✱CLM01:123456789~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
C998
Context Identification
M 10
Holds information to identify a context
Required
1-1
9999
Context Name
M 1
AN
1/35
Holds the name or 'tag' of a context
This contains one of the following values, based upon TR3 Note 2, depending on the value in AK201:
TRN02
NM109
ENT01
REF02
CLM01
Required
1-2
9998
Context Reference
O 1
AN
1/50
Holds a reference to or for a context
  1. This contains the value from the Error Location Context contained in the element specified in CTX01-01.
  2. If the value of the data element identified in CTX01-01 exceeds the maximum length of CTX01-02, truncate to the maximum length of CTX01-02. If the value of the data element identified in CTX01-01 would cause CTX01-02 to be invalid, use the value "INVALID ERROR LOCATION IDENTIFIER" for CTX01-02.
Not Used
2
721
Segment ID Code
O 1
ID
2/3
Not Used
3
719
Segment Position in Transaction Set
O 1
N
1/10
Not Used
4
447
Loop Identifier Code
O 1
AN
1/6
Not Used
5
C030
Position in Segment
O 1
Not Used
6
C999
Reference in Segment
O 1

IK4 - IMPLEMENTATION DATA ELEMENT NOTE

X12 Name:
Implementation Data Element Note
X12 Purpose:
To report implementation errors in a data element or composite data structure and identify the location of the data element
Loop:
Loop Usage:
Situational
Segment Usage:
Required
Segment Repeat:
1
Situational Rule:
Required when an error is present in the transaction set identified in this AK2 loop and the location of the data segment containing the error can be identified by the submitter of this 999. If not required by this implementation guide, do not send.
TR3 Example:
IK4✱1:3✱98✱1✱0002~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
C030
Position in Segment
M 1
Code indicating the relative position of the simple data element or composite data structure in error within a segment, count beginning with 1 for the position immediately following the segment ID; additionally indicating the relative position of a repeating structure in error, count beginning with 1 for the position immediately following the preceding element separator; additionally indicating the relative position of a component of a composite data structure in error, count beginning with 1 for the position following the preceding element or repetition separator
Required
1-1
722
Element Position in Segment
M 1
N
1/2
This is used to indicate the relative position of a simple data element, or the relative position of a composite data structure with the relative position of the component within the composite data structure, in error; in the data segment the count starts with 1 for the simple data element or composite data structure immediately following the segment ID
Situational
1-2
1528
Component Data Element Position in Composite
O 1
N
1/2
To identify the component data element position within the composite that is in error
SITUATIONAL RULE: Required when the error described in this segment relates to a component data element within a composite data structure. If not required by this implementation guide, do not send.
Situational
1-3
1686
Repeating Data Element Position
O 1
N
1/4
To identify the specific repetition of a data element that is in error
SITUATIONAL RULE: Required when the error described in this segment relates to a repeating data element. If not required by this implementation guide, do not send.
Situational
2
725
Data Element Reference Code
O 1
AN
1/4
Code identifying the location of the data element in the Data Element Dictionary
SITUATIONAL RULE: Required when the data element reference number for the data in error is known, and it is NOT a composite data element. If not required by this implementation guide, do not send.
INDUSTRY NAME: Data Element Reference Number
CODE SOURCE 77: X12 Directories
Required
3
621
Implementation Data Element Syntax Error Code
M 1
ID
1/3
Code indicating the implementation error found after syntax edits of a data element
CODE
DEFINITION
1
Required Data Element Missing
2
Conditional Required Data Element Missing
3
Too Many Data Elements
4
Data Element Too Short
5
Data Element Too Long
6
Invalid Character(s) in Data Element
7
Invalid Code Value
8
Invalid Date
9
Invalid Time
10
Exclusion Condition Violated
12
Too Many Repetitions
13
Too Many Components
I10
Implementation "Not Used" Data Element Present
I11
Implementation Too Few Repetitions
I12
Implementation Pattern Match Failure
I13
Implementation Dependent "Not Used" Data Element Present
I6
Code Value Not Used in Implementation
I9
Implementation Dependent Data Element Missing
Situational
4
724
Copy of Bad Data Element
O 1
AN
1/99
This is a copy of the data element in error
SITUATIONAL RULE: Required unless invalid characters are present, data is missing, or the data is from a binary data element. If not required by this implementation guide, do not send.

CTX - ELEMENT CONTEXT

X12 Name:
Context
X12 Purpose:
Describes an event context in terms of the application or implementation contexts in force at the time the event occurred and the position in the EDI stream at which that context was activated
X12 Set Notes:
NOTE: The CTX Segment shall be used to disambiguate a reported error that is dependent on context.
Loop:
Loop Usage:
Situational
Segment Usage:
Situational
Segment Repeat:
10
Situational Rule:
Required when the error identified in this IK4 loop was triggered by a situational requirement of the implementation guide and the error occurs at the element level. If not required by this implementation guide, do not send.
TR3 Notes:
The CTX segment is used to identify the data that triggered the situational requirement.
TR3 Example:
CTX✱SITUATIONAL TRIGGER✱CLM✱43✱✱5:3~CTX✱SITUATIONAL TRIGGER✱CLM✱43✱✱2✱782~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
C998
Context Identification
M 10
Holds information to identify a context
Required
1-1
9999
Context Name
M 1
AN
1/35
Holds the name or 'tag' of a context
Always contains the value "SITUATIONAL TRIGGER".
Not Used
1-2
9998
Context Reference
O 1
AN
1/50
Required
2
721
Segment ID Code
O 1
ID
2/3
Code specifying the segment ID of the data segment in error (See Appendix A - Number 77)
CODE SOURCE 77: X12 Directories
Required
3
719
Segment Position in Transaction Set
O 1
N
1/10
The numerical count position of this data segment from the start of the transaction set: the transaction set header is count position 1
Situational
4
447
Loop Identifier Code
O 1
AN
1/6
The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE
SITUATIONAL RULE: Required when the loop identifier value from the transaction set is known by the submitter of this 999. If not required by this implementation guide, do not send.
Required
5
C030
Position in Segment
O 1
Code indicating the relative position of the simple data element or composite data structure in error within a segment, count beginning with 1 for the position immediately following the segment ID; additionally indicating the relative position of a repeating structure in error, count beginning with 1 for the position immediately following the preceding element separator; additionally indicating the relative position of a component of a composite data structure in error, count beginning with 1 for the position following the preceding element or repetition separator
Required
5-1
722
Element Position in Segment
M 1
N
1/2
This is used to indicate the relative position of a simple data element, or the relative position of a composite data structure with the relative position of the component within the composite data structure, in error; in the data segment the count starts with 1 for the simple data element or composite data structure immediately following the segment ID
Situational
5-2
1528
Component Data Element Position in Composite
O 1
N
1/2
To identify the component data element position within the composite that is in error
SITUATIONAL RULE: Required when the situational requirement relates to a component data element within a composite data structure. If not required by this implementation guide, do not send.
Situational
5-3
1686
Repeating Data Element Position
O 1
N
1/4
To identify the specific repetition of a data element that is in error
SITUATIONAL RULE: Required when the situational requirement relates to a repeating data element. If not required by this implementation guide, do not send.
Situational
6
C999
Reference in Segment
O 1
To hold the reference number of a data element and optionally a component data element within a composite
X12 COMPOSITE SEMANTIC NOTES:
  1. This element holds the reference number of the simple or composite element at segment level.
  2. This element holds the reference number of the simple element within a composite.
SITUATIONAL RULE: Required when CTX05 is used and the data element reference number of the data element identified in CTX05-1 is known by the submitter of the 999. If not required by this implementation guide, do not send.
Required
6-1
725
Data Element Reference Code
M 1
AN
1/4
Code identifying the location of the data element in the Data Element Dictionary
INDUSTRY NAME: Data Element Reference Number
CODE SOURCE 77: X12 Directories
Not Used
6-2
725
Data Element Reference Code
O 1
AN
1/4

IK5 - TRANSACTION SET RESPONSE TRAILER

X12 Name:
Implementation Transaction Set Response Trailer
X12 Purpose:
To acknowledge acceptance or rejection and report implementation errors in a transaction set
X12 Set Notes:
NOTE: If any implementation guide errors have been reported in IK3 or IK4, then code I5 shall be reported in the IK5 Segment.
Loop:
Loop Usage:
Situational
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
IK5✱R✱5~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
717
Transaction Set Acknowledgment Code
M 1
ID
1
Code indicating accept or reject condition based on the syntax editing of the transaction set
CODE
DEFINITION
A
Accepted
E
Accepted But Errors Were Noted
The transaction set indicated in this AK2 loop contained errors, but was forwarded for further processing.
M
Rejected, Message Authentication Code (MAC) Failed
R
Rejected
The transaction set indicated in this AK2 loop contained errors, and was NOT forwarded for further processing. It will need to be corrected and resubmitted.
W
Rejected, Assurance Failed Validity Tests
X
Rejected, Content After Decryption Could Not Be Analyzed
Situational
2
618
Implementation Transaction Set Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a transaction set
SITUATIONAL RULE: Required when IK501 = E or R. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Transaction Set Not Supported
2
Transaction Set Trailer Missing
3
Transaction Set Control Number in Header and Trailer Do Not Match
4
Number of Included Segments Does Not Match Actual Count
5
One or More Segments in Error
6
Missing or Invalid Transaction Set Identifier
7
Missing or Invalid Transaction Set Control Number
8
Authentication Key Name Unknown
9
Encryption Key Name Unknown
10
Requested Service (Authentication or Encrypted) Not Available
11
Unknown Security Recipient
12
Incorrect Message Length (Encryption Only)
13
Message Authentication Code Failed
15
Unknown Security Originator
16
Syntax Error in Decrypted Text
17
Security Not Supported
18
Transaction Set not in Functional Group
19
Invalid Transaction Set Implementation Convention Reference
23
Transaction Set Control Number Not Unique within the Functional Group
24
S3E Security End Segment Missing for S3S Security Start Segment
25
S3S Security Start Segment Missing for S3E Security End Segment
26
S4E Security End Segment Missing for S4S Security Start Segment
27
S4S Security Start Segment Missing for S4E Security End Segment
I5
Implementation One or More Segments in Error
I6
Implementation Convention Not Supported
Situational
3
618
Implementation Transaction Set Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a transaction set
SITUATIONAL RULE: Required when IK501 = E or R, and IK502 has been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Transaction Set Not Supported
2
Transaction Set Trailer Missing
3
Transaction Set Control Number in Header and Trailer Do Not Match
4
Number of Included Segments Does Not Match Actual Count
5
One or More Segments in Error
6
Missing or Invalid Transaction Set Identifier
7
Missing or Invalid Transaction Set Control Number
8
Authentication Key Name Unknown
9
Encryption Key Name Unknown
10
Requested Service (Authentication or Encrypted) Not Available
11
Unknown Security Recipient
12
Incorrect Message Length (Encryption Only)
13
Message Authentication Code Failed
15
Unknown Security Originator
16
Syntax Error in Decrypted Text
17
Security Not Supported
18
Transaction Set not in Functional Group
19
Invalid Transaction Set Implementation Convention Reference
23
Transaction Set Control Number Not Unique within the Functional Group
24
S3E Security End Segment Missing for S3S Security Start Segment
25
S3S Security Start Segment Missing for S3E Security End Segment
26
S4E Security End Segment Missing for S4S Security Start Segment
27
S4S Security Start Segment Missing for S4E Security End Segment
I5
Implementation One or More Segments in Error
I6
Implementation Convention Not Supported
Situational
4
618
Implementation Transaction Set Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a transaction set
SITUATIONAL RULE: Required when IK501 = E or R, and IK502 and IK503 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Transaction Set Not Supported
2
Transaction Set Trailer Missing
3
Transaction Set Control Number in Header and Trailer Do Not Match
4
Number of Included Segments Does Not Match Actual Count
5
One or More Segments in Error
6
Missing or Invalid Transaction Set Identifier
7
Missing or Invalid Transaction Set Control Number
8
Authentication Key Name Unknown
9
Encryption Key Name Unknown
10
Requested Service (Authentication or Encrypted) Not Available
11
Unknown Security Recipient
12
Incorrect Message Length (Encryption Only)
13
Message Authentication Code Failed
15
Unknown Security Originator
16
Syntax Error in Decrypted Text
17
Security Not Supported
18
Transaction Set not in Functional Group
19
Invalid Transaction Set Implementation Convention Reference
23
Transaction Set Control Number Not Unique within the Functional Group
24
S3E Security End Segment Missing for S3S Security Start Segment
25
S3S Security Start Segment Missing for S3E Security End Segment
26
S4E Security End Segment Missing for S4S Security Start Segment
27
S4S Security Start Segment Missing for S4E Security End Segment
I5
Implementation One or More Segments in Error
I6
Implementation Convention Not Supported
Situational
5
618
Implementation Transaction Set Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a transaction set
SITUATIONAL RULE: Required when IK501 = E or R, and IK502, IK503, and IK504 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Transaction Set Not Supported
2
Transaction Set Trailer Missing
3
Transaction Set Control Number in Header and Trailer Do Not Match
4
Number of Included Segments Does Not Match Actual Count
5
One or More Segments in Error
6
Missing or Invalid Transaction Set Identifier
7
Missing or Invalid Transaction Set Control Number
8
Authentication Key Name Unknown
9
Encryption Key Name Unknown
10
Requested Service (Authentication or Encrypted) Not Available
11
Unknown Security Recipient
12
Incorrect Message Length (Encryption Only)
13
Message Authentication Code Failed
15
Unknown Security Originator
16
Syntax Error in Decrypted Text
17
Security Not Supported
18
Transaction Set not in Functional Group
19
Invalid Transaction Set Implementation Convention Reference
23
Transaction Set Control Number Not Unique within the Functional Group
24
S3E Security End Segment Missing for S3S Security Start Segment
25
S3S Security Start Segment Missing for S3E Security End Segment
26
S4E Security End Segment Missing for S4S Security Start Segment
27
S4S Security Start Segment Missing for S4E Security End Segment
I5
Implementation One or More Segments in Error
I6
Implementation Convention Not Supported
Situational
6
618
Implementation Transaction Set Syntax Error Code
O 1
ID
1/3
Code indicating implementation error found based on the syntax editing of a transaction set
SITUATIONAL RULE: Required when IK501 = E or R, and IK502, IK503, IK504, and IK505 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Transaction Set Not Supported
2
Transaction Set Trailer Missing
3
Transaction Set Control Number in Header and Trailer Do Not Match
4
Number of Included Segments Does Not Match Actual Count
5
One or More Segments in Error
6
Missing or Invalid Transaction Set Identifier
7
Missing or Invalid Transaction Set Control Number
8
Authentication Key Name Unknown
9
Encryption Key Name Unknown
10
Requested Service (Authentication or Encrypted) Not Available
11
Unknown Security Recipient
12
Incorrect Message Length (Encryption Only)
13
Message Authentication Code Failed
15
Unknown Security Originator
16
Syntax Error in Decrypted Text
17
Security Not Supported
18
Transaction Set not in Functional Group
19
Invalid Transaction Set Implementation Convention Reference
23
Transaction Set Control Number Not Unique within the Functional Group
24
S3E Security End Segment Missing for S3S Security Start Segment
25
S3S Security Start Segment Missing for S3E Security End Segment
26
S4E Security End Segment Missing for S4S Security Start Segment
27
S4S Security Start Segment Missing for S4E Security End Segment
I5
Implementation One or More Segments in Error
I6
Implementation Convention Not Supported

AK9 - FUNCTIONAL GROUP RESPONSE TRAILER

X12 Name:
Functional Group Response Trailer
X12 Purpose:
To acknowledge acceptance or rejection of a functional group and report the number of included transaction sets from the original trailer, the accepted sets, and the received sets in this functional group
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
AK9✱R✱1✱1✱0~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
715
Functional Group Acknowledge Code
M 1
ID
1
Code indicating accept or reject condition based on the syntax editing of the functional group
COMMENT: If AK901 contains the value "A" or "E", then the transmitted functional group is accepted.
CODE
DEFINITION
A
Accepted
This code value can only be used if there are no AK2 loops or all IK501 values = 'A'.
E
Accepted, But Errors Were Noted.
The functional group indicated in this 999 contained errors, but was forwarded for further processing.
M
Rejected, Message Authentication Code (MAC) Failed
P
Partially Accepted, At Least One Transaction Set Was Rejected
R
Rejected
The functional group indicated in this 999 contained errors, and was NOT forwarded for further processing. It will need to be corrected and resubmitted.
W
Rejected, Assurance Failed Validity Tests
X
Rejected, Content After Decryption Could Not Be Analyzed
Required
2
97
Number of Transaction Sets Included
M 1
N
1/6
Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element
Required
3
123
Number of Received Transaction Sets
M 1
N
1/6
Number of Transaction Sets received
Required
4
2
Number of Accepted Transaction Sets
M 1
N
1/6
Number of accepted Transaction Sets in a Functional Group
Situational
5
716
Functional Group Syntax Error Code
O 1
ID
1/3
Code indicating error found based on the syntax editing of the functional group header and/or trailer
SITUATIONAL RULE: Required when AK901 = E or R, and the error is at the functional group level. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Functional Group Not Supported
2
Functional Group Version Not Supported
3
Functional Group Trailer Missing
4
Group Control Number in the Functional Group Header and Trailer Do Not Agree
5
Number of Included Transaction Sets Does Not Match Actual Count
6
Group Control Number Violates Syntax
7
Invalid Application Sender's Code
8
Invalid Application Receiver's Code
9
Invalid Responsible Agency Code
10
Authentication Key Name Unknown
11
Encryption Key Name Unknown
12
Requested Service (Authentication or Encryption) Not Available
13
Unknown Security Recipient
14
Unknown Security Originator
15
Syntax Error in Decrypted Text
16
Security Not Supported
17
Incorrect Message Length (Encryption Only)
18
Message Authentication Code Failed
19
Functional Group Control Number not Unique within Interchange
23
S3E Security End Segment Missing for S3S Security Start Segment
24
S3S Security Start Segment Missing for S3E End Segment
25
S4E Security End Segment Missing for S4S Security Start Segment
26
S4S Security Start Segment Missing for S4E Security End Segment
30
Invalid Group Date
31
Invalid Group Time
32
Control Segments for One or More Included Transaction Sets were Syntactically Invalid
Situational
6
716
Functional Group Syntax Error Code
O 1
ID
1/3
Code indicating error found based on the syntax editing of the functional group header and/or trailer
SITUATIONAL RULE: Required when AK901 = E or R, and AK905 has been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Functional Group Not Supported
2
Functional Group Version Not Supported
3
Functional Group Trailer Missing
4
Group Control Number in the Functional Group Header and Trailer Do Not Agree
5
Number of Included Transaction Sets Does Not Match Actual Count
6
Group Control Number Violates Syntax
7
Invalid Application Sender's Code
8
Invalid Application Receiver's Code
9
Invalid Responsible Agency Code
10
Authentication Key Name Unknown
11
Encryption Key Name Unknown
12
Requested Service (Authentication or Encryption) Not Available
13
Unknown Security Recipient
14
Unknown Security Originator
15
Syntax Error in Decrypted Text
16
Security Not Supported
17
Incorrect Message Length (Encryption Only)
18
Message Authentication Code Failed
19
Functional Group Control Number not Unique within Interchange
23
S3E Security End Segment Missing for S3S Security Start Segment
24
S3S Security Start Segment Missing for S3E End Segment
25
S4E Security End Segment Missing for S4S Security Start Segment
26
S4S Security Start Segment Missing for S4E Security End Segment
30
Invalid Group Date
31
Invalid Group Time
32
Control Segments for One or More Included Transaction Sets were Syntactically Invalid
Situational
7
716
Functional Group Syntax Error Code
O 1
ID
1/3
Code indicating error found based on the syntax editing of the functional group header and/or trailer
SITUATIONAL RULE: Required when AK901 = E or R, and AK905 and AK906 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Functional Group Not Supported
2
Functional Group Version Not Supported
3
Functional Group Trailer Missing
4
Group Control Number in the Functional Group Header and Trailer Do Not Agree
5
Number of Included Transaction Sets Does Not Match Actual Count
6
Group Control Number Violates Syntax
7
Invalid Application Sender's Code
8
Invalid Application Receiver's Code
9
Invalid Responsible Agency Code
10
Authentication Key Name Unknown
11
Encryption Key Name Unknown
12
Requested Service (Authentication or Encryption) Not Available
13
Unknown Security Recipient
14
Unknown Security Originator
15
Syntax Error in Decrypted Text
16
Security Not Supported
17
Incorrect Message Length (Encryption Only)
18
Message Authentication Code Failed
19
Functional Group Control Number not Unique within Interchange
23
S3E Security End Segment Missing for S3S Security Start Segment
24
S3S Security Start Segment Missing for S3E End Segment
25
S4E Security End Segment Missing for S4S Security Start Segment
26
S4S Security Start Segment Missing for S4E Security End Segment
30
Invalid Group Date
31
Invalid Group Time
32
Control Segments for One or More Included Transaction Sets were Syntactically Invalid
Situational
8
716
Functional Group Syntax Error Code
O 1
ID
1/3
Code indicating error found based on the syntax editing of the functional group header and/or trailer
SITUATIONAL RULE: Required when AK901 = E or R, and AK905, AK906, and AK907 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Functional Group Not Supported
2
Functional Group Version Not Supported
3
Functional Group Trailer Missing
4
Group Control Number in the Functional Group Header and Trailer Do Not Agree
5
Number of Included Transaction Sets Does Not Match Actual Count
6
Group Control Number Violates Syntax
7
Invalid Application Sender's Code
8
Invalid Application Receiver's Code
9
Invalid Responsible Agency Code
10
Authentication Key Name Unknown
11
Encryption Key Name Unknown
12
Requested Service (Authentication or Encryption) Not Available
13
Unknown Security Recipient
14
Unknown Security Originator
15
Syntax Error in Decrypted Text
16
Security Not Supported
17
Incorrect Message Length (Encryption Only)
18
Message Authentication Code Failed
19
Functional Group Control Number not Unique within Interchange
23
S3E Security End Segment Missing for S3S Security Start Segment
24
S3S Security Start Segment Missing for S3E End Segment
25
S4E Security End Segment Missing for S4S Security Start Segment
26
S4S Security Start Segment Missing for S4E Security End Segment
30
Invalid Group Date
31
Invalid Group Time
32
Control Segments for One or More Included Transaction Sets were Syntactically Invalid
Situational
9
716
Functional Group Syntax Error Code
O 1
ID
1/3
Code indicating error found based on the syntax editing of the functional group header and/or trailer
SITUATIONAL RULE: Required when AK901 = E or R, and AK905, AK906, AK907, and AK908 have been used, and there are additional error codes to report. If not required by this implementation guide, do not send.
CODE
DEFINITION
1
Functional Group Not Supported
2
Functional Group Version Not Supported
3
Functional Group Trailer Missing
4
Group Control Number in the Functional Group Header and Trailer Do Not Agree
5
Number of Included Transaction Sets Does Not Match Actual Count
6
Group Control Number Violates Syntax
7
Invalid Application Sender's Code
8
Invalid Application Receiver's Code
9
Invalid Responsible Agency Code
10
Authentication Key Name Unknown
11
Encryption Key Name Unknown
12
Requested Service (Authentication or Encryption) Not Available
13
Unknown Security Recipient
14
Unknown Security Originator
15
Syntax Error in Decrypted Text
16
Security Not Supported
17
Incorrect Message Length (Encryption Only)
18
Message Authentication Code Failed
19
Functional Group Control Number not Unique within Interchange
23
S3E Security End Segment Missing for S3S Security Start Segment
24
S3S Security Start Segment Missing for S3E End Segment
25
S4E Security End Segment Missing for S4S Security Start Segment
26
S4S Security Start Segment Missing for S4E Security End Segment
30
Invalid Group Date
31
Invalid Group Time
32
Control Segments for One or More Included Transaction Sets were Syntactically Invalid

SE - TRANSACTION SET TRAILER

X12 Name:
Transaction Set Trailer
X12 Purpose:
To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
X12 Comments:
SE is the last segment of each transaction set.
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
SE✱1230✱0002~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
96
Number of Included Segments
M 1
N
1/10
Total number of segments included in a transaction set including ST and SE segments
Required
2
329
Transaction Set Control Number
M 1
AN
4/9
Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
The Transaction Set Control Number in ST02 and SE02 must be identical.

GE - FUNCTIONAL GROUP TRAILER

X12 Name:
Functional Group Trailer
X12 Purpose:
To indicate the end of a functional group and to provide control information
X12 Comments:
The use of identical data interchange control numbers in the associated functional group header and trailer is designed to maximize functional group integrity. The control number is the same as that used in the corresponding header.
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
GE✱1✱1~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
97
Number of Transaction Sets Included
M 1
N
1/6
Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element
Required
2
28
Group Control Number
M 1
N
1/9
Assigned number originated and maintained by the sender
SEMANTIC: The data interchange control number GE02 in this trailer must be identical to the same data element in the associated functional group header, GS06.

IEA - INTERCHANGE CONTROL TRAILER

X12 Name:
Interchange Control Trailer
X12 Purpose:
To define the end of an interchange of zero or more functional groups and interchange-related control segments
Segment Usage:
Required
Segment Repeat:
1
TR3 Example:
IEA✱1✱000000905~
USAGE
SEQ
D.E. NUM
NAME
ATTRIBUTES
Required
1
I16
Number of Included Functional Groups
M 1
N
1/5
A count of the number of functional groups included in an interchange
Required
2
I12
Interchange Control Number
M 1
N
9
A control number assigned by the interchange sender
The Value in IEA02 must be identical to the value in ISA13.
logo

999 Implementation Acknowledgment for Health Care Insurance (008020X335)

JANUARY 2022

Copyright © 2008-22, X12 Incorporated, Format © 2008-22 Washington Publishing Company. Exclusively published by the Washington Publishing Company. No part of this publication may be distributed, posted, reproduced, stored in a retrieval system, or transmitted in any form or by any means without the prior written permission of the copyright owner.

All rights reserved.

Abstract

The purpose of this implementation guide is to provide standardized data content and structure to users of the X12 999 transaction set.

Preface

X12 standards are developed to identify the broadest data requirements for a transaction set. Type 3 Technical Reports (TR3), also known as implementation guides, define the explicit data requirements for a specific business purpose. Trading partners who implement according to the instructions in this TR3 can exchange data consistently with multiple trading partners.

As X12 does not define transport requirements, trading partners define their specific transport requirements separately.

1.1 Implementation Purpose and Scope

For the health care industry to achieve the potential administrative cost savings with Electronic Data Interchange (EDI), standards have been developed to facilitate consistent implementation by all organizations. To facilitate a smooth transition into the EDI environment, uniform implementation is critical.

The purpose of this implementation guide is to provide standardized data content and structure to users of the X12 999 transaction set for Health Care Insurance. This implementation guide is intended to enable a receiver of a functional group based on an X12 Implementation Guideline (TR3) related to Health Care Insurance business processes, to report errors as specified by that transaction's implementation guideline (TR3), or to acknowledge receipt of an error-free transaction set.

1.2 Version Information

This implementation guide is based on the October 2020 X12 standards, referred to as Version 8, Release 2 (008020).

The unique Version/Release/Industry Identifier Code for transaction sets that are defined by this implementation guide is 008020X335.

The two-character Functional Identifier Code for the transaction set included in this implementation guide:

  • FA   Functional or Implementation Acknowledgment Transaction Sets (997, 999)

The Version/Release/Industry Identifier Code and the applicable Functional Identifier Code must be transmitted in the Functional Group Header (GS segment) that begins a functional group of these transaction sets. For more information, see the descriptions of GS01 and GS08 in Appendix C EDI Control Directory.

1.3.1 Batch and Real-Time Usage

There are multiple methods available for sending and receiving business transactions electronically. Two common modes for EDI transactions are batch and real-time.

Batch - In a batch mode the sender does not remain connected while the receiver processes the transactions. Processing is usually completed according to a set schedule. If there is an associated business response transaction (such as a 271 Response to a 270 Request for Eligibility), the receiver creates the response transaction and stores it for future delivery or transmits the response transaction back to the sender of the original transaction. The sender of the original transmission reconnects at a later time and picks up the response transaction. Note: The sender of the original transmission may not always be the entity that picks up the response transaction at a later time (e.g. Provider submitting through a clearinghouse.)

Real-Time - In real-time mode the sender remains connected while the receiver processes the transactions and returns a response transaction to the sender. This implementation guide does not set specific response time parameters for implementers.

This implementation guide was based on requirements for batch mode. Willing trading partners may use batch or real-time mode.

1.3.2 Other Usage Limitations

The X12 999 transaction set is designed to report on conformance against an implementation guideline (TR3), but can also report on conformance with the standard syntax requirements.

The 999 is not limited to only IG errors. It can report standard syntax errors, as well as IG errors.

This 999 implementation guide can NOT be used for any application level validations.

The X12 999 transaction set is designed to respond to one and only one functional group (i.e. GS/GE), but will respond to all transaction sets (i.e. ST/SE) within that functional group.

When acknowledging a healthcare implementation guide (TR3) based transaction, only a single transaction set 999 can be used. When acknowledging a healthcare implementation guide (TR3) based transaction, the transaction set 997 must not be used.

This X12 999 Implementation Guideline must NOT be used to respond to any management transaction sets intended for acknowledgments, i.e. TS 997 and 999, or interchange control segments related to acknowledgments, i.e. TA1 and TA3.

1.4 Business Usage

This X12 999 implementation guide (TR3) is intended to meet the needs of the Health Care industry as a whole;

  1. for a standard implementation guideline designed for reporting of syntactical errors against a functional group based on an X12 Implementation Guideline,
  2. to report receipt of a functional group that fully complies with an implementation guideline.

For more information on the relationship between the 999 transaction set and other response transaction sets, refer to the X12 document "X12 Acknowledgement Reference Model".

1.4.1 Health Care Transaction Flow

Each X12 implementation guide explains how to use X12 transaction sets to meet a single defined business purpose. The diagrams found at https://www.x12.org/flow depict the business functions supported by the X12 health care implementation guides.

1.5 Business Terminology

To ensure consistent use of terms, definitions, and acronyms across X12 products, X12 maintains the Wordbook, a comprehensive corporate glossary. The included terms are either proprietary to X12, cite definitions published by another authority, or represent common terms and definitions that are relevant to X12's work. The terms and definitions defined in the Wordbook are used in X12 work products when applicable, without modification or revision. The Wordbook can be referenced online at wordbook.x12.org.

1.6 Transaction Acknowledgments

The purpose of transaction acknowledgments is to report to the sender whether the transaction being acknowledged was accepted or rejected.

The X12 Technical Report Type 2, Acknowledgment Reference Model provides guidance on several control structures and transaction set standards intended to augment EDI auditing and control systems.

1.7 Related Transactions

This X12 999 Implementation Guide (TR3) is designed for responding to Health Care transactions based upon an Implementation Guide.

1.8 Trading Partner Agreements

Trading partner agreements are used to establish and document the relationship between trading partners. A trading partner agreement must not override the specifications in this implementation guide if a transmission is reported in GS08 to be a product of this implementation guide.

1.9 Transaction Compliance

There are three types of compliance that may be relevant to a transmitted transaction.

Compliance with implementation guide requirements

Compliance with state and federal regulation

Compliance with trading partner contractual agreements

1.9.1 Transaction Compliance with Implementation Guide Requirements

A transaction complies with X12 implementation guide requirements if the transaction satisfies all format and content rules and constraints specified in the applicable X12 standards and the implementation guide (also known as a TR3) itself.

Should additional clarification of an X12 implementation guide requirement be desired, two options are available.

X12 does not specify the business rules that the receiving entity must use to decide when to accept or reject a transaction. The receiver will handle transactions that are not TR3-compliant based on its own business process.

A receiver may specify its business rules in a trading partner agreement or companion document. As stated in §1.8, these documents do not override TR3 requirements, nor change how transaction compliance with this TR3 is determined.

1.9.2 Transaction Compliance with State and Federal Regulations

This implementation guide has been developed for use as an insurance industry implementation guide. At the time of publication it has not been adopted as a state or federal standard. Should this implementation guide be adopted as a standard, the adopting authority will establish compliance dates for its use by impacted entities.

X12 is not the authority for determining compliance with regulatory requirements that might further constrain implementation guide requirements. Questions of compliance for regulatory requirements should be directed to the governing authority.

X12 does not specify the business rules that the receiving entity must use to decide when to accept or reject a transaction. The receiver will handle transactions that do not comply with applicable regulatory requirements as specified by the applicable regulation(s) or governing authority.

1.9.3 Transaction Compliance with Contractual Requirements

X12 is not the authority for determining compliance with contractual requirements that might further constrain implementation guide requirements. Questions of compliance for contractual requirements should be directed to the contracting entity.

X12 does not specify the business rules that the receiving entity must use to decide when to accept or reject a transaction. The receiver will handle transactions that do not comply with contractual requirements as specified by the applicable contract or contracting entity.

1.10.1 Overall Data Architecture

NOTE
See X12.6 to review the transaction set structure, including descriptions of segments, data elements, levels and loops.

1.10.1.1 Response Process

For more information on the relationship between the 999 transaction set and other response transaction sets, refer to X12 document Acknowledgment Reference Manual, Chapter 6. Use the following link to access the X12 Acknowledgment Reference Manual.

2. Transaction Set

NOTE
See X12 documents X12.5, X12.6, and X12.59 to review transaction set structure, including descriptions of segments, levels, and loops.

2.1 Presentation Examples

The X12 standards are generic. For example, multiple trading communities use the same PER segment to specify administrative communication contacts. Each community decides which elements to use and which code values in those elements are applicable.

This implementation guide uses a format that depicts both the generalized standard and the insurance industry-specific implementation. In this implementation guide, IMPLEMENTATION specifies the requirements for this implementation. X12 STANDARD is included as a reference only.

The transaction set presentation is comprised of two main sections with subsections within the main sections:

Transaction Set Listing

There are two sub-sections under this general title. The first sub-section concerns this implementation of a generic X12 transaction set. The second sub-section concerns the generic X12 standard itself.

This section lists the levels, loops, and segments contained in this implementation. It also serves as an index to the segment detail.

This section is included as a reference.

Segment Detail

There are three sub-sections under this general title. This section repeats once for each segment used in this implementation providing segment specific detail and X12 standard detail.

This section is included as a reference.

This section is included as a reference. It provides a pictorial view of the standard and shows which elements are used in this implementation.

This section specifies the implementation details of each data element.

These illustrations (Figures 2.1 through 2.5) are examples and are not extracted from the Section 2 detail in this implementation guide. Annotated illustrations, presented below in the same order they appear in this implementation guide, describe the format of the transaction set that follows.

Figure 2.1 - Transaction Set Key - Implementation

Transaction Set Key - Implementation

Figure 2.2 - Transaction Set Key - Standard

Transaction Set Key - Standard

Figure 2.3 - Segment Key - Implementation

Segment Key - Implementation

Figure 2.4 - Segment Key - Diagram

Segment Key - Diagram

Figure 2.5 - Segment Key - Element Summary

Segment Key - Element Summary

2.2.1 Industry Usage

Industry Usage describes when loops, segments, and elements are to be sent when complying with this implementation guide. The three choices for Usage are required, not used, and situational. To avoid confusion, these are named differently than the X12 standard Condition Designators (mandatory, optional, and relational).

Required  

This loop/segment/element must always be sent.

Required segments in Situational loops only occur when the loop is used.

Required elements in Situational segments only occur when the segment is used.

Required component elements in Situational composite elements only occur when the composite element is used.

Not Used  

This element must never be sent.

Situational  

Use of this loop/segment/element varies, depending on data content and business context as described in the defining rule. The defining rule is documented in a Situational Rule attached to the item.

There are two forms of Situational Rules.

"Required when <explicit condition statement>. If not required by this implementation guide, may be provided at the sender's discretion, but cannot be required by the receiver."

The data qualified by such a situational rule cannot be required, requested or rejected by the receiver when the condition is not applicable. Transmission of this data is solely at the sender's discretion when the stated condition does not apply.

"Required when <explicit condition statement>. If not required by this implementation guide, do not send."

The data qualified by such a situational rule must not be sent except as described in the explicit condition statement.

2.2.1.1 Determining Transaction Compliance with Industry Usage Requirements

A transmitted transaction complies with the governing implementation guide when it satisfies the requirements as defined within the implementation guide. Specifically, the presence or absence of an item (loop, segment, or element) complies with the industry usage specified by this implementation guide according to the following table.

Industry Usage

Business
Condition
is

Item
is

Transaction
Complies with
Implementation
Guide?

Required

N/A

Sent

Yes

Not Sent

No

Not Used

N/A

Sent

No

Not Sent

Yes

Situational (Required when <explicit condition statement>. If not required by this implementation guide, may be provided at the sender's discretion, but cannot be required by the receiver.)

True

Sent

Yes

Not Sent

No

Not True

Sent

Yes

Not Sent

Yes

Situational (Required when <explicit condition statement>. If not required by this implementation guide, do not send.)

True

Sent

Yes

Not Sent

No

Not True

Sent

No

Not Sent

Yes

2.2.2 Loops

Loop requirements depend on the context or location of the loop within the transaction. See Appendix B for more information on loops.

  • A nested loop can be used only when the associated higher level loop is used.
  • The usage of a loop is the same as the usage of its beginning segment.
    • If a loop's beginning segment is Required, the loop is Required and must occur at least once unless it is nested in a loop that is not being used.
    • If a loop's beginning segment is Situational, the loop is Situational.
  • Subsequent segments within a loop can be sent only when the beginning segment is used.
  • Required segments in Situational loops occur only when the loop is used.

3. Examples

Business scenario examples for use of this transaction can be found on the X12 Examples website at http://examples.x12.org. The X12 Examples website provides convenient access to examples of X12 transaction transmissions, including the data stream and a description of the associated scenario.

 

Appendix A. External Code Sources

Prior to this publication, X12 TR3s contained a subset of the overall Code Source Directory, formerly known as Appendix A of X12.3. External code lists are not part of the X12 standard and are provided for information purposes only. The full listing is available in Glass, X12's On-Line viewer.

Read more about Glass here: https://glasshelp.x12.org/.

Where an external code source is referenced in this publication, the implementer is required to use only the codes from that list. Codes must be reported as listed in the code source (e.g. with leading zeroes). Implementers must follow the instructions for code use that are supplied by the code set owner.

 

B.1.1 X12 Referenced and Related Standards

This technical report is based on the X12 EDI standard which comprises a series of interdependent publications. Implementers are advised to consult these publications when using this technical report.

The following standards are required to interpret, understand, and use this technical report:

  • X12.5 - Interchange Control Structure
  • X12.6 - Application Control Structure

The following guideline is useful to interpret, understand, and use this technical report:

  • Compliance in X12

The following reference model is useful to interpret, understand, and use this technical report:

  • Acknowledgment Reference Model

All of the documents above are available online using links to X12's Online Viewer.

 

B.1.1.1 Transmission Control Schematic

Refer to X12.5 - Interchange Control Structures, Section 3.5 - Order of Control Segments, and Chapter 5 Interchange Segment Specifications.

Similar transaction sets, called "functional groups," can be sent together within a transmission. Each functional group is prefaced by a group start segment, and a functional group is terminated by a group end segment. One or more functional groups are prefaced by an interchange header and followed by an interchange trailer. Figure B.1 - Transmission Control Schematic, illustrates this interchange control.

Figure B.1 - Transmission Control Schematic

Transmission Control Schematic

 

B.1.1.2 Constraints applicable to the suite of TR3s

Refer to X12.6 - Application Control Structure, Section 3.2.8 - Minimums/Maximums.

Data element minimum and maximum lengths are set by the X12 standard. This implementation guide may further restrict minimum and maximum lengths within the bounds set by the standard. Such restrictions may occur implicitly by virtue of the allowed qualifier for the data element, or they may be stated explicitly in a note attached to the element or in the general limitations below.

 

B.1.1.2.1 Maximum Length of Data Element 127 Reference Identification

The current X12 standard allows a maximum length greater than 50 characters for data element 127. For implementations governed by this implementation guide, unless another value is specified in an attached note, the maximum length of each occurrence of this data element is constrained to 50 characters.

 

B.1.1.2.2 Maximum Length of Data Element 782 Monetary Amount

For implementations governed by this implementation guide, unless another value is specified for an instance of Data Element 782 within Section 2 (Transaction Set), each occurrence of Data Element 782 (Monetary Amount) will be limited to a maximum length of 10 characters including reported or implied places for cents (implied value of 00 after the decimal point). Note that the decimal point and leading sign, if sent, are not part of the character count.

EXAMPLE

  • The following transmitted value represents the largest positive dollar amount that can be sent: 99999999.99
  • The following transmitted value is the longest string of characters that can be sent representing whole dollars. 99999999
  • The following transmitted value is the longest string of characters that can be sent representing negative dollars and cents. -99999999.99
  • The following transmitted value is the longest string of characters that can be sent representing negative whole dollars. -99999999
 

B.1.1.3 Decimal

While the X12 standard supports usage of exponential notation, this guide prohibits that usage.

Appendix D. Change Summary

This Implementation Guide (008020X335) defines the X12 requirements for the Implementation Acknowledgment for Health Care Insurance. It is based on version/release/subrelease 008020 of the X12 standards.