Attachments Request v1

Summary API Attachments FAQ CHANGE LOG     

Overview

The Attachment Request API allows customers to request for additional medical documents in response to the medical claims. The Request API takes the request payload and delivers in a format understandable by the receiver.

An attachment, in the context of healthcare electronic data interchange, is an electronic rendition of medical documentation, such as an X-ray, lab report, or questionnaire, that supports a healthcare administrative transaction.

API Onboarding

See the Security and Authorization section in this portal to learn more about using our APIs. Most of our APIs are private and require credentials to gain access.

Getting Started

There are two easy ways to explore the data in our API's.

Postman

Start using our postman collection.

  • If you don't already have postman, you can download it here: Postman

  • Import our example collection: Run in Postman

  • Download the environment config: Postman Environment

  • Add your Client Id and Client Secret values to the MN-ClientId and MN-ClientSecret postman environment variables.

Why Postman?

Postman provides an easy UI for testing an API, as well as being the easiest way to start exploring Attachment Transform API. We recommend starting with our postman collection to understand what is available within the API.

Error codes

400 Bad Request

If the required header information is not passed, then you will receive such mandatory fields validation error.

401 Not Authorized

This response is returned by any Attachment Request API when the Bearer accessToken provided in the Authorization header isn't present, is invalid, or has expired. You will need to provided a valid, current Bearer JWT See the Security -> Authorization section in this portal.

500 Internal Server Error

On rare occasions, you may encounter one of these. Such cases are unexpected and may require that you reach out to your support contact(s) at Change Healthcare.

What information needs to go in the request header?

In the header for an Attachment Request API request, you need to pass an authorization token. For more information on this please visit Security and Authorization This is a precursor to making an Attachment Request API call, which might have the following headers:

Content-Type: application/json \
Authorization: Bearer <Your-Access-Token>

When you're ready for production, simply remove sandbox from the URL.

Read all about our protocols in the Security and Authorization section of this portal.

What does a typical API call look like?

You provide the input in the header of the request:

curl --location --request POST 'https://sandbox.apis.changehealthcare.com/medicalnetwork/attachments/request/v1/submit' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "payerID":"9497",
  "payerName": "Sample Payer Name",
  "submitterID": "99999",
  "submitterLastName": "Test Submitter",
  "submitterFirstName": "First Name",
  "payerClaimControlNumber": "123456789",
  "patientFirstName": "johnone",
  "patientLastName": "doeone",
  "patientMemberId": "0000000001",
  "providerLastOrgName": "happy doctors group",  
  "providerNPI": "1760854442",
  "patientAccountNumber": "PAN-123",
  "billTypeIdentifier":"BLT-1",
  "medicalRecordIdNumber": "MRI123",
  "claimNumber": "claim222",
  "claimServiceDateStart": "2020-01-22",
  "claimServiceDateEnd": "2020-01-23",
  "responseDueDate": "2022-10-20",
  "clinicalDataList": [
    {
        "R-CodeType":"R1",
      "requestTypeInfo": {
        "claimStatusDate": "2020-01-02",
        "loincCode": "L-123"
      }
    }
  ],

  "additionalInformation": {
    "claimAmount": "123",
    "responseFileType": "fileType",
    "productType": "test",
    "requestNumber": "First",
    "reason": "sample",
    "state": "MI",
    "routing":"yes",
    "uniqueTxnId":"trnId"
  }
}'

Example of Attachment Request Status Update:

curl --location --request POST 'https://sandbox.apis.changehealthcare.com/medicalnetwork/attachments/request/v1/statusUpdate' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "acknowledgementType": "attachment",
  "originalTransactionId": "filename.zip",
  "statuses": [
    {
      "clientUniqueId": "1234",
      "requestId": "56789",
      "statusCode": "1",
      "statusDescription": "Success"
    },
    {
      "clientUniqueId": "9876",
      "requestId": "54321",
      "statusCode": "0",
      "statusDescription": "Error while processing attachment"
    }
  ]
}'

Change Log

API Name API Version Date Introduced Available Until
Attachment Request API v1 Aug 25, 2020 TBD

Release Notes:

v1

  • Initial release of the Attachment Request API