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:

  1. Trigger — an object event that starts the automation (e.g. Appointment created).
  2. Actions — what runs when the trigger fires (e.g. Send Email, Delay Until, Filter).
  3. 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:

ObjectTypical use
AppointmentAppointment lifecycle automations (confirmations, reminders, rescheduling, cancellation)
AttendeePer-attendee events on an appointment (no-shows, status flips)
CaregiverOnboarding/offboarding caregivers, role or status changes
Care PlanShare-with-patient and signing events on care plans
Care TeamMembership changes on a patient's care team
DocumentDocument templates, signing, sharing with patient
Eligibility CheckPost-eligibility-check notifications
FaxInbound faxes, attribution to a patient
Form ResponseForm completion, scoring
InvoiceInvoice status changes, sharing with patient
MessageInbound/outbound messages across channels
NoteClinical note lifecycle (signing, sharing)
PatientPatient creation, status changes
ProviderProvider onboarding
Referring ProviderReferring provider lifecycle
RequisitionLab/imaging requisition sharing
SuperbillSuperbill creation
SupportSupport member onboarding
TaskTask assignment and status changes

Actions

ActionDescription
Delay ForPause the automation for a relative duration (ms).
Delay UntilPause until a specific time derived from the trigger object (e.g. Appointment start time + delta).
FilterContinue only if a field condition is met. Stops the automation if not.
Create TaskCreate a task.
Update TaskUpdate a task.
Create NoteCreate a clinical note.
Update NoteUpdate a clinical note.
Send NotificationSend an in-app notification.
Send MessageSend a secure message through the portal.
Send EmailSend an email (requires email integration).
Send SMSSend a text message.
Send FormSend one or more forms to a recipient.
Share With PatientShare an object (note, document, etc.) with the patient.
Create Insurance ClaimAuto-generate an insurance claim, linked to the source note.
Create SuperbillAuto-generate a superbill.
Update StatusChange the status of the trigger object (e.g. move ProspectActive).
Check EligibilityRun an eligibility check.
Create InvoiceAuto-create an invoice.
Collect PaymentCharge a payment method on file.
Void InvoiceVoid 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")
  • changed to — true when a field transitions to a specific value on update ("Status" changed to "Cancelled")
  • is Null / is Not Null — presence check ("Patient" is "Not Null")

Multiple conditions can be combined with AND / OR.

Delay deltas

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

DeltaValue (ms)
10 minutes600000
1 hour3600000
1 day86400000
3 days259200000
7 days604800000

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

FieldDescription
StatusScheduled, Rescheduled, Cancelled, etc.
Interaction TypeIn-person, telehealth, phone, etc.
Appointment TypeConfigured appointment type.
Created ByRole or user that created the appointment.
HostProvider hosting the appointment.
InternalWhether the appointment is internal-only.
Medical CenterLocation/medical center.
Peer GroupPeer group for cohort-level filtering.

Recipients

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


Attendee

Filterable fields

FieldDescription
No ShowBoolean flag when attendee is marked no-show.
StatusAttendee status (Active, Prospect, etc.).
Appointment TypeType of the parent appointment.

Recipients

Attendee, Care Team


Caregiver

Filterable fields

FieldDescription
Peer GroupCaregiver's peer group.
Medical CenterCaregiver's medical center.
StatusCaregiver status.
RoleCaregiver role.
Created ByWho created the caregiver record.

Recipients

Caregiver, Created By


Care Plan

Filterable fields

FieldDescription
Care Plan TemplateTemplate used to create the care plan.
Share With PatientWhether the care plan has been shared with the patient.
Signing StatusDraft, Signed, Locked, etc.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Created By


Care Team

Filterable fields

FieldDescription
PatientPatient the care team is associated with.
MembersTeam member composition.
Created ByWho created the care team record.

Recipients

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


Document

Filterable fields

FieldDescription
TypeDocument type.
Document TemplateTemplate used.
Created ByWho created the document.
Share With PatientWhether shared with the patient.
Signing StatusDraft, Signed, Locked, etc.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Created By


Eligibility Check

Filterable fields

FieldDescription
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers


Fax

Filterable fields

FieldDescription
PatientPatient the fax is attributed to.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Care Team


Form Response

Filterable fields

FieldDescription
FormThe form the response is for.
StatusDraft, Completed, etc.
Created ByWho created the form response (e.g. Patient, Provider).
ScoreNumeric score of the form response.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Care Team, Created By


Invoice

Filterable fields

FieldDescription
Share With PatientWhether shared with the patient.
StatusDraft, Open, Paid, Void, etc.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers


Message

Filterable fields

FieldDescription
TypeMessage type.
ModeChannel or delivery mode.
PageeRecipient being paged.
Created BySender role or user.
TagsMessage tags.
Medical CenterMedical center scope.

Recipients

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


Note

Filterable fields

FieldDescription
Note TemplateTemplate used to create the note.
Share With PatientWhether shared with the patient.
Signing StatusDraft, Signed (1 provider), Locked, etc.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Created By


Patient

Filterable fields

FieldDescription
Peer GroupPatient's peer group.
Medical CenterPatient's medical center.
StatusProspect, Active, Inactive, etc.
RolePatient role.
Created ByWho 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

FieldDescription
Share With PatientWhether shared with the patient.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Created By


Superbill

Filterable fields

FieldDescription
Created ByWho created the superbill.
Peer GroupPeer 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

FieldDescription
StatusTask status.
Assigned ToUser the task is assigned to.
Created ByWho created the task.
TagsTask tags.
Peer GroupPeer group of the associated patient.

Recipients

Patient, Caregivers, Assigned To, Created By


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.
  • 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.