Stay up to date on the latest important dates for the Canvas platform.
Description
Type
What You Need To Know
Release Date
End of Life
FHIR API: Coverage member identifier moving from subscriberId attribute to identifier attribute
Breaking Change
On the release date, several corrections will be made to the FHIR Coverage resource to comply with USCDI v3 requirements.
The meaning of the subscriberId attribute in the resource is changing, resulting in the following updates:
Insurance member ID will no longer be provided in the subscriberId attribute. The member ID will now be presented in the identifier attribute instead, and the subscriberId attribute will now represent the identifier for the subscriber, not the member. This will apply for create, read, update, and search endpoints.
The subscriberid will represent a new optional field within Canvas.
The subscriberid search parameter will no longer search member IDs; it will now instead search subscriber IDs. The new identifier search parameter will now search member IDs.
Additionally, we will be making several corrections to code systems in Coverage resources that are returned by read/search endpoints, and consumed by create/update endpoints:
http://hl7.org/fhir/ValueSet/coverage-type will be changing to either http://terminology.hl7.org/CodeSystem/coverage-selfpay (for code value pay) or http://terminology.hl7.org/CodeSystem/v3-ActCode (for all other code values).
http://hl7.org/fhir/ValueSet/subscriber-relationship will be changing to http://terminology.hl7.org/CodeSystem/subscriber-relationship
http://hl7.org/fhir/ValueSet/coverage-class will be changing to http://terminology.hl7.org/CodeSystem/coverage-class
To facilitate these changes, the following changes have already been made to FHIR Coverage resource and endpoints:
The insurance member ID is being populated into and consumed from the identifier attribute.
Member IDs can be searched using the new identifier search parameter.
The correct codings listed above have been added to responses from read/search endpoints, and are being consumed by create/update endpoints. On the release date, the incorrect codings will be removed.
Examples and documentation for the identifier field and the new code system values are available in the FHIR Coverage API documentation.
API client code must be updated by the release date to avoid disruption.
10/21/25
FHIR API: Condition category handling
Breaking Change
On the release date, Canvas will handle the category attribute on the FHIR Condition resource differently in order to meet USCDI v3 requirements.
Currently, the category attribute for all Conditions is required to be encounter-diagnosis. On the release date, the following changes will take effect:
The Condition create and update endpoints will accept encounter-diagnosis, problem-list-item, or health-concern for the code attribute of the category coding.
The Condition read and search-type endpoints will return encounter-diagnosis, problem-list-item, or health-concern for the code attribute of the category coding, based on what is stored in the database for the Condition.
Conditions created by the Diagnose command will have category set to problem-list-item. The Diagnose command will be enhanced in the future to enable use of the other value options for category.
The category for all existing Conditions in the database will be set to problem-list-item.
What you need to do:
All client code that makes use of the Condition create or update endpoints must be updated before the release date so that problem-list-item is sent instead of encounter-diagnosis. Please note that until we make the breaking change, even if you send problem-list-item, we will continue returning you encounter-diagnosis from read and search endpoints until we make the breaking change.
All client code that makes use of the read or search endpoints must be updated if they reference the category attribute to flexibly handle either encounter-diagnosis or problem-list-item.
Making these two changes before the release date will ensure that your use of the endpoint will be unaffected by this change.
12/02/25
Workflow SDK
New Version
The Workflow SDK has been deprecated, and will only receive fixes for defects or security issues. We are replacing its functionality with the Canvas SDK and its plugins, and will not set a date for the removal of the Workflow SDK until the Canvas SDK reaches feature parity. At that time we will present a migration plan to convert Workflow SDK Protocols into Canvas Plugins.
TBD (Not Soon)
FHIR API: Setting appointment location using the location integer value
Breaking Change
The FHIR Appointment endpoint now uses the reference from the Location Read/Search endpoint for the Location in supportingInformation. We plan to discontinue support of using the location integer.