Attachments Retrieval v1

Summary API Attachments FAQ CHANGE LOG     

Overview

The Attachment Retrieval API lets you search and download attachment documents for payers. It has the document search options based on date range, claim number, memberId, patient first name & last name. This API supports legacy Change Healthcare (formerly Emdeon) network connections. For a full list of Legacy RelayHealth network connections, please reference ConnectCenter.

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: Postman Collection

  • 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 Retrieval API. We recommend starting with our postman collection to understand what is available within the API.

Example Request

Submit an HTTPS GET request to the below URL:

https://sandbox.apis.changehealthcare.com/medicalnetwork/attachments/retrieval/v1

Example of search by date range:

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "size":100
}
Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-05-17","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"}
    ]

Example of search by Attachment Control number (ACN):

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "attachmentControlNumber": <Attachment Control number (ACN)>,
  "size":100
}


Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-05-17","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"}
    ]

Example of search by patientFirstName and patientLastName:

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "patientFirstName": <First Name>,
  "patientLastName": <Last Name>,
  "size":100
}
Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-05-17","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"}
    ]

Example of search by beginClaimServiceDate and endClaimServiceDate

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "beginClaimServiceDate": "2020-05-16",
  "endClaimServiceDate": "2020-05-16",
  "size":100
}
Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-05-16","endClaimServiceDate": "2020-05-16"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-05-17","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-05-16","endClaimServiceDate": "2020-05-16"}
    ]

Example of search by memberId:

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "memberId": <memberId>,
  "size":100
}
Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-05-16","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"}
    ]

Example of search by providerId , providerFirstName and organizationName:

POST /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/search?testMode=false HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body:
{
  "startUploadDate": "2020-05-16",
  "endUploadDate": "2020-05-17",
  "providerId": <provider  Id>,
  "providerFirstName": <First Name>,
  "organizationName" :<Org or provider Last Name>,
  "size":100
}
Response:
    [
        {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-04-22","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"},
        {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-04-22","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-02-22","endClaimServiceDate": "2020-04-22"}
    ]

Example of download document by documentId:

GET /medicalnetwork/attachments/retrieval/v1/attachments/retrieval/v1/<documentId> HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>

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 Retrieval 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.

404 Not Found

This response is returned by GET /attachments/retrieval/v1/{documentId} when the specified Attachment Retrieval API is not found. It is also returned if you call a misspelled API or use the wrong URL.

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 Retrieval 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 Retrieval 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:

POST /medicalnetwork/attachments/retrieval/v1 HTTP/1.1
Host: sandbox.apis.changehealthcare.com
Authorization: Bearer <Your-Access-Token>
Content-Type: application/json
Body: 
{
"startUploadDate": <yyyy-MM-dd>,
"endUploadDate": <yyyy-MM-dd>,
"attachmentControlNumber": <Claim Number>,
"patientFirstName": <Patient First Name>,
"patientLastName": <Patient Last Name>,
"memberId": <Member ID>.
"organizationName": <Org Name>,
"providerFirstName":<Provider First Name>,
"providerId":<Provider ID>,
"beginClaimServiceDate":<yyyy-MM-dd>,
"endClaimServiceDate":<yyyy-MM-dd>,
"size":100
}

What does a typical API response look like?

    [ 
    {"documentId": "3119a9e6-8478-11ea-9218-be3661f6f0ba","attachmentControlNumber": "claimno","memberId": "memberid123","patientFirstName": "patient first name ","patientLastName": "patient last name","attachmentUploadDate": "2020-04-22","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-04-22","endClaimServiceDate": "2020-04-22"},
    {"documentId": "5eb5edec-1196-44ae-aecc-d52fe9e01160","attachmentControlNumber": "claimno","memberId": "394643195","patientFirstName": "patient first name ","patientLastName": "patient last name ","attachmentUploadDate": "2020-04-22","providerId": "provider123","providerFirstName": "provider first name","providerOrgLastName": "provider org or last name","beginclaimServiceDate": "2020-04-22","endClaimServiceDate": "2020-04-22"}
    ]

Change Log

API Name API Version Date Introduced Available Until
Attachment Retrieval API v1 April 6, 2020 TBD

Release Notes:

v1

  • Initial release of the Attachment Retrieval API