Enhanced Breaking Change Release Process for Public APIs

Summary

As athenahealth continues to evolve our ecosystem of available endpoints and functionalities, there will be unavoidable circumstances when breaking changes are introduced. We have refined the process for introducing API-impacting features as well as the procedures for planning, testing, and remediating the effects of these breaking changes on your system.

This new process has been incorporated into the API Solutions Service Description.

Products

athenaClinicals, athenaClinicals for Hospitals & Health Systems, athenaCommunicator, athenaCollector, athenaCollector for Hospitals & Health Systems

Roles

Management/Technical

Available

November 16-18, 2022 

Highlights

  • We have refined the process for introducing API-impacting features as well as the procedures for planning, testing, and remediating the effects of these breaking changes on your system.
  • This new process has been incorporated into the API Solutions Service Description.

Setup

  • N/A

Is this a breaking change

  • No, this is not a breaking change

Endpoints affected

  • N/A

New Endpoints

  • N/A

Resources

Refer to the following resources for more information:

What is changing

athenahealth commits to limit breaking changes exclusively to triannual releases. Our definition of breaking change is specified in the updated API Solutions Service Description. 

See API Solutions Service Description for Marketplace Partners and Platform Services Customers for more information. 

Why we’re making the change

We’re making this change to maximize our commitment to fully support and communicate the changes and to minimize the potential disruption to you.

What will current users of the endpoint need to update in their code

API customers and partners who call an endpoint with an upcoming breaking change must complete testing and remediate changes 6 weeks prior to a triannual release

Breaking change release notes will be posted to the Upcoming Changes section of the Developer Portal Change Log once the functionality is available in Preview and ready for testing. 

Non-breaking changes are not limited to triannual releases and testing is optional. Release notes for non-breaking changes or net-new APIs may be posted to the developer portal change log at any time prior to release. 

What will happen if users of the endpoint do not update their code

N/A

 

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page