improved

API Change Log

Welcome to the Change Healthcare API change history.

Active release

API

Version

Release Date

API Reference

Eligibility

V3

April 2019

API reference

Payer Finder

V1

August 2022

API reference

📘

NOTE

Change Healthcare is deprecating the Claims Responses and Reports v1 API. If you use the v1 API, start using the v2 release at your earliest opportunity.

You can also check the Release Notes and API Documentation.

Change history

API

Version

Release Date

Active

Status

Reports

V3

11-01-2019

Reports

V2

5-17-2021

Reports

V1

11-01-2019

EOL: 06-01-2022

Professional Claims

V3

4-17-2019

Professional Claims

V2

4-01-2019

Professional Claims

V1

1-0102019

Institutional Claims initial release

V1

11-01-2019

Rules as a Service Professional

V1

11-17-2020

Institutional Claims Integrated Rules

V1

10-30-2020

Claim Status

V2

4-17-2019

Claim Status

V1

01-01-2019

Attachments Submission

V1

11-01-2019

Attachment Status API

V1

12-22-2020

Dental Benefits Advisor

V1

11-01-2021

Legend

  • ✅: Active
  • ❌: Deprecated
  • End-of-life (EOL): End of support

Added AAAError codes

For a list of Eligibility Error messages, reasons for errors, and their resolutions, see Eligibility Error Messages.

Updated API endpoint URLs

📘

NOTE

Medical Network APIs v1, v2, and v3 (as of 09-02-2021) are now deployed to an enhanced cloud-native network connection, which offers improved API speed and reliability. We recommend updating your systems to the following API endpoint URLs at the first opportunity.

API

Sandbox

Production

Raw X12 Endpoint

Eligibility

sandbox.apigw.changehealthcare.com/medicalnetwork/eligibility/v3

apigw.changehealthcare.com/medicalnetwork/eligibility/v3

Rules as a Service Professional

sandbox.apigw.changehealthcare.com/medicalnetwork/professionalclaims/advanced/v1/validation/

apigw.changehealthcare.com/medicalnetwork/professionalclaims/advanced/v1/validation/

apigw.changehealthcare.com/medicalnetwork/professionalclaims/advanced/v1/raw-x12-validation/

Attachment Status API

sandbox.apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/

apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/

Attachments Submission

sandbox.apigw.changehealthcare.com/medicalnetwork/attachments/submission/v1/uploads

apigw.changehealthcare.com/medicalnetwork/attachments/submission/v1/uploads

Reports

  • V2
      *sandbox.apigw.changehealthcare.com/medicalnetwork/reports/v2/*
  • V1
      *sandbox.apigw.changehealthcare.com/medicalnetwork/reports/v1/*
  • V2
      *apigw.changehealthcare.com/medicalnetwork/reports/v2/*
  • V1
      *apigw.changehealthcare.com/medicalnetwork/reports/v1/*

Professional Claims

sandbox.apigw.changehealthcare.com/medicalnetwork/professionalclaims/v3/validation

apigw.changehealthcare.com/medicalnetwork/professionalclaims/v3/validation

Institutional Claims

sandbox.apigw.changehealthcare.com/medicalnetwork/institutionalclaims/v3/validation

apigw.changehealthcare.com/medicalnetwork/institutionalclaims/v3/validation

Claim Status

sandbox.apigw.changehealthcare.com/medicalnetwork/claimstatus/v2

apigw.changehealthcare.com/medicalnetwork/claimstatus/v2

Release notes

Eligibility V3 Updates — 11-30-2020

  • Security and authorization changes.
  • Host and URL changes.
  • Deprecated: `Accept application/vnd.changehealthcare.medicaleligibility-v2+json` header mentioned in v2, there is no need to send or increment; versioning will be managed through the URL path.
  • Documentation updates.

Eligibility V3 Updates — 03-05-2021

  • Added two arrays – `benefitsRelatedEntities` and `eligibilityAdditionalInformationList`.
    • `JSON` object in `benefitsRelatedEntities` maps to objects within Loop 2120C.
    • `JSON` object in `eligibilityAdditionalInformationList` maps to objects in Loop 2115C.
Objects in the array will be equal to the number of times the loop repeats.
  • Documentation updates.
  • Security and Authorization changes.
  • 📘

    NOTE

    The legacy benefitsRelatedEntity and eligibilityAdditionalInformation objects are going to be deprecated in the future releases because the information is already captured in objects that are part of their respective arrays.

    Eligibility V2

    • Request/response is now a single medical eligibility request/response.
    • Error response schema changed.
    • Adding address to subscriber and dependents in response.
    • Must send Header: `Accept application/vnd.changehealthcare.medicaleligibility-v2+json`.

    Eligibility V2 Updates — 9-20-2021

    • Change Healthcare Medical Network APIs support a significant troubleshooting feature called *metadata*. API users need not enable this capability; it is automatic and has no effect on information in any medical transaction. If you encounter any issues with a transaction and need to work with Change Healthcare technical support, furnish the representative with the values provided in the `meta` object. This enables the technician to get a head start on addressing the problem.
      The `meta` object obtains its data from the request headers and the transaction token.
      json {"meta": {"senderId": "Xxxx.Xxxxxx","applicationMode": "prod","traceId": "bc409414-70ed-e387-e7d8-7addd7a7b599"}},
    • Improvements to /835 and /277 functionality.
    • Updated with **OpenAPI 3.0** support with medical coding annotations of which value from the EDI is presented in each property.
    • Individual attributes more clearly defined with plain-English naming conventions and translation.
    • Updates to support a new 'transactions' JSON object for the /835 and /277 endpoints. It lists out each 277 or 835 transaction contained within the report when multiple transactions are completed by the payer.
    • The /835 and /277 JSON translations present more human-readable content for EDI-to-JSON translation. The reports better represent the information hierarchy of the EDI.
    • `ServiceDetails` object from Reports v1 is renamed to `serviceLines` to match our other APIs.
    • Updates to Loop 2100A for Payer information attributes (04-26-2021).
    • Host and URL changes.
    • Documentation updates.

    📘

    NOTE

    This meta feature is not supported in the Claims Responses and Reports v1 APIs.

    Eligibility V1.1

  • Update to add /277 and /835 EDI-to-JSON translation API endpoints.
  • Documentation updates and testing.
  • Eligibility V1

  • Initial release of Eligibility API.
  • Initial release of the Institutional Claims API.
  • Initial release of Rules as a Service Professional Claims API.
  • Initial release of Integrated Rules Institutional Claims API.
  • Initial release of Claim status.
  • Initial release of the Attachment Status API.
  • Initial release of Reports API.
  • New Endpoint URLs for the Attachment Status API (03-08-2021).
  • Initial release of Attachments Submission API.
  • Initial release of Dental Benefits Advisor API.
  • Documentation updates (12-15-2020 and 12-31-2020).
  • Eligibility V1 Updates — 09-02-2021

  • Adding statusList endpoint (05-14-2020).
  • Medical Attachments Submission API Mapping document updated to cover `payerAddress` JSON field mappings to EDI (12-15-2020).
  • New API Gateway URL for Attachment Submission API (03-08-2021).
  • Eligibility V1 Updates — 12-24-20

    This update resolves issues IMNP-21000 and IMNP-21001. Added support for Country and Country Subdivision Codes.

    • This is required only when the billing address is not in Canada or in the United States of America, including its territories (for example, American Samoa).
    • Used when the billing address includes a country and an administrative subdivisions of any type such as states, provinces, or canton. These values reside in the EDI N404 and N407 fields in Loop 2010BA.

    Eligibility JSON-to-EDI API Mapping

    Date

    Description

    05-17-2019

    Added field information V1.

    05-10-2021

    Conversion to Markdown, integration into live documents.

    11-11-2021

    Various content updates.