X12 999 Implementation Acknowledgment (X231)

X12 Release 5010

Delimiters

• ~ Segment
• * Element
• > Component
• ^ Repetition

ISA Interchange Control Header

Required · Max use 1

ISA-01 · I01 · Authorization Information Qualifier · Required · Identifier (ID)

• 00: No Authorization Information Present (No Meaningful Information in I02)

ISA-02 · I02 · Authorization Information · Required · String (AN) · Min 10 Max 10

ISA-03 · I03 · Security Information Qualifier · Required · Identifier (ID)

• 00: No Security Information Present (No Meaningful Information in I04)

ISA-04 · I04 · Security Information · Required · String (AN) · Min 10 Max 10

ISA-05 · I05 · Interchange ID Qualifier · Required · Identifier (ID) · Min 2 Max 2

Codes

• 01: Duns (Dun & Bradstreet)
• 02: SCAC (Standard Carrier Alpha Code)
• 03: FMC (Federal Maritime Commission)
• 04: IATA (International Air Transport Association)
• 07: Global Location Number (GLN)
• 08: UCC EDI Communications ID (Comm ID)
• 09: X.121 (CCITT)
• 10: Department of Defense (DoD) Activity Address Code
• 11: DEA (Drug Enforcement Administration)
• 12: Phone (Telephone Companies)
• 13: UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code)
• 14: Duns Plus Suffix
• 15: Petroleum Accountants Society of Canada Company Code
• 16: Duns Number With 4-Character Suffix
• 17: American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit)
• 18: Association of American Railroads (AAR) Standard Distribution Code
• 19: EDI Council of Australia (EDICA) Communications ID Number (COMM ID)
• 20: Health Industry Number (HIN)
• 21: Integrated Postsecondary Education Data System, or (IPEDS)
• 22: Federal Interagency Commission on Education, or FICE
• 23: National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES
• 24: The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP
• 25: ACT, Inc. 4-Digit Code of Postsecondary Institutions.
• 26: Statistics of Canada List of Postsecondary Institutions
• 27: Carrier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 28: Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA)
• 29: Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 30: U.S. Federal Tax Identification Number
• 31: Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC)
• 32: U.S. Federal Employer Identification Number (FEIN)
• 33: National Association of Insurance Commissioners Company Code (NAIC)
• 34: Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA)
• 35: Statistics Canada Canadian College Student Information System Institution Codes
• 36: Statistics Canada University Student Information System Institution Codes
• 37: Society of Property Information Compilers and Analysts
• 38: The College Board and ACT, Inc. 6-Digit Code List of Secondary Institutions
• AM: Association Mexicana del Codigo de Producto (AMECOP) Communication ID
• NR: National Retail Merchants Association (NRMA) - Assigned
• SA: User Identification Number as assigned by the Safety and Fitness Electronic Records (SAFER) System
• SN: Standard Address Number
• ZZ: Mutually Defined

ISA-06 · I06 · Interchange Sender ID · Required · String (AN) · Min 15 Max 15

ISA-07 · I05 · Interchange ID Qualifier · Required · Identifier (ID) · Min 2 Max 2

Codes

• 01: Duns (Dun & Bradstreet)
• 02: SCAC (Standard Carrier Alpha Code)
• 03: FMC (Federal Maritime Commission)
• 04: IATA (International Air Transport Association)
• 07: Global Location Number (GLN)
• 08: UCC EDI Communications ID (Comm ID)
• 09: X.121 (CCITT)
• 10: Department of Defense (DoD) Activity Address Code
• 11: DEA (Drug Enforcement Administration)
• 12: Phone (Telephone Companies)
• 13: UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code)
• 14: Duns Plus Suffix
• 15: Petroleum Accountants Society of Canada Company Code
• 16: Duns Number With 4-Character Suffix
• 17: American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit)
• 18: Association of American Railroads (AAR) Standard Distribution Code
• 19: EDI Council of Australia (EDICA) Communications ID Number (COMM ID)
• 20: Health Industry Number (HIN)
• 21: Integrated Postsecondary Education Data System, or (IPEDS)
• 22: Federal Interagency Commission on Education, or FICE
• 23: National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES
• 24: The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP
• 25: ACT, Inc. 4-Digit Code of Postsecondary Institutions.
• 26: Statistics of Canada List of Postsecondary Institutions
• 27: Carrier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 28: Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA)
• 29: Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA)
• 30: U.S. Federal Tax Identification Number
• 31: Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC)
• 32: U.S. Federal Employer Identification Number (FEIN)
• 33: National Association of Insurance Commissioners Company Code (NAIC)
• 34: Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA)
• 35: Statistics Canada Canadian College Student Information System Institution Codes
• 36: Statistics Canada University Student Information System Institution Codes
• 37: Society of Property Information Compilers and Analysts
• 38: The College Board and ACT, Inc. 6-Digit Code List of Secondary Institutions
• AM: Association Mexicana del Codigo de Producto (AMECOP) Communication ID
• NR: National Retail Merchants Association (NRMA) - Assigned
• SA: User Identification Number as assigned by the Safety and Fitness Electronic Records (SAFER) System
• SN: Standard Address Number
• ZZ: Mutually Defined

ISA-08 · I07 · Interchange Receiver ID · Required · String (AN) · Min 15 Max 15

ISA-09 · I08 · Interchange Date · Required · Date (DT) · YYMMDD format

ISA-10 · I09 · Interchange Time · Required · Time (TM) · HHMM format

ISA-11 · I65 · Repetition Separator · Required · String (AN) · Min 1 Max 1

• ^: Repetition Separator

ISA-12 · I11 · Interchange Control Version Number · Required · Identifier (ID)

• 00501: Standards Approved for Publication by ASC X12 Procedures Review Board through October 2003

ISA-13 · I12 · Interchange Control Number · Required · Numeric (N0) · Min 9 Max 9

ISA-14 · I13 · Acknowledgment Requested · Required · Identifier (ID) · Min 1 Max 1

• 0: No Interchange Acknowledgment Requested
• 1: Interchange Acknowledgment Requested (TA1)

ISA-15 · I14 · Interchange Usage Indicator · Required · Identifier (ID) · Min 1 Max 1

• I: Information
• P: Production Data
• T: Test Data

ISA-16 · I15 · Component Element Separator · Required · String (AN) · Min 1 Max 1

• >: Component Element Separator

GS Functional Group Header

Required · Max use 1

GS-01 · 479 · Functional Identifier Code · Required · Identifier (ID)

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

GS-02 · 142 · Application Sender's Code · Required · String (AN) · Min 2 Max 15

GS-03 · 124 · Application Receiver's Code · Required · String (AN) · Min 2 Max 15

GS-04 · 373 · Date · Required · Date (DT) · CCYYMMDD format

GS-05 · 337 · Time · Required · Time (TM) · HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

GS-06 · 28 · Group Control Number · Required · Numeric (N0) · Min 1 Max 9

GS-07 · 455 · Responsible Agency Code · Required · Identifier (ID) · Min 1 Max 2

• T: Transportation Data Coordinating Committee (TDCC)
• X: Accredited Standards Committee X12

GS-08 · 480 · Version / Release / Industry Identifier Code · Required · String (AN)

005010X231

Heading

0100 Heading > ST

ST Transaction Set Header

Required · Max use 1

ST-01 · 143 · Transaction Set Identifier Code · Required · Identifier (ID)

• 999: Implementation Acknowledgment

ST-02 · 329 · Transaction Set Control Number · Required · Numeric (N) · Min 4 Max 9

ST-03 · 1705 · Implementation Convention Reference · Required · String (AN)

005010X231

0200 Heading > AK1

AK1 Functional Group Response Header

Required · Max use 1

AK1-01 · 479 · Functional Identifier Code · Required · Identifier (ID) · Min 2 Max 2

AK1-02 · 28 · Group Control Number · Required · Numeric (N0) · Min 1 Max 9

AK1-03 · 480 · Version, Release, or Industry Identifier Code · Required · String (AN) · Min 1 Max 12

2000 Transaction Set Response Header Loop Optional Max >1

0300 Heading > Transaction Set Response Header Loop > AK2

AK2 Transaction Set Response Header

Required · Max use 1

AK2-01 · 143 · Transaction Set Identifier Code · Required · Identifier (ID) · Min 3 Max 3

AK2-02 · 329 · Transaction Set Control Number · Required · Numeric (N) · Min 4 Max 9

AK2-03 · 1705 · Implementation Convention Reference · Optional · String (AN) · Min 1 Max 35

2100 Error Identification Loop Optional Max >1

0400 Heading > Transaction Set Response Header Loop > Error Identification Loop > IK3

IK3 Error Identification

Required · Max use 1

IK3-01 · 721 · Segment ID Code · Required · Identifier (ID) · Min 2 Max 3

IK3-02 · 719 · Segment Position in Transaction Set · Required · Numeric (N0) · Min 1 Max 10

IK3-03 · 447 · Loop Identifier Code · Optional · String (AN) · Min 1 Max 4

IK3-04 · 620 · Implementation Segment Syntax Error Code · Required · Identifier (ID)

• 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

0500 Heading > Transaction Set Response Header Loop > Error Identification Loop > CTX

CTX Segment Context

Optional · Max use 9

Variants (all may be used)

CTXBusiness Unit Identifier

CTX-01 · C998 · Context Identification · Required Max use 10 · Holds information to identify a context

C998-01 · 9999 · Context Name · Required · String (AN) · Min 1 Max 35

CTX-02 · 721 · Segment ID Code · Required · Identifier (ID) · Min 2 Max 3

CTX-03 · 719 · Segment Position in Transaction Set · Required · Numeric (N0) · Min 1 Max 10

CTX-04 · 447 · Loop Identifier Code · Optional · String (AN) · Min 1 Max 4

CTX-05 · C030 · Position in Segment · Optional Max use 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 · Usage notes

C030-01 · 722 · Element Position in Segment · Required · Numeric (N0) · Min 1 Max 2

C030-02 · 1528 · Component Data Element Position in Composite · Optional · Numeric (N0) · Min 1 Max 2

C030-03 · 1686 · Repeating Data Element Position · Optional · Numeric (N0) · Min 1 Max 4

CTX-06 · C999 · Reference in Segment · Optional Max use 1 · To hold the reference number of a data element and optionally a component data element within a composite · Usage notes

C999-01 · 725 · Data Element Reference Number · Required · Numeric (N0) · Min 1 Max 4

0500 Heading > Transaction Set Response Header Loop > Error Identification Loop > CTX

CTX Business Unit Identifier

Optional · Max use 1

Variants (all may be used)

CTXSegment Context

CTX-01 · C998 · Context Identification · Required Max use 10 · Holds information to identify a context

C998-01 · 9999 · Context Name · Required · String (AN) · Min 1 Max 35

C998-02 · 9998 · Context Reference · Required · String (AN) · Min 1 Max 35

2110 Implementation Data Element Note Loop Optional Max >1

0600 Heading > Transaction Set Response Header Loop > Error Identification Loop > Implementation Data Element Note Loop > IK4

IK4 Implementation Data Element Note

Required · Max use 1

IK4-01 · C030 · Position in Segment · Required Max use 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

C030-01 · 722 · Element Position in Segment · Required · Numeric (N0) · Min 1 Max 2

C030-02 · 1528 · Component Data Element Position in Composite · Optional · Numeric (N0) · Min 1 Max 2

C030-03 · 1686 · Repeating Data Element Position · Optional · Numeric (N0) · Min 1 Max 4

IK4-02 · 725 · Data Element Reference Number · Optional · Numeric (N0) · Min 1 Max 4

IK4-03 · 621 · Implementation Data Element Syntax Error Code · Required · Identifier (ID)

• 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 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

IK4-04 · 724 · Copy of Bad Data Element · Optional · String (AN) · Min 1 Max 99

0700 Heading > Transaction Set Response Header Loop > Error Identification Loop > Implementation Data Element Note Loop > CTX

CTX Element Context

Optional · Max use 10

CTX-01 · C998 · Context Identification · Required Max use 10 · Holds information to identify a context

C998-01 · 9999 · Context Name · Required · String (AN) · Min 1 Max 35

CTX-02 · 721 · Segment ID Code · Required · Identifier (ID) · Min 2 Max 3

CTX-03 · 719 · Segment Position in Transaction Set · Required · Numeric (N0) · Min 1 Max 10

CTX-04 · 447 · Loop Identifier Code · Optional · String (AN) · Min 1 Max 4

CTX-05 · C030 · Position in Segment · Optional Max use 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 · Usage notes

C030-01 · 722 · Element Position in Segment · Required · Numeric (N0) · Min 1 Max 2

C030-02 · 1528 · Component Data Element Position in Composite · Optional · Numeric (N0) · Min 1 Max 2

C030-03 · 1686 · Repeating Data Element Position · Optional · Numeric (N0) · Min 1 Max 4

CTX-06 · C999 · Reference in Segment · Optional Max use 1 · To hold the reference number of a data element and optionally a component data element within a composite · Usage notes

C999-01 · 725 · Data Element Reference Number · Required · Numeric (N0) · Min 1 Max 4

0800 Heading > Transaction Set Response Header Loop > IK5

IK5 Transaction Set Response Trailer

Required · Max use 1

IK5-01 · 717 · Transaction Set Acknowledgment Code · Required · Identifier (ID)

• A: Accepted
• E: Accepted But Errors Were Noted
• M: Rejected, Message Authentication Code (MAC) Failed
• R: Rejected
• W: Rejected, Assurance Failed Validity Tests
• X: Rejected, Content After Decryption Could Not Be Analyzed

IK5-02 · 618 · Implementation Transaction Set Syntax Error Code · Optional · Identifier (ID)

• 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

IK5-03 · 618 · Implementation Transaction Set Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

IK5-04 · 618 · Implementation Transaction Set Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

IK5-05 · 618 · Implementation Transaction Set Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

IK5-06 · 618 · Implementation Transaction Set Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

0900 Heading > AK9

AK9 Functional Group Response Trailer

Required · Max use 1

AK9-01 · 715 · Functional Group Acknowledge Code · Required · Identifier (ID)

• A: Accepted
• E: Accepted, But Errors Were Noted.
• M: Rejected, Message Authentication Code (MAC) Failed
• P: Partially Accepted, At Least One Transaction Set Was Rejected
• R: Rejected
• W: Rejected, Assurance Failed Validity Tests
• X: Rejected, Content After Decryption Could Not Be Analyzed

AK9-02 · 97 · Number of Transaction Sets Included · Required · Numeric (N0) · Min 1 Max 6

AK9-03 · 123 · Number of Received Transaction Sets · Required · Numeric (N0) · Min 1 Max 6

AK9-04 · 2 · Number of Accepted Transaction Sets · Required · Numeric (N0) · Min 1 Max 6

AK9-05 · 716 · Functional Group Syntax Error Code · Optional · Identifier (ID)

• 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
• 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

AK9-06 · 716 · Functional Group Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

AK9-07 · 716 · Functional Group Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

AK9-08 · 716 · Functional Group Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

AK9-09 · 716 · Functional Group Syntax Error Code · Optional · Identifier (ID) · Min 1 Max 3

1000 Heading > SE

SE Transaction Set Trailer

Required · Max use 1

SE-01 · 96 · Number of Included Segments · Required · Numeric (N0) · Min 1 Max 10

SE-02 · 329 · Transaction Set Control Number · Required · Numeric (N) · Min 4 Max 9

GE Functional Group Trailer

Required · Max use 1

GE-01 · 97 · Number of Transaction Sets Included · Required · Numeric (N0) · Min 1 Max 6

GE-02 · 28 · Group Control Number · Required · Numeric (N0) · Min 1 Max 9

IEA Interchange Control Trailer

Required · Max use 1

IEA-01 · I16 · Number of Included Functional Groups · Required · Numeric (N0) · Min 1 Max 5

IEA-02 · I12 · Interchange Control Number · Required · Numeric (N0) · Min 9 Max 9

EDI Samples

Example 1: Response to a Functional Group Containing Three 837s

ISA*00*          *00*          *ZZ*123456789012345*ZZ*123456789012346*080503*1705*^*00501*000010216*0*T*>~
GS*FA*1234567890*2345678901*20080503*1705*20213*X*005010X231~
ST*999*2870001*005010X231~
AK1*HC*17456*005010X222A2~
AK2*837*0001~
IK5*A~
AK2*837*0002~
IK3*CLM*22**8~
CTX*CLM01>123456789~
IK4*2*782*1~
IK5*R*5~
AK2*837*0003~
IK3*REF*57**3~
CTX*SITUATIONAL TRIGGER*CLM*43**5>3~
CTX*CLM01>987654321~
IK5*R*5~
AK9*P*3*3*1~
SE*16*2870001~
GE*1*20213~
IEA*1*000010216~