Attachments Request and Response from Payer

Suggest Edits

The API uses a POST request. You provide the input as JSON in the body of the request. Include sufficient claim information (claimInformation object) in the request to ensure the attachments submission goes to the right place. A submission for a Solicited Attachments transaction (attachments requested by the payer) contains more payer information.

```json
  "controlNumber": "123459999",
  "tradingPartnerServiceId": "9496",
  "submitter": {
    "organizationName": "happy doctors grouppractice",
    "etin": "1942788757"
  },
  "provider": {
    "organizationName": "happy doctors group",
    "npi": "1760854442",
    "address": {
      "address1": "123 address1",
      "city": "city1",
      "state": "wa",
      "postalCode": "981010000"
    },
    "phoneNumber": "123456789",
    "faxNumber": "123456789"
  },
  "subscriber": {
    "memberId": "0000000001",
    "firstName": "johnone",
    "lastName": "doeone"
  },
  "claimInformation": {
    "patientControlNumber": "12345",
    "payerControlNumber": "00001",
    "beginClaimServiceDate": "20050514",
    "endClaimServiceDate": "20050515",
    "serviceLines": [{
      "providerAttachmentControlNumber": "123456789",
      "serviceLineDateInformation" : {
          "submissionDate" : "20050514"
      },
      "attachmentDetails": {
        "name": "rightarm.jpg"
      }
    }]
```

After the clearinghouse sends the attachments and receives the payer acknowledgement, you will receive a response body showing the status of the attachments submission. Results may vary based on payer acceptance or non-acceptance of individual attachment files.

```json
Date format: "yyyy-MM-dd'T'HH:mm'Z'"
 
Sample response:
{
    "transactionDetails": {
        "submitterId": "TESTSBMTR11111",
        "memberId": "0000000001",
        "patientFirstName": "doeone",
        "patientLastName": "johnone",
        "payerId": "TESTEP10",
        "providerId": "1760854442",
        "providerFirstName": null,
        "providerLastName": "happy doctors group",
        "claimStartDate": "2021-08-14",
        "claimEndDate": "2021-08-15",
        "payerName": "VA HEALTH SYSTEM",
        "transactionSubmittedDate":"2021-08-16T05:21Z",
        "rejectionInformation": null
    },
    "status": [
        {
            "statusCode": "10",
            "statusMessage": "PARTIALLY_ACCEPTED",
            "statusTimeStamp": "2021-08-20T13:25Z",
            "documents": [
               {
                    "documentName": "rightarm1.jpg",
                    "controlNumber": "123456789",
                    "statusCode": "52",
                    "statusMessage": "REJECTED_BY_PAYER",
                    "statusTimeStamp": "2021-08-20T13:25Z",
                    "rejectionInformation": "File type not supported"
                },

{
                    "documentName": "rightarm.jpg",
                    "controlNumber": "123456789",
                    "statusCode": "06",
                    "statusMessage": "ACCEPTED_BY_PAYER",
                    "statusTimeStamp": "2021-08-20T13:25Z"
                }
            ]
        }
    ]
}
```

Time stamp values show both the date and time in a specific format. Each individual attachment file in the submission gets a separate object as a part of the overall response. This is how you will find out the state of a partial acceptance of attachments from the payer.

For submissions with more than one attachment, you will receive a Partial Acceptance notification as part of the response should one or more submitted files not be accepted.

In the preceding example, you see that accepted attachments will simply receive an acceptance time stamp. Rejected attachments will receive a rejectionInformation field briefly describing the reason.

For a longer set of response examples, see Other Kinds of Responses seen in submissions.

Updated about 2 months ago