Automations Technical Reference

This page is the complete reference for building automations. For setup guidance and common automation recipes, see Automations.

Every automation has three building blocks:

Trigger — an object event that starts the automation (e.g. Appointment created).
Actions — what runs when the trigger fires (e.g. Send Email, Delay Until, Filter).
Filters & Recipients — scoped to the trigger object. Filters narrow when the automation runs; recipients determine who receives Send Email, Send SMS, Send Notification, Send Form, and similar actions.

Triggers

Every trigger is a combination of a trigger object and a trigger event. All trigger objects support all three events.

Trigger events: Created, Updated, Deleted

Trigger objects:

Object	Typical use
Appointment	Appointment lifecycle automations (confirmations, reminders, rescheduling, cancellation)
Attendee	Per-attendee events on an appointment (no-shows, status flips)
Caregiver	Onboarding/offboarding caregivers, role or status changes
Care Plan	Share-with-patient and signing events on care plans
Care Team	Membership changes on a patient's care team
Document	Document templates, signing, sharing with patient
Eligibility Check	Post-eligibility-check notifications
Fax	Inbound faxes, attribution to a patient
Form Response	Form completion, scoring
Invoice	Invoice status changes, sharing with patient
Message	Inbound/outbound messages across channels
Note	Clinical note lifecycle (signing, sharing)
Patient	Patient creation, status changes
Provider	Provider onboarding
Referring Provider	Referring provider lifecycle
Requisition	Lab/imaging requisition sharing
Superbill	Superbill creation
Support	Support member onboarding
Task	Task assignment and status changes

Actions

Action	Description
`Delay For`	Pause the automation for a relative duration (ms).
`Delay Until`	Pause until a specific time derived from the trigger object (e.g. `Appointment start time + delta`).
`Filter`	Continue only if a field condition is met. Stops the automation if not.
`Create Task`	Create a task.
`Send Notification`	Send an in-app notification.
`Send Message`	Send a secure message through the portal.
`Send Email`	Send an email (requires email integration).
`Send SMS`	Send a text message.
`Send Form`	Send one or more forms to a recipient.
`Share With Patient`	Share an object (note, document, etc.) with the patient.
`Create Insurance Claim`	Auto-generate an insurance claim, linked to the source note.
`Create Superbill`	Auto-generate a superbill.
`Update Status`	Change the status of the trigger object (e.g. move `Prospect` → `Active`).
`Check Eligibility`	Run an eligibility check.
`Create Invoice`	Auto-create an invoice.
`Collect Payment`	Charge a payment method on file.
`Void Invoice`	Void an existing invoice.

Filter operators

The Filter action supports comparisons on any filterable field for the trigger object. Commonly used operators:

is / is not — compare to a specific value ("Created By" is "Provider")
includes / does not include — for fields that hold multiple values, such as Tags and Peer Group ("Tags" includes "Urgent")
changed to — true when a field transitions to a specific value on update ("Status" changed to "Cancelled")
greater than / less than — only supported on the Score field of the Form Response trigger ("Score" greater than "10")
Null / Not Null — values that can be selected with changed to to check whether a field was cleared or set on update ("Assigned To" changed to "Not Null"). They do not work with is / is not.

Multiple conditions can be combined with AND / OR.

The builder lets you pick any operator for any field, but some fields are only evaluated with specific operators. With any other operator, the filter will not match:

Field	Supported operators
Peer Group	`includes` / `does not include` (and `changed to` on the `Patient` trigger)
Tags	`includes` / `does not include` (and `changed to` on the `Task` trigger)
Signing Status	`changed to`
Score	`is` / `is not`, `greater than` / `less than`
Custom fields	`changed to`

Delay deltas

Delay For and Delay Until accept time deltas in milliseconds. Common values:

Delta	Value (ms)
10 minutes	`600000`
1 hour	`3600000`
1 day	`86400000`
3 days	`259200000`
7 days	`604800000`

Negative deltas are used with Delay Until to fire before the origin timestamp (e.g. -86400000 = 24 hours before the appointment start).

Per-Trigger Reference

Each section below lists the filterable fields available on the Filter action and the recipient options available on actions like Send Email, Send SMS, Send Notification, and Send Form.

Appointment

Filterable fields

Field	Description
Status	Scheduled, Rescheduled, Cancelled, etc.
Interaction Type	In-person, telehealth, phone, etc.
Appointment Type	Configured appointment type.
Created By	Role or user that created the appointment.
Host	Provider hosting the appointment.
Internal	Whether the appointment is internal-only.
Medical Center	Location/medical center.
Peer Group	Peer group for cohort-level filtering.

Recipients

Host, Attendees, Observers, New Attendees, Removed Attendees, New Observers, Removed Observers, Created By

Attendee

Filterable fields

Field	Description
No Show	Boolean flag when attendee is marked no-show.
Status	Attendee status (Active, Prospect, etc.).
Appointment Type	Type of the parent appointment.

Recipients

Attendee, Care Team

Caregiver

Filterable fields

Field	Description
Peer Group	Caregiver's peer group.
Medical Center	Caregiver's medical center.
Status	Caregiver status.
Role	Caregiver role.
Created By	Who created the caregiver record.

Recipients

Caregiver, Created By

Care Plan

Filterable fields

Field	Description
Care Plan Template	Template used to create the care plan.
Share With Patient	Whether the care plan has been shared with the patient.
Signing Status	Not Signed, Signed (1 Provider), or Signed (2 Providers).
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Created By

Care Team

Filterable fields

Field	Description
Patient	Patient the care team is associated with.
Members	Team member composition.
Created By	Who created the care team record.

Recipients

Patient, Members, New Members, Removed Members, Created By

Document

Filterable fields

Field	Description
Type	Document type.
Document Template	Template used.
Created By	Who created the document.
Share With Patient	Whether shared with the patient.
Signing Status	Not Signed, Signed (1 Provider), or Signed (2 Providers).
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Created By

Eligibility Check

Filterable fields

Field	Description
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers

Fax

Filterable fields

Field	Description
Patient	Patient the fax is attributed to.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Care Team

Form Response

Filterable fields

Field	Description
Form	The form the response is for.
Status	Draft, Completed, etc.
Created By	Who created the form response (e.g. Patient, Provider).
Score	Numeric score of the form response.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Care Team, Created By

Invoice

Filterable fields

Field	Description
Share With Patient	Whether shared with the patient.
Status	Draft, Open, Paid, Void, etc.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers

Message

Filterable fields

Field	Description
Type	Message type.
Mode	Channel or delivery mode.
Pagee	Recipient being paged.
Created By	Sender role or user.
Tags	Message tags.
Medical Center	Medical center scope.

Recipients

Created By, Pagee, Organization Member Participants, Patient Participants, Organization Member Observers

Note

Filterable fields

Field	Description
Note Template	Template used to create the note.
Share With Patient	Whether shared with the patient.
Signing Status	Not Signed, Signed (1 Provider), or Signed (2 Providers).
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Created By

Patient

Filterable fields

Field	Description
Peer Group	Patient's peer group.
Medical Center	Patient's medical center.
Status	Prospect, Active, Inactive, etc.
Role	Patient role.
Created By	Who created the patient record.

Recipients

Patient, Care Team Members, Created By

Provider

Filterable fields

No filterable fields currently supported.

Recipients

Provider, Created By

Referring Provider

Filterable fields

No filterable fields currently supported.

Recipients

Referring Provider

Requisition

Filterable fields

Field	Description
Share With Patient	Whether shared with the patient.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Created By

Superbill

Filterable fields

Field	Description
Created By	Who created the superbill.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Created By

Support

Filterable fields

No filterable fields currently supported.

Recipients

Support, Created By

Task

Filterable fields

Field	Description
Status	Task status.
Assigned To	User the task is assigned to.
Created By	Who created the task.
Tags	Task tags.
Peer Group	Peer group of the associated patient.

Recipients

Patient, Caregivers, Assigned To, Created By

Deep link tokens

Deep link tokens are replaced with a link that opens the record that triggered the automation. They can be used in the text of Send Email, Send SMS, and Send Notification actions. A token only works when the automation's trigger object matches it (e.g. {{note.emr_link}} only works on a Note trigger).

Trigger object	EMR link	Patient portal link
Note	`{{note.emr_link}}`	`{{note.patient_portal_link}}`
Care Plan	`{{care_plan.emr_link}}`	`{{care_plan.patient_portal_link}}`
Document	`{{document.emr_link}}`	`{{document.patient_portal_link}}`
Invoice	`{{invoice.emr_link}}`	`{{invoice.patient_portal_link}}`
Superbill	`{{superbill.emr_link}}`	`{{superbill.patient_portal_link}}`
Task	`{{task.emr_link}}`	Not available

EMR links open the record in the patient's chart in the EMR, for organization members. A task that is not tied to a patient opens in the organization's tasks instead.
Patient portal links open the record in the patient portal, for patients.

Notes

Recipients resolve to one or more users at runtime. If a recipient variable resolves to multiple users (e.g. Attendees, Care Team), the action is sent to each of them.
On Patient, Caregiver, Provider, and Support triggers, any active custom fields that are set to be added to that object can also be used as filterable fields with the changed to operator.
Other fields not listed above cannot currently be used as filters in the automation builder. Reach out to your Avon contact if you need a new filterable field.
Send Email requires a configured and authenticated email integration. Emails sent from unauthenticated domains will fail.
Always test new automations in your sandbox before enabling in production.