Upgrade running care flows
Move care flows that are already running onto a newer published version of their care flow definition, one at a time or in bulk.
Setting a new version live decides which version new patients are enrolled into. Care flows that are already running stay on the version they started on. The Upgrade tab moves those running care flows onto another published version of the same care flow definition.
Where to find it
In the CareOps portal, open Monitor, then Care flows, then the Upgrade tab. It works on the care flows of the signed-in organization.
Care flows built in Care Flow Studio can't be upgraded.
Care flow upgrade is turned on per organization. Where it is off, the tab is absent and the page says care flow upgrade is not turned on. To have it turned on, email support@awellhealth.com.
Upgrading needs its own permission
Permission to open Monitor's care flow pages does not carry permission to upgrade. A member who can open the tab but not upgrade sees the care flows and their versions with every upgrade disabled, and the page names the role to ask an organization admin for: Operator.
Test the version before moving anyone onto it
An upgrade moves a care flow onto a different version of its definition while that care flow is in progress. Test the new version first, and know what it changes for activities already under way.
Upgrade one care flow
- Open the Single care flow tab.
- Paste the care flow ID and click Search.
- Check the care flow details: patient ID, title, status, definition ID, and the release ID it is on now.
- Under Available versions, click Select on the version to move to.
- Read the confirmation, then click Confirm upgrade.
Only versions published after the one the care flow is on are listed. A care flow already on the newest version shows "No newer versions available".
After the upgrade goes through, the care flow is read again, so the details show the version it is on now and what it can move to from there.
Upgrade many care flows at once
Bulk upgrade moves care flows to the live version only, and every care flow in a run must belong to one care flow definition.
- Open the Bulk upgrade tab.
- Paste care flow IDs separated by commas, spaces or new lines, and click Add. A run takes at most 500 care flows.
- Check the table. Every row gets an upgrade status of Ready, Already live, or No live version.
- Remove the rows that aren't Ready, in the Remove column. Upgrade all stays disabled while a blocked row or a second definition is in the table.
- Click Upgrade all.
IDs that aren't in the organization are listed above the table. A care flow belonging to another organization reads as not found.
While a run is going, a bar says how many of its care flows are done, and each outcome joins the results table as it arrives.
What the results mean
| Result | What happened |
|---|---|
| Success | The care flow is on the target version. |
| Skipped | It was already on the live release, or it wasn't found in the organization. |
| Failed | The upgrade was attempted and didn't go through. |
| Not attempted | The request ran out of time before this care flow started. It is unchanged. |
Care flows that were not attempted stay in the table, so running the upgrade again picks them up. A care flow already on the live version is skipped rather than upgraded twice, so a run can safely be repeated.
Copy failed IDs puts the failed care flow IDs on the clipboard. Copy JSON and Download JSON take the whole run, result by result.
Next steps
Next: Publish and set your care flow live — how a version gets published and made live in the first place.