999 Structure and Data Sources

If the input data contains Type 1, Type 2, or implementation errors, these will be reported in the IK3 (segment errors) and IK4 (element errors).

The 5010 Errata 999 may contain CTX records under certain conditions. See  on page  .

Response Generator’s 999 might include:

IK5         Transaction set acceptance/rejection and why (types 1-2)

AK9         Functional group acceptance/rejection and why (types 1-2)

IK3            Segment with a type 1-8 error.

IK4            Element containing the IK3 error (if the error involves an element).

This example is a typical 999 generated by Response Generator.

"C:\Foresight\Instream\Bin\RespGen.exe" -version

pause ISA*00* *00* *01*9088877320000 *01*9012345720000

*090706*1448*^*00501*000000001*0*P*:~

GS*FA*908887732000*901234572000*20090706*144828*1*X*005010X231~

ST*999*0001*005010X231~

AK1*HC*370~

AK2*837*0370~

IK3*N4*9*2010AA*8~

IK4*1*19*7~

IK4*4*26*I12~

IK3*CLM*31*2400*I6~

IK3*NM1*36*2310A*8~

IK4*3*1035*7~

IK3*HL*40*2400*I6~

CTX: Context Record Segments in 999s

In previous releases, Response Generator created a CTX segment in the 999 if the IK304 and/or IK403 started with “I” for Implementation syntax errors. Now, CTX generation is under your control. You can choose:

For details, refer Appendix I CTX Segments in Response Generator 999s.

This table describes the 999 created by Response Generator

 

Loop ID

 

I tem

 

Name

Max Use

Base Req

Elem Type

Elem Len.

Min-Max

 

Source of Value

 

Alternate Configuration

 

ISA

Interchange Control Header

1

O

 

 

 

 
 

 

ISA01

Authorization Information Qualifier

1

M

ID

2-2

00 no authorization information present

 

 

ISA01

Authorization Information Qualifier

1

M

ID

2-2

00 no authorization information present

 

 

ISA02

Authorization Information

1

M

AN

10-10

Blank (ten spaces)

 

 

ISA03

Security Information Qualifier

1

M

ID

2-2

00 no authorization information present

 

 

ISA04

Security Information

1

M

AN

10-10

Blank (ten spaces)

dis

 

ISA05

Interchange ID Qualifier

1

M

ID

2-2

From initiating transaction’s ISA07

dis

 

ISA06

Interchange Sender ID

1

M

AN

15-15

From initiating transaction’s ISA08

dir

 

ISA07

Interchange ID Qualifier

1

M

ID

2-2

From initiating transaction’s ISA05

dir

 

ISA08

Interchange Receiver ID

1

M

AN

15-15

From initiating transaction’s ISA06

 

 

ISA09

Interchange Date

1

M

DT

6-6

Current date in YYMMDD format

 

 

ISA10

Interchange Time

1

M

TM

4-4

Current time in HHMM format

 

 

ISA11

Interchange Control Standards Identifier

1

M

ID

1-1

U US EDI Community of ASC X12, TDCC, and UCS

 

 

ISA12

Interchange Control Version Number

1

M

ID

5-5

00501

 

 

ISA13

Interchange Control Number

1

M

N0

9-9

Specified interchange control number, zero-filled, starting at “000000001”, and increments by 1 for each Control Number

 

 

ISA14

Acknowledgment Requested

1

M

ID

1-1

0 No acknowledgment requested

diu

 

ISA15

Usage Indicator

1

M

ID

1-1

P production Data

 

 

ISA16

Component Element Separator

1

M

AN

1-1

Sub-element separator character in effect (Default ‘:’)

 

 

GS

Functional Group Header

1

O

 

 

 

 

 

GS01

Functional Identifier Code

1

M

ID

2-2

FA functional acknowledgment

 

 

GS02

Application Sender's Code

1

M

AN

2-15

From initiating transaction’s GS03

das

 

GS03

Application Receiver's Code

1

M

AN

2-15

From initiating transaction’s GS02

dar

 

GS04

Date

1

M

DT

8-8

Current date in YYYYMMDD format

 

 

GS05

Time

1

M

TM

4-8

Current time in HHMMSS format

 

 

GS06

Group Control Number

1

M

N0

1-9

Specified Group Control Number

 

 

GS07

Responsible Agency Code

1

M

ID

1-2

X Accredited Standards Committee X12

 

 

GS08

Version / Release / Industry Identifier Code

1

M

AN

1-12

See page GS08    480    Version/Release/Industry Identifier Code.

dav

 

ST

Transaction Set Header

1

M

 

 

 

 

 

ST01

Transaction Set Identifier Code

1

M

ID

3-3

999

 

 

ST02

Transaction Set Control Number

1

M

AN

4-9

Specified transaction control number, zero-filled, starting at “0001”, and increments by 1 for each transaction control number

 

 

ST03

Implementation Convention Reference

1

M

AN

1-35

 

 

 

AK1

Functional Group Response Header

1

M

 

 

 

 

 

AK101

Functional Identifier Code

1

M

ID

2-2

From initiating transaction’s GS01

 

 

AK102

Group Control Number

1

M

N0

1-9

From initiating transaction’s GS06

 

 

AK103

Vers/Rel/Ind ID Code

1

M

AN

1-12

From initiating transaction’s GS08

 

AK2

AK2

Transaction Set Response Header

1

O

 

 

 

 

AK2

AK201

Transaction Set Identifier Code

1

M

ID

3-3

From initiating transaction’s ST01

 

AK2

AK202

Transaction Set Control Number

1

M

AN

4-9

From initiating transaction’s ST02

 

AK2

AK203

Implementation Convention Reference

1

O

AN 1-35

 

From initiating transaction’s ST03

 

IK3

IK3

Data Segment Note

1

O

 

 

 

 

IK3

IK301

Segment ID Code

1

M

ID

2-3

Mapped from DTL record; reporting “Segment ID” of where error is reported

 

IK3

IK302

Segment Position in Transaction Set

1

M

N0

1-6

Segment count offset from last ST to error segment

 

IK3

IK303

Loop Identifier Code

1

O

AN

1-4

Mapped from DTL record; reporting “Loop” of where error is reported

 

IK3

IK304

Segment Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Syntax Error Code” of where error is reported

Error Profile (*.apf) configurable

IK3

CTX

Segment Context

10

S

 

 

Required when the IK3 above it was triggered by a situational business rule.

Only issued on error of WEDI type 4 (Situational)

IK3

CTX01.1

Context Name

1

M

AN

1-35

SITUATIONAL TRIGGER

 

IK3

CTX01.2

Context Reference

1

O

ID

2-3

Not used

 

IK3

CTX02

Segment ID Code

1

O

ID

2-3

Mapped from DTL record; reporting “Segment ID” of first segment in the situational relationship

 

IK3

CTX03

Segment Position in Transaction Set

1

O

N0

1-6

Segment count offset from last ST to first segment in the situational relationship

 

IK3

CTX04

Loop Identifier Code

1

O

AN

1-6

Mapped from DTL record; reporting “Loop” of first segment in the situational relationship

 

IK3

CTX05.1

Element Position in Segment

1

M

N0

1-2

Mapped from DTL record; reporting “Element Position” in first segment in the situational relationship

 

IK3

CTX05.2

Component Data Element Position in Composite

1

O

N0

1-2

Mapped from DTL record; reporting “Sub-Element Position” within first segment in the situational relationship

 

IK3

CTX05.3

Repeating Data Element Position

1

O

N0

1-4

Not used

 

IK3

CTX06.1

Reference in Segment

1

O

N0

1-4

Reference number of first segment in the situational relationship

Mandatory if CTX06 is used.

CTX

CTX05.2

Reference in Composite

1

O

N0

1-4

Reference number of an element in a composite

 

IK3

CTX

Business Unit Identifier

1

S

 

 

Required when the IK3 above it was triggered by a situational business rule and the business unit identifier is known by RespGen.

 

CTX

CTX01.1

Context Identification

1

M

AN

1-35

Name or tag of value below.

See note below.

CTX

CTX01.2

Context Reference

1

O

AN

1-35

Identifier value, generated from various entries from specific loops in the source HIPAA documents

 

IK4

IK4

Data Element Note

99

O

 

 

 

 

IK4

IK401.1

Element Position in Segment

1

M

N0

1-2

Mapped from DTL record; reporting “Element Position” of where error is reported

 

IK4

IK402.1

Component Data Element Position in Composite

1

O

N0

1-2

Mapped from DTL record; reporting “Sub-Element Position” of where error is reported

 

IK4

IK402

Data Element Reference Number

1

O

N0

1-4

Mapped from DTL record; reporting “Element ID” of where error is reported

 

IK4

IK403

Data Element Syntax Error Code

1

M

ID

1-3

Mapped from DTL record; reporting “Data Element Syntax Error Code” of where error is reported

Error Profile (*.apf) configurable

IK4

IK404

Copy of Bad Data Element

1

O

AN

1-99

Mapped from DTL record; reporting “Element Data” of where error is reported

 

IK4

CTX

Element Context

10

S

 

 

Required when the IK4 above it was triggered by a situational business rule.

Only issued on error of WEDI type 4 (Situational)

IK4

CTX01.1

Context Name

1

M

AN

1-35

SITUATIONAL TRIGGER

 

IK4

CTX01.2

Context Reference

1

O

ID

2-3

Not used

 

IK4

CTX02

Segment ID Code

1

O

ID

2-3

Mapped from DTL record; reporting “Segment ID” of first segment in the situational relationship

 

IK4

CTX03

Segment Position in Transaction Set

1

O

N0

1-6

Segment count offset from last ST to first segment in the situational relationship

 

IK4

CTX04

Loop Identifier Code

1

O

AN

1-6

Mapped from DTL record; reporting “Loop” containing first segment in the situational relationship

 

IK4

CTX05.1

Element Position in Segment

1

M

N0

1-2

Mapped from DTL record; reporting “Element Position” within first segment in the situational relationship

 

IK4

CTX05.2

Component Data Element Position in Composite

1

O

N0

1-2

Mapped from DTL record; reporting “Sub-Element Position” within first segment in the situational relationship

 

IK4

CTX05.3

Repeating Data Element Position

1

O

N0

1-4

Not used.

 

IK4

CTX06.1

Reference in Segment

1

O

N0

1-4

Reference number of first segment in the situational relationship

Mandatory if CTX06 is used.

IK4

CTX06.2

Reference in Composite

1

O

N0

1-4

Reference number of an element in a composite.

 

AK2

IK5

Transaction Set Response Trailer

1

M

 

 

 

 

AK2

IK501

Transaction Set Acknowledgment Code

1

M

ID

1-1

A, E, P or R based on configuration options

pt, LenientIK501

AK2

IK502

Transaction Set Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Element Position” of where error is reported

 

AK2

IK503

Transaction Set Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Sub-Element Position” of where error is reported

 

AK2

IK504

Transaction Set Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Element ID” of where error is reported

 

AK2

IK505

Transaction Set Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Data Element Syntax Error Code” of where error is reported

 

AK2

IK506

Transaction Set Syntax Error Code

1

O

ID

1-3

Mapped from DTL record; reporting “Element Data” of where error is reported

 

 

AK9

Functional Group Response Trailer

1

M

 

 

 

 

 

AK901

Functional Group Acknowledge Code

1

M

ID

1-1

A, P or R based on configuration options

np

 

AK902

Number of Transaction Sets Included

1

M

N0

1-6

Number of Transaction Sets Included

 

 

AK903

Number of Received Transaction Sets

1

M

N0

1-6

Number of Received Transaction Sets

 

 

AK904

Number of Accepted Transaction Sets

1

M

N0

1-6

Number of Accepted Transaction Sets

 

 

AK905

Functional Group Syntax Error Code

1

O

ID

1-3

Generated by Response Generator based on specific error codes encountered at the Group level. Possible values are 2, 3, 4, 5, 14, 21, 24.

 

 

AK906

Functional Group Syntax Error Code

1

O

ID

1-3

Not used.

 

 

AK907

Functional Group Syntax Error Code

1

O

ID

1-3

Not used.

 

 

AK908

Functional Group Syntax Error Code

1

O

ID

1-3

Not used.

 

 

AK909

Functional Group Syntax Error Code

1

O

ID

1-3

Not used.

 

 

SE

Transaction Set Trailer

1

M

 

 

 

 

 

SE01

Number of Included Segments

1

M

N0

1-10

Count of Segments in output transaction

 

 

SE02

Transaction Set Control Number

1

M

AN

4-9

Matches ST02 of output transaction

 

 

GE

Functional Group Trailer

1

O

 

 

 

 

 

GE01

Number of Transaction Sets Included

1

M

N0

1-6

Count of ST/SEs in output transaction

 

 

GE02

Group Control Number

1

M

N0

1-9

Matches GS06 of output transaction

 

 

IEA

Interchange Control Trailer

1

O

 

 

 

 

 

IEA01

Number of Included Functional Groups

1

M

N0

1-5

Count of GS/GEs in output transaction

 

 

IEA02

Interchange Control Number

1

M

N0

9-9

Matches ISA13 of output transaction

 

Source of CTX-01-01 Business Unit Identifier Source

Transaction

Value in CTX-01-01

269

TRN02

270

TRN02

271

TRN02

274

NM109

275

PATIENT NAME NM109

276

TRN02

277

TRN02

278

SUBSCRIBER NAME NM109

820

ENT01

834

SUBSCRIBER NUMBER REF02

835

TRN02

837

CLM01