999 Implementation Acknowledgment (005010X231A1)
The receiver of an 837, 835, 270 or any other HIPAA transaction returns the 999 to say whether each transaction set was accepted, accepted with errors or rejected, and why. This is the standard X12 HIPAA 005010 spec, with 3 loops and 10 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.
Use the 999 spec in your code
ediFabric .NET
Add the C# template and its common files to your project, or reference the template NuGet package, and read 999 files into TS999 objects. See ediFabric .NET.
ediFabric Native
Map version 005010X231A1 to the Native model with set_map, then parse 999 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.
OpenEDI
Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.
Generate 999 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 999 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS999. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.
Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.
To build a 999 from the validation result of a HIPAA file, see Generate an X12 999 implementation acknowledgment. For what each error code in a 999 means, see X12 999 acknowledgment error codes.
999 structure
Loops and segments of the standard 999, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Mandatory | 1 |
| AK1 | Functional Group Response Header | Mandatory | 1 |
| Loop AK2 | Transaction Set Response Header | Optional | >1 |
| AK2 | Transaction Set Response Header | Optional | 1 |
| Loop IK3 | Error Identification | Optional | >1 |
| IK3 | Error Identification | Optional | 1 |
| CTX | Segment Context or Business Unit Identifier | Optional | 10 |
| Loop IK4 | Implementation Data Element Note | Optional | >1 |
| IK4 | Implementation Data Element Note | Optional | 1 |
| CTX | Element Context | Optional | 10 |
| IK5 | Transaction Set Response Trailer | Mandatory | 1 |
| AK9 | Functional Group Response Trailer | Mandatory | 1 |
| SE | Transaction Set Trailer | Mandatory | 1 |