Deprecation and versioning

As new features are added to Clinical One Platform, APIs are enhanced to accommodate these new features resulting in new API versions. As we add new API versions, we will deprecate existing versions and we will eventually remove these deprecated APIs from the product. All APIs are backwards compatible, including deprecated APIs. We deprecate an API when a newer version of the API is available or the API functionality no longer exists in Clinical One Platform.

For Clinical One Platform, deprecation refers to the sunsetting of an API. Deprecated APIs will continue to work even after being marked as Deprecated. However, once deprecated, this API may be subject to removal in the future. There is typically a 12-to-24-month notice period once the API is marked as deprecated before we completely remove the API from the product. After we remove an API from the product, you cannot continue to use the API. To avoid issues with your code, you should make efforts to move to a supported version of the API or an alternative supported API as soon as possible.

Information on versioning

Because Clinical One Platform uses the newest version of each API, we recommend that you use the most current available version of an API when beginning to build your integration. Do not use older versions for new development.

If you are already integrating with Clinical One Platform, you have the option to move to newer versions of APIs to leverage any new functionality. Newer APIs generally provide more information, including response information or new query parameters and are backward compatible with earlier APIs.