Awell Health Developer Hub
Dev Hub

Any track configured to be manually triggered in a patient pathway can be scheduled for a date in the future. Scheduling a track in the past will cause it to be added to the care flow immediately.

Request

Mutation

01

Variables

The pathway_id is the id of the patient pathway for which you want to stop a track. Any query that returns a patient pathway such as patientPathways or pathways, will return a pathway id.

The track_id is the id of the track that you want to stop. You can see a list of of schedulable tracks by using the adHocTracks query.

01

cancel_any_scheduled

cancel_any_scheduled is an optional convenience argument that is useful for when a specific track definition should only ever have one pending instance for a given pathway.

By setting cancel_any_scheduled to be true, you can freely use the scheduleTrack mutation without needing to manage any previously scheduled instance(s). Any scheduled tracks of this definition will be canceled and replaced with a new scheduled instance.

Note that cancel_any_scheduled set to true only cancels previous instances of the specified track definition. If you wish to cancel all scheduled tracks for a pathway when there are multiple track definitions, you can use the cancelScheduledTracks mutation after fetching all scheduled track ids with scheduledTracks.

Response

01