ReferenceFor engineers
Reference
The Awell Orchestration API operations, grouped by the domain object they act on (patients, care flows, activities, tracks, and more).
The queries, mutations, and subscriptions in the Orchestration API, grouped by the object each one acts on. For the behavior that applies across all of them (authentication, paging, errors, versions), see Guides.
Operations by object
| Page | Covers |
|---|---|
| Patients | Create, find, update, and manage patients and their data points. |
| Care flows | Start, stop, pause, and inspect care flows, their activities, and their data points. |
| Activities | Query the activities in a care flow, and retry, expire, or annotate them. |
| Activity types | Forms, checklists, messages, clinical notes, calculations, and EMR reports. |
| Tracks | Query and schedule tracks — the groupings of steps within a care flow. |
| Stakeholders | Look up the stakeholders that participate in a care flow. |
| Timers | Query and expire the timers that delay steps. |
| Hosted sessions & pages | Start and complete Awell-hosted sessions for stakeholders. |
| API calls & webhooks | Inspect the calls a care flow makes, and retry failed ones. |
| Subscriptions | Real-time events for activities, sessions, care flows, API calls, and webhooks. |
| Tenant | Read information about the current tenant. |