EDI 997 Data Transformation Documentation

EDI 997 Data Transformation

Transform and create EDI messages using one of our two supported JSON formats.

Our current supported EDI version: 005010

Need help with some of our documentation? Feel free to contact our support team, and one of our support team members will be happy to assist you.

EDI 997 Request to Smart JSON Response

Transforms the EDI 997 message into our Smart JSON format. Recommended unless you need specific requirements that the Smart JSON may not support.

post https://api-edi.splinxtechnologies.com/v1/edi-transformation/edi997-to-smart

Request headers

Authentication

To make REST API calls, make sure to include your account's email and password in a Base64 encrypted format in the Basic authentication scheme. The value is <Account-Email> and <Account-Password>

LicenseId

Response fields

Field

Description

IsAccepted

boolean represents whether the acknowledgment was accepted.

OriginatorFunctionalGroupControlNumber

string

FunctionalGroupAcknowledgmentCode

string represents the acknowledgment code for the functional group of an EDI message.

FunctionalGroupErrorDescription

string represents the error description for the functional group of an EDI message.

TransactionSetResponse

List<TransactionSetResponse> represents the transaction sets of an EDI message. Use class TransactionSetResponse for reference.

Sample request

EDI 997 Copy

ISA*00*          *00*          *ZZ*123456789012345*ZZ*123456789012346*080503*1705*>*00501*000010216*0*T*:~GS*FA*1234567890*2345678901*20080503*1705*20213*X*005010X230~ST*997*2870001*005010X230~AK1*HC*17456*005010~AK2*837*0001~AK5*A~AK2*837*0002~AK3*CLM*22**8~AK4*1*1028*1~AK5*R*5~AK9*P*2*2*1~SE*10*2870001~GE*1*20213~IEA*1*000010216~

Sample response

Smart JSON Copy

[
  {
    "IsAccepted": false,
    "OriginatorFunctionalGroupControlNumber": "17456",
    "FunctionalGroupAcknowledgmentCode": "Partially Accepted, At Least One Transaction Set Was Rejected",
    "FunctionalGroupErrorDescription": "",
    "TransactionSetResponse": [
      {
        "IsAccepted": true,
        "OriginatorTransactionSetControlNumber": "0001"
      },
      {
        "IsAccepted": false,
        "OriginatorTransactionSetControlNumber": "0002",
        "ErrorIdentification": [
          {
            "SegmentId": "CLM",
            "SegmentPositionInTransactionSet": "22",
            "ErrorDescription": "Segment Has Data Element Errors",
            "DataElementErrorIdentification": [
              {
                "DataElementReferenceNumber": "1028",
                "DataElementSyntaxErrorCode": "Required Data Element Missing"
              }
            ]
          }
        ]
      }
    ]
  }
]

EDI 997 Request to JSON Response

Transforms an EDI 997 message into JSON.

post https://api-edi.splinxtechnologies.com/v1/edi-transformation/edi997-to-json

Request headers

Authentication

To make REST API calls, make sure to include your account's email and password in a Base64 encrypted format in the Basic authentication scheme. The value is <Account-Email> and <Account-Password>

LicenseId

Sample request

EDI 997 Copy

ISA*00*          *00*          *ZZ*123456789012345*ZZ*123456789012346*080503*1705*>*00501*000010216*0*T*:~GS*FA*1234567890*2345678901*20080503*1705*20213*X*005010X230~ST*997*2870001*005010X230~AK1*HC*17456*005010~AK2*837*0001~AK5*A~AK2*837*0002~AK3*CLM*22**8~AK4*1*1028*1~AK5*R*5~AK9*P*2*2*1~SE*10*2870001~GE*1*20213~IEA*1*000010216~

Sample response

JSON Copy

{
  "InterchangeControlHeaderSegment": {
    "ISA_01_AuthorizationInformationQualifier_ID": "00",
    "ISA_02_AuthorizationInformation_AN": "          ",
    "ISA_03_SecurityInformationQualifier_ID": "00",
    "ISA_04_SecurityInformation_AN": "          ",
    "ISA_05_InterchangeIDQualifier_ID": "ZZ",
    "ISA_06_InterchangeSenderID_AN": "123456789012345",
    "ISA_07_InterchangeIDQualifier_ID": "ZZ",
    "ISA_08_InterchangeReceiverID_AN": "123456789012346",
    "ISA_09_InterchangeDate_DT": "080503",
    "ISA_10_InterchangeTime_TM": "1705",
    "ISA_11_RepetitionSeparator": ">",
    "ISA_12_InterchangeControlVersionNumber_ID": "00501",
    "ISA_13_InterchangeControlNumber_N": "000010216",
    "ISA_14_AcknowledgmentRequest_ID": "0",
    "ISA_15_InterchangeUsageIndicator_ID": "T",
    "ISA_16_ComponentElementSeparator": ":"
  },
  "FunctionalGroups": [
    {
      "FunctionalGroupHeaderSegment": {
        "GS_01_FunctionalIdentifierCode_ID": "FA",
        "GS_02_ApplicationSendersCode_AN": "1234567890",
        "GS_03_ApplicationReceiversCode_AN": "2345678901",
        "GS_04_Date_DT": "20080503",
        "GS_05_Time_TM": "1705",
        "GS_06_GroupControlNumber_N": "20213",
        "GS_07_ResponsibleAgencyCode_ID": "X",
        "GS_08_VersionReleaseIndustryIdentifierCode_AN": "005010X230"
      },
      "TransactionSets": [
        {
          "TransactionSetHeader": {
            "ST_01_TransactionSetIdentifierCode_ID": "997",
            "ST_02_TransactionSetControlNumber_AN": "2870001",
            "ST_03_ImplementationConventionReference_AN": "005010X230"
          },
          "FunctionalGroupResponseHeader": {
            "AK1_01_FunctionalIdentifierCode_ID": "HC",
            "AK1_02_GroupControlNumber_N": "17456",
            "AK1_03_VersionReleaseIndustryIdentifierCode_AN": "005010"
          },
          "AK2_Loop": [
            {
              "TransactionSetResponseHeader": {
                "AK2_01_TransactionSetIdentifierCode_ID": "837",
                "AK2_02_TransactionSetControlNumber_AN": "0001",
                "AK2_03_ImplementationConventionReference_AN": null
              },
              "AK3_Loop": [
                {
                  "DataSegmentNote": null,
                  "DataElementNote": null
                }
              ],
              "TransactionSetResponseTrailer": {
                "AK5_01_TransactionSetAcknowledgmentCode_ID": "A",
                "AK5_02_TransactionSetSyntextErrorCode_ID": null,
                "AK5_03_TransactionSetSyntextErrorCode_ID": null,
                "AK5_04_TransactionSetSyntextErrorCode_ID": null,
                "AK5_05_TransactionSetSyntextErrorCode_ID": null,
                "AK5_06_TransactionSetSyntextErrorCode_ID": null
              }
            },
            {
              "TransactionSetResponseHeader": {
                "AK2_01_TransactionSetIdentifierCode_ID": "837",
                "AK2_02_TransactionSetControlNumber_AN": "0002",
                "AK2_03_ImplementationConventionReference_AN": null
              },
              "AK3_Loop": [
                {
                  "DataSegmentNote": {
                    "AK3_01_SegmentIdCode_ID": "CLM",
                    "AK3_02_SegmentPositionInTransactionSet_N": "22",
                    "AK3_03_LoopIdentifierCode_AN": null,
                    "AK3_04_SegmentSyntexErrorCode_ID": "8"
                  },
                  "DataElementNote": [
                    {
                      "AK4_01_PositionInSegment": {
                        "C030_01_ElementPositionInSegment_N": "1",
                        "C030_02_ComponentDataElementPositionInComposite_N": null,
                        "C030_03_RepeatingDataElementPosition_N": null
                      },
                      "AK4_02_DataElementReferenceNumber_N": "1028",
                      "AK4_03_DataElementSyntexErrorCode_ID": "1",
                      "AK4_04_CodeOfBadDataElement_AN": null
                    }
                  ]
                }
              ],
              "TransactionSetResponseTrailer": {
                "AK5_01_TransactionSetAcknowledgmentCode_ID": "R",
                "AK5_02_TransactionSetSyntextErrorCode_ID": "5",
                "AK5_03_TransactionSetSyntextErrorCode_ID": null,
                "AK5_04_TransactionSetSyntextErrorCode_ID": null,
                "AK5_05_TransactionSetSyntextErrorCode_ID": null,
                "AK5_06_TransactionSetSyntextErrorCode_ID": null
              }
            }
          ],
          "FunctionalGroupResponseTrailer": {
            "AK9_01_FunctionalGroupAcknowledgeCode_ID": "P",
            "AK9_02_NumberOfTransactionSetsIncluded_N": "2",
            "AK9_03_NumberOfReceivedTransactionSets_N": "2",
            "AK9_04_NumberOfAcceptedTransactionSets_N": "1",
            "AK9_05_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_06_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_07_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_08_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_09_FunctionalGroupSyntaxErrorCode_ID": null
          },
          "TransactionSetTrailer": {
            "SE_01_NumberOfIncludedSegments_N": "10",
            "SE_02_TransactionSetControlNumber_AN": "2870001"
          }
        }
      ],
      "FunctionalGroupTrailerSegment": {
        "GE_01_NumberOfTransactionSetsIncluded_N": "1",
        "GE_02_GroupControlNumber_N": "20213"
      }
    }
  ],
  "InterchangeControlTrailerSegment": {
    "IEA_01_NumberOfIncludedFunctionalGroups_N": "1",
    "IEA_02_InterchangeControlNumber_N": "000010216"
  }
}

JSON Request to EDI 997 Response

Transforms JSON into an EDI 997 message.

post https://api-edi.splinxtechnologies.com/v1/edi-transformation/json-to-edi997

Request headers

Authentication

To make REST API calls, make sure to include your account's email and password in a Base64 encrypted format in the Basic authentication scheme. The value is <Account-Email> and <Account-Password>

LicenseId

Sample request

JSON Copy

{
  "InterchangeControlHeaderSegment": {
    "ISA_01_AuthorizationInformationQualifier_ID": "00",
    "ISA_02_AuthorizationInformation_AN": "          ",
    "ISA_03_SecurityInformationQualifier_ID": "00",
    "ISA_04_SecurityInformation_AN": "          ",
    "ISA_05_InterchangeIDQualifier_ID": "ZZ",
    "ISA_06_InterchangeSenderID_AN": "123456789012345",
    "ISA_07_InterchangeIDQualifier_ID": "ZZ",
    "ISA_08_InterchangeReceiverID_AN": "123456789012346",
    "ISA_09_InterchangeDate_DT": "080503",
    "ISA_10_InterchangeTime_TM": "1705",
    "ISA_11_RepetitionSeparator": ">",
    "ISA_12_InterchangeControlVersionNumber_ID": "00501",
    "ISA_13_InterchangeControlNumber_N": "000010216",
    "ISA_14_AcknowledgmentRequest_ID": "0",
    "ISA_15_InterchangeUsageIndicator_ID": "T",
    "ISA_16_ComponentElementSeparator": ":"
  },
  "FunctionalGroups": [
    {
      "FunctionalGroupHeaderSegment": {
        "GS_01_FunctionalIdentifierCode_ID": "FA",
        "GS_02_ApplicationSendersCode_AN": "1234567890",
        "GS_03_ApplicationReceiversCode_AN": "2345678901",
        "GS_04_Date_DT": "20080503",
        "GS_05_Time_TM": "1705",
        "GS_06_GroupControlNumber_N": "20213",
        "GS_07_ResponsibleAgencyCode_ID": "X",
        "GS_08_VersionReleaseIndustryIdentifierCode_AN": "005010X230"
      },
      "TransactionSets": [
        {
          "TransactionSetHeader": {
            "ST_01_TransactionSetIdentifierCode_ID": "997",
            "ST_02_TransactionSetControlNumber_AN": "2870001",
            "ST_03_ImplementationConventionReference_AN": "005010X230"
          },
          "FunctionalGroupResponseHeader": {
            "AK1_01_FunctionalIdentifierCode_ID": "HC",
            "AK1_02_GroupControlNumber_N": "17456",
            "AK1_03_VersionReleaseIndustryIdentifierCode_AN": "005010"
          },
          "AK2_Loop": [
            {
              "TransactionSetResponseHeader": {
                "AK2_01_TransactionSetIdentifierCode_ID": "837",
                "AK2_02_TransactionSetControlNumber_AN": "0001",
                "AK2_03_ImplementationConventionReference_AN": null
              },
              "AK3_Loop": [
                {
                  "DataSegmentNote": null,
                  "DataElementNote": null
                }
              ],
              "TransactionSetResponseTrailer": {
                "AK5_01_TransactionSetAcknowledgmentCode_ID": "A",
                "AK5_02_TransactionSetSyntextErrorCode_ID": null,
                "AK5_03_TransactionSetSyntextErrorCode_ID": null,
                "AK5_04_TransactionSetSyntextErrorCode_ID": null,
                "AK5_05_TransactionSetSyntextErrorCode_ID": null,
                "AK5_06_TransactionSetSyntextErrorCode_ID": null
              }
            },
            {
              "TransactionSetResponseHeader": {
                "AK2_01_TransactionSetIdentifierCode_ID": "837",
                "AK2_02_TransactionSetControlNumber_AN": "0002",
                "AK2_03_ImplementationConventionReference_AN": null
              },
              "AK3_Loop": [
                {
                  "DataSegmentNote": {
                    "AK3_01_SegmentIdCode_ID": "CLM",
                    "AK3_02_SegmentPositionInTransactionSet_N": "22",
                    "AK3_03_LoopIdentifierCode_AN": null,
                    "AK3_04_SegmentSyntexErrorCode_ID": "8"
                  },
                  "DataElementNote": [
                    {
                      "AK4_01_PositionInSegment": {
                        "C030_01_ElementPositionInSegment_N": "1",
                        "C030_02_ComponentDataElementPositionInComposite_N": null,
                        "C030_03_RepeatingDataElementPosition_N": null
                      },
                      "AK4_02_DataElementReferenceNumber_N": "1028",
                      "AK4_03_DataElementSyntexErrorCode_ID": "1",
                      "AK4_04_CodeOfBadDataElement_AN": null
                    }
                  ]
                }
              ],
              "TransactionSetResponseTrailer": {
                "AK5_01_TransactionSetAcknowledgmentCode_ID": "R",
                "AK5_02_TransactionSetSyntextErrorCode_ID": "5",
                "AK5_03_TransactionSetSyntextErrorCode_ID": null,
                "AK5_04_TransactionSetSyntextErrorCode_ID": null,
                "AK5_05_TransactionSetSyntextErrorCode_ID": null,
                "AK5_06_TransactionSetSyntextErrorCode_ID": null
              }
            }
          ],
          "FunctionalGroupResponseTrailer": {
            "AK9_01_FunctionalGroupAcknowledgeCode_ID": "P",
            "AK9_02_NumberOfTransactionSetsIncluded_N": "2",
            "AK9_03_NumberOfReceivedTransactionSets_N": "2",
            "AK9_04_NumberOfAcceptedTransactionSets_N": "1",
            "AK9_05_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_06_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_07_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_08_FunctionalGroupSyntaxErrorCode_ID": null,
            "AK9_09_FunctionalGroupSyntaxErrorCode_ID": null
          },
          "TransactionSetTrailer": {
            "SE_01_NumberOfIncludedSegments_N": "10",
            "SE_02_TransactionSetControlNumber_AN": "2870001"
          }
        }
      ],
      "FunctionalGroupTrailerSegment": {
        "GE_01_NumberOfTransactionSetsIncluded_N": "1",
        "GE_02_GroupControlNumber_N": "20213"
      }
    }
  ],
  "InterchangeControlTrailerSegment": {
    "IEA_01_NumberOfIncludedFunctionalGroups_N": "1",
    "IEA_02_InterchangeControlNumber_N": "000010216"
  }
}

Sample response

EDI 997 Copy

ISA*00*          *00*          *ZZ*123456789012345*ZZ*123456789012346*080503*1705*>*00501*000010216*0*T*:~GS*FA*1234567890*2345678901*20080503*1705*20213*X*005010X230~ST*997*2870001*005010X230~AK1*HC*17456*005010~AK2*837*0001~AK5*A~AK2*837*0002~AK3*CLM*22**8~AK4*1*1028*1~AK5*R*5~AK9*P*2*2*1~SE*10*2870001~GE*1*20213~IEA*1*000010216~

TransactionSetResponse fields

Field

Description

IsAccepted

boolean represents whether the acknowledgment was accepted.

OriginatorTransactionSetControlNumber

string

TransactionSetAcknowledgmentCode

string represents the acknowledgment code for the transaction set of an EDI message.

TransactionSetErrorDescription

string represents the error description for the transaction set of an EDI message.

ErrorIdentification

List<ErrorIdentification> represents the errors in the transaction set, such as errors in segments. Use class ErrorIdentification for reference.

ErrorIdentification fields

Field

Description

SegmentId

string

SegmentPositionInTransactionSet

string

ErrorDescription

string

DataElementErrorIdentification

List<DataElementErrorIdentification>represents the errors in the data element. Use class DataElementErrorIdentification for reference.

Healthcare EDIs

EDI 270 SJ (Patient Eligibility Request)

EDI 271 SJ (Patient Eligibility Request)

EDI 276 (Claim Status Request)

EDI 277 (Claim Status Response)

EDI 834 (Patient Enrollment)

EDI 835 SJ (Claim Payment and Advice)

EDI 837 (Claims)

Acknowledgment EDIs

EDI 997 SJ (Functional Acknowledgment)

EDI 999 SJ (Implementation Acknowledgment)

Freight and Shipping EDIs

EDI 404 (Rail Carrier Shipment Information)

EDI 410 (Rail Carrier Freight Details and Invoice)