Interoperability Patient Access API Admin v1

Summary API Attachments FAQ CHANGE LOG     

Overview

As part of the CMS Interoperability and Patient Access final rule (CMS-9115-F), members must have access to view financial, clinical, directory and formulary information. The two APIs in this Admin category are necessary to understand the interaction of the APIs, as well as to retrieve member-specific information.

The Who Am I API is necessary to first understand logged-in users and their relationship to a dependent's information retrieved by any API. This API is also included in each of the other categories. It is not a FHIR API but is specific to Change Healthcare's implementation, according to the Capability Statement API, because querying on universal identifiers is not allowed.

APIs in this category follow the FHIR Specifications v4.0.1: R4 found at http://hl7.org/fhir/resourcelist.html.

Also note that understanding how to properly authenticate is a requirement for these APIs. More information is available at: https://developers.changehealthcare.com/api/Security-and-Authorization/v2#.

Getting Started

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

Who Am I

The WhoAmI API is used to display member demographic profile information. There are four options that support an application's responsiveness, each returning different levels of profile information; Basic, Detailed, PayerInfo, and Full.

Basic Profile - provides a minimum set of member profile information.
Detailed Profile - includes a more broad set of profile information for a member than the BasicProfile, including all known telecom values, additional address, race, and ethnicity.
PayerInfo Profile - includes health coverage information such as Group Number, Policy Number, and Plan Name.

Change Log

API Name API Version Date Introduced Available Until
Interoperability Patient Access API Admin v1 12/28/2020 Current

Release Notes:

v1

  • Initial release.