Attachments Status FAQs
NOTE
Please see the API FAQs section for tips and solutions to some of the most common questions asked by customers, developer community, and internal staff about the use of the Change Healthcare API.
The Attachments Status API enables customers to query for the status of attachment transactions (typically sending of medical information attachments) that they have submitted to their payer. The Attachments Status API takes the transaction details and returns their status in an understandable format.
NOTE
Change Healthcare Marketplace Attachments Submission API's
/attachments/submission/v1/uploadsendpoint is a prerequisite for using the the Attachments Status API.
In this section, you learn about the various ins and outs of using the Attachments Status API, including its requirements, using metadata search, remediating incorrect transactions and other features.
What does a typical Attachments response from the payer look like?
After the Change Healthcare 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.
Example
```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": "2005-05-14",
"claimEndDate": "2005-05-14",
"payerName": "VA HEALTH SYSTEM",
"rejectionInformation": "File type not supported"
},
"status": [
{
"statusCode": "10",
"statusMessage": "PARTIALLY_ACCEPTED",
"statusTimeStamp": "2021-08-20T13:25Z",
"documents": [
{
"documentName": "rightarm.jpg",
"controlNumber": "123456789",
"statusCode": "06",
"statusMessage": "ACCEPTED_BY_PAYER",
"statusTimeStamp": "2021-08-20T13:25Z"
},
{
"documentName": "rightarm1.jpg",
"controlNumber": "123456789",
"statusCode": "52",
"statusMessage": "REJECTED_BY_PAYER",
"statusTimeStamp": "2021-08-20T13:25Z",
"rejectionInformation": "File type not supported"
}
]
}
]
}
```
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.
How do I query for a specific Attachments transaction?
The Attachments Status API uses GET and POST requests depending on the endpoint you use.
To query for the status of a specific transaction, you use the GET request with two components in the HTTP query path:
- A reference to the transaction's
traceIdvalue in the request - A
fieldsetvalue that defines how much information to show about the transaction
The query does not use a request body.
Using the traceId value in your query path
traceId value in your query pathThe traceId specifies the attachment transaction in your query path. It supports the most accurate queries. It requires use of the traceId values that the Change Healthcare system applies to each attachment transaction.
The traceId is a unique 128-bit UUID value (example, 3ba21288-3f65-11eb-a512-6ab12069ade5) that Change Healthcare returns to the submitter as an acknowledgement when they receive every new attachments transaction.
NOTE
The customer's back office developers should maintain the traceId value for every attachment submission record. Whenever a Status query references that value, It should be passed to Admissions Status.
The traceId is part of the combination value attachmentId that you receive after a successful transaction using the /attachments/submission/v1/uploads endpoint:
```json
{
"status": "success",
"attachmentId": "3ba21288-3f65-11eb-a512-6ab12069ade5_12115_999898"
}
```
You specify the first 32 octets from the `attachmentId` as the `traceId` in your HTTP query path.
```javascript
GET 'https://apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/3600060b-2325-1180-155f-14671d2b35a8?
```
Using the fieldset argument in your query
You use the fieldset= value in combination with the traceId to form your query. It defines how much information you want to receive in response to your request. fieldset= uses either of these two values to show the following:
- Use
fieldset=summaryfor a brief summary of the submission; - The
fieldset=detailedoption shows a more detailed description of the submission.
Example
```javascript
GET 'https://apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/3600060b-2325-1180-155f-14671d2b35a8?fieldset=summary' \
```
```javascript
GET 'https://apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/3600060b-2325-1180-155f-14671d2b35a8?fieldset=detailed' \
```
What do the statusCode Attributes mean?
See StatusCode responses.
How do I remediate attachment transaction issues?
Attachment Formatting
Sometimes, attachment formatting may be wrong (for example, attempting to send an encapsulated Postscript file as an image attachment, or a Word document). Images and documents may be encoded improperly and have extra metadata attached to them (that information can often be removed by opening the document's Properties dialog). In these cases, the clearinghouse cannot process them, and you will get a Rejected by CHC as a result (you will only receive this by using this API â the clearinghouse does not support push notifications). You will need to correct the issues yourself, because the clearinghouse cannot fix issues in your attachment files.
NOTE
File Sizes
The Change Healthcare clearinghouse flags files of an excessive size. In these cases, you should convert the attachment file to a smaller format, or, if possible, reduce the page count of the attachment to contain only the relevant information.
Search Does Not Turn Up a Record
Example
Even when you correctly construct your search, you might receive the following result:
```json
[]
```
The result is an empty array. This is RESTful API's way of telling you that no result matches the search criteria. It could, for example, describe a "patient not found" situation. Try adding other fields to the search, and check their search criteria for data entry errors.
Rejections when a file is known good
If you receive rejections of attachments when the format is good and the file size is acceptable, remove any metadata associated with the file. You can usually edit and remove this information in the file's Properties dialog box.
Example
Fax and Mail Issues
The majority of Attachment failed to Mail or Attachment failed to Fax responses to sent attachments are the result of incorrect formats for files or an attachment that is too large to conveniently mail or fax. Some claims require a substantial amount of information that cannot be reduced for transmission; in these cases, break up the largest attachment files into several smaller ones. Ensure that every document or image is in the correct formats to be accepted by our clearinghouse and that are acceptable to the payer.
Finally, check the request body for missing required JSON attributes. Use our Attachments Submission Contents topic to check the details.
See StatusCode responses for more information.
I am not sure what the status message I'm receiving means!
The Attachments Status API also supports the use of descriptive information, known as metadata, to check for attachment transactions. You do not need the traceId to search for attachment transactions for a particular claim or a patient. See Metadata search.
Related Topics
Updated 6 months ago