API Versioning | Janus | multi-health-systems

MHS occasionally introduces breaking changes to the APIs. Simply put, any change to a specification or implementation that mandatorily changes inputs, processes, or results, can not be made to a published API, and must be made to a new version of the API. This represents a “breaking change” where the consumer of the API is required to maintain lockstep changes within their code to continue to work properly.

These changes are implemented in the form of versions that have a year and month as the version designate that is part of the URI space for the resources. MHS makes best effort to support current version plus one prior version. Customers will have a minimum of three hundred and sixty-five (365) days notification of a new version of the API specifications and will have early access to work in progress (alpha/beta) releases of a new API version in development. Presently there are two versions, 2020-04 (initial release) and 2022-10 (latest release).