997 - Functional acknowledgment

This topic describes the Electronic Data Interchange (EDI) standards that Business Transaction Intelligence implements for document type 997, or functional acknowledgment, which is used to confirm that a transaction was received.

Segment: AK1 - Group acknowledgment

Loop

Level: Heading

Usage: Mandatory

Semantic notes:

  • This segment is the functional group response header.
Reference Element name Requirement Usage
AK101 Functional group that is being acknowledged. Mandatory Used
AK102 Group control number (GS06 and GE02) of the functional group that is being acknowledged. Mandatory Used

Segment: AK2 - Transaction set header

Loop

Level: Heading

Usage: Optional - Used

Reference Element name Requirement Usage
AK201 Functional group that is being acknowledged. Mandatory Used
AK202 Transaction Set Control Number. The value sent in the ST02 and SE02. Mandatory Used

Segment: AK3 - Data segment note

Loop

Level: Heading

Usage: Not used.

Segment: AK4 - Data element note

Loop

Level: Heading

Usage: Not used.

Segment: AK5 - Transaction set response trailer

Loop

Level: Header

Usage: Optional - Used

Reference Element name Requirement Usage
AK501 Transaction set acknowledgment code:
  • A- Accepted
  • E - Accepted with errors
  • 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 (could not analyze content after decryption)
Mandatory Used

Segment: AK9 - Functional group response trailer

Loop

Level: Header

Usage: Mandatory

Reference Element name Requirement Usage
AK901 Functional Group Acknowledge Code:
  • A – Accepted
  • E – Accepted but errors 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 (could not analyze content after decryption)
Mandatory Used