Events
- Active Campaign
- Acuity
- Athena
- Axle Health
- Butterfly Labs
- Calendly
- Customer.io
- Elation
- Feathery
- Formsort
- Healthie
- Hubspot
- IntakeQ
- Junction
- Morf
- Segment
Actions
- Active Campaign
- Athena
- Customer.io
- Elation
- Facebook
- Freshdesk
- Google
- Healthie
- Hubspot
- IntakeQ
- Intercom
- Mixpanel
- Morf
- Nextdoor
- Open Phone
- Segment
- Slack
- Spruce
- Stedi
- Stripe
- Tiktok
- Twilio
List Appointments For Patient
Documentation for the List Appointments For Patient action for Elation
{
"$result_object_key": [
{
"appointment_datetime": "2016-10-13T11:15:00Z",
"appointment_duration_in_minutes": 15,
"appointment_id": "67176890458",
"appointment_location_details": "Zoom",
"appointment_type_title": "Follow-Up",
"billing": {
"billing_note": "This is a billing note",
"referring_provider": "Dr. John Doe",
"referring_provider_state": "CA"
},
"created_at": "2016-10-13T00:47:01Z",
"deleted_at": "",
"description": "follow up to procedure",
"instructions": "Please arrive 5 minutes early",
"last_modified_at": "2016-10-13T00:59:16Z",
"metadata": {
"baz": 42,
"foo": "bar"
},
"mode": "VIDEO",
"patient_id": "64058687489",
"payment": {
"amount": "20.00",
"appointment_id": "67176890458",
"bill": 42,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": null,
"id": "140755836010857",
"payment_collected_at": "2020-01-27T16:17:43Z"
},
"physician_id": "131074",
"practice_id": "65540",
"service_location": {
"address_line1": "123 Main Street",
"address_line2": "Suite 200",
"city": "San Francisco",
"id": "13631735",
"name": "Elation North",
"phone_number": "555-555-5555",
"state": "CA",
"zip": "94107"
},
"status": null,
"time_slot_status": "booked",
"time_slot_type": "appointment"
}
]
}
{
"$result_object_key": [
{
"appointment_datetime": "Scheduled date and time of the appointment.",
"appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
"appointment_id": "Unique identifier for the appointment. Read-only field.",
"appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
"appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
"billing": {
"billing_note": "Additional billing notes.",
"referring_provider": "Name of the referring provider.",
"referring_provider_state": "Two-letter state code of the referring provider."
},
"created_at": "Timestamp when the appointment was created.",
"deleted_at": "Timestamp when the appointment was deleted, if applicable.",
"description": "Additional description of the appointment. Maximum 500 characters.",
"instructions": "Instructions for the appointment. Maximum 500 characters.",
"last_modified_at": "Timestamp when the appointment was last modified.",
"metadata": "Additional metadata associated with the appointment.",
"mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
"patient_id": "ID of the patient for this appointment.",
"payment": {
"amount": "Payment amount in decimal format.",
"appointment_id": "ID of the associated appointment.",
"bill": "Associated bill identifier, if any.",
"created_at": "Timestamp when the payment record was created.",
"deleted_at": "Timestamp when the payment record was deleted, if applicable.",
"id": "Unique identifier for the payment. Read-only field.",
"payment_collected_at": "Timestamp when the payment was collected."
},
"physician_id": "ID of the physician for this appointment.",
"practice_id": "ID of the practice for this appointment.",
"service_location": {
"address_line1": "First line of the service location address.",
"address_line2": "Second line of the service location address.",
"city": "City of the service location.",
"id": "Unique identifier for the service location.",
"name": "Name of the service location.",
"phone_number": "Contact phone number for the service location.",
"state": "State of the service location.",
"zip": "ZIP code of the service location."
},
"status": "Current status of the appointment.",
"time_slot_status": "Status of the time slot.",
"time_slot_type": "Type of time slot."
}
]
}
Parameters
ID
This field maps to the destination API patient
field.
This field maps to the destination API from_date
field.
This field maps to the destination API to_date
field.
This field maps to the destination API physicians
field.
{
"$result_object_key": [
{
"appointment_datetime": "2016-10-13T11:15:00Z",
"appointment_duration_in_minutes": 15,
"appointment_id": "67176890458",
"appointment_location_details": "Zoom",
"appointment_type_title": "Follow-Up",
"billing": {
"billing_note": "This is a billing note",
"referring_provider": "Dr. John Doe",
"referring_provider_state": "CA"
},
"created_at": "2016-10-13T00:47:01Z",
"deleted_at": "",
"description": "follow up to procedure",
"instructions": "Please arrive 5 minutes early",
"last_modified_at": "2016-10-13T00:59:16Z",
"metadata": {
"baz": 42,
"foo": "bar"
},
"mode": "VIDEO",
"patient_id": "64058687489",
"payment": {
"amount": "20.00",
"appointment_id": "67176890458",
"bill": 42,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": null,
"id": "140755836010857",
"payment_collected_at": "2020-01-27T16:17:43Z"
},
"physician_id": "131074",
"practice_id": "65540",
"service_location": {
"address_line1": "123 Main Street",
"address_line2": "Suite 200",
"city": "San Francisco",
"id": "13631735",
"name": "Elation North",
"phone_number": "555-555-5555",
"state": "CA",
"zip": "94107"
},
"status": null,
"time_slot_status": "booked",
"time_slot_type": "appointment"
}
]
}
{
"$result_object_key": [
{
"appointment_datetime": "Scheduled date and time of the appointment.",
"appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
"appointment_id": "Unique identifier for the appointment. Read-only field.",
"appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
"appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
"billing": {
"billing_note": "Additional billing notes.",
"referring_provider": "Name of the referring provider.",
"referring_provider_state": "Two-letter state code of the referring provider."
},
"created_at": "Timestamp when the appointment was created.",
"deleted_at": "Timestamp when the appointment was deleted, if applicable.",
"description": "Additional description of the appointment. Maximum 500 characters.",
"instructions": "Instructions for the appointment. Maximum 500 characters.",
"last_modified_at": "Timestamp when the appointment was last modified.",
"metadata": "Additional metadata associated with the appointment.",
"mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
"patient_id": "ID of the patient for this appointment.",
"payment": {
"amount": "Payment amount in decimal format.",
"appointment_id": "ID of the associated appointment.",
"bill": "Associated bill identifier, if any.",
"created_at": "Timestamp when the payment record was created.",
"deleted_at": "Timestamp when the payment record was deleted, if applicable.",
"id": "Unique identifier for the payment. Read-only field.",
"payment_collected_at": "Timestamp when the payment was collected."
},
"physician_id": "ID of the physician for this appointment.",
"practice_id": "ID of the practice for this appointment.",
"service_location": {
"address_line1": "First line of the service location address.",
"address_line2": "Second line of the service location address.",
"city": "City of the service location.",
"id": "Unique identifier for the service location.",
"name": "Name of the service location.",
"phone_number": "Contact phone number for the service location.",
"state": "State of the service location.",
"zip": "ZIP code of the service location."
},
"status": "Current status of the appointment.",
"time_slot_status": "Status of the time slot.",
"time_slot_type": "Type of time slot."
}
]
}
Result Object Field Details
You can use the result of the action’s data as inputs to downstream workflow actions.
Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow.
Here we demonstrate how to refer to this data using the prefix $result_object_key
.
ID
Unique identifier for the appointment. Read-only field.
$result_object_key[*].appointment_id
"67176890458"
Scheduled date and time of the appointment.
$result_object_key[*].appointment_datetime
"2016-10-13T11:15:00Z"
Duration of the appointment in minutes. Must be between 1 and 1440 minutes.
$result_object_key[*].appointment_duration_in_minutes
15
Type of time slot.
$result_object_key[*].time_slot_type
"appointment"
Status of the time slot.
$result_object_key[*].time_slot_status
"booked"
Reason for the appointment. Required field, maximum 50 characters.
$result_object_key[*].appointment_type_title
"Follow-Up"
Additional description of the appointment. Maximum 500 characters.
$result_object_key[*].description
"follow up to procedure"
Current status of the appointment.
$result_object_key[*].status
APPOINTMENT_STATUS_SCHEDULED
APPOINTMENT_STATUS_CONFIRMED
APPOINTMENT_STATUS_CHECKED_OUT
APPOINTMENT_STATUS_CANCELLED
APPOINTMENT_STATUS_WITH_DOCTOR
APPOINTMENT_STATUS_IN_ROOM
APPOINTMENT_STATUS_CHECKED_IN
APPOINTMENT_STATUS_IN_ROOM_VITALS_TAKEN
APPOINTMENT_STATUS_NOT_SEEN
APPOINTMENT_STATUS_BILLED
APPOINTMENT_STATUS_NOT_SEEN_NO_SHOW
APPOINTMENT_STATUS_NOT_SEEN_LEFT_WITHOUT_SEEING
APPOINTMENT_STATUS_NOT_SEEN_OTHER
Location details where the appointment will take place.
$result_object_key[*].service_location
{
"address_line1": "123 Main Street",
"address_line2": "Suite 200",
"city": "San Francisco",
"id": "13631735",
"name": "Elation North",
"phone_number": "555-555-5555",
"state": "CA",
"zip": "94107"
}
ID
Unique identifier for the service location.
$result_object_key[*].service_location.id
"13631735"
Name of the service location.
$result_object_key[*].service_location.name
"Elation North"
PII
First line of the service location address.
$result_object_key[*].service_location.address_line1
"123 Main Street"
PII
Second line of the service location address.
$result_object_key[*].service_location.address_line2
"Suite 200"
PII
City of the service location.
$result_object_key[*].service_location.city
"San Francisco"
PII
State of the service location.
$result_object_key[*].service_location.state
"CA"
PII
ZIP code of the service location.
$result_object_key[*].service_location.zip
"94107"
PII
Contact phone number for the service location.
$result_object_key[*].service_location.phone_number
"555-555-5555"
Details for telehealth appointments. DEPRECATED as of 2024-06-11.
$result_object_key[*].appointment_location_details
"Zoom"
ID
ID of the patient for this appointment.
$result_object_key[*].patient_id
"64058687489"
ID of the physician for this appointment.
$result_object_key[*].physician_id
"131074"
ID of the practice for this appointment.
$result_object_key[*].practice_id
"65540"
HI
ID
PII
Additional metadata associated with the appointment.
$result_object_key[*].metadata
{
"baz": 42,
"foo": "bar"
}
Billing information for the appointment. Must be enabled for practice.
$result_object_key[*].billing
{
"billing_note": "This is a billing note",
"referring_provider": "Dr. John Doe",
"referring_provider_state": "CA"
}
Additional billing notes.
$result_object_key[*].billing.billing_note
"This is a billing note"
Name of the referring provider.
$result_object_key[*].billing.referring_provider
"Dr. John Doe"
Two-letter state code of the referring provider.
$result_object_key[*].billing.referring_provider_state
"CA"
Payment information associated with the appointment.
$result_object_key[*].payment
{
"amount": "20.00",
"appointment_id": "67176890458",
"bill": 42,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": null,
"id": "140755836010857",
"payment_collected_at": "2020-01-27T16:17:43Z"
}
ID
Unique identifier for the payment. Read-only field.
$result_object_key[*].payment.id
"140755836010857"
Payment amount in decimal format.
$result_object_key[*].payment.amount
"20.00"
Timestamp when the payment was collected.
$result_object_key[*].payment.payment_collected_at
"2020-01-27T16:17:43Z"
Associated bill identifier, if any.
$result_object_key[*].payment.bill
42
ID of the associated appointment.
$result_object_key[*].payment.appointment_id
"67176890458"
Timestamp when the payment record was created.
$result_object_key[*].payment.created_at
"2020-01-27T16:17:43Z"
Timestamp when the payment record was deleted, if applicable.
$result_object_key[*].payment.deleted_at
null
Timestamp when the appointment was created.
$result_object_key[*].created_at
"2016-10-13T00:47:01Z"
Timestamp when the appointment was last modified.
$result_object_key[*].last_modified_at
"2016-10-13T00:59:16Z"
Timestamp when the appointment was deleted, if applicable.
$result_object_key[*].deleted_at
""
Mode of the appointment. Must be either IN_PERSON or VIDEO.
$result_object_key[*].mode
"VIDEO"
Instructions for the appointment. Maximum 500 characters.
$result_object_key[*].instructions
"Please arrive 5 minutes early"
{
"$result_object_key": [
{
"appointment_datetime": "2016-10-13T11:15:00Z",
"appointment_duration_in_minutes": 15,
"appointment_id": "67176890458",
"appointment_location_details": "Zoom",
"appointment_type_title": "Follow-Up",
"billing": {
"billing_note": "This is a billing note",
"referring_provider": "Dr. John Doe",
"referring_provider_state": "CA"
},
"created_at": "2016-10-13T00:47:01Z",
"deleted_at": "",
"description": "follow up to procedure",
"instructions": "Please arrive 5 minutes early",
"last_modified_at": "2016-10-13T00:59:16Z",
"metadata": {
"baz": 42,
"foo": "bar"
},
"mode": "VIDEO",
"patient_id": "64058687489",
"payment": {
"amount": "20.00",
"appointment_id": "67176890458",
"bill": 42,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": null,
"id": "140755836010857",
"payment_collected_at": "2020-01-27T16:17:43Z"
},
"physician_id": "131074",
"practice_id": "65540",
"service_location": {
"address_line1": "123 Main Street",
"address_line2": "Suite 200",
"city": "San Francisco",
"id": "13631735",
"name": "Elation North",
"phone_number": "555-555-5555",
"state": "CA",
"zip": "94107"
},
"status": null,
"time_slot_status": "booked",
"time_slot_type": "appointment"
}
]
}
{
"$result_object_key": [
{
"appointment_datetime": "Scheduled date and time of the appointment.",
"appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
"appointment_id": "Unique identifier for the appointment. Read-only field.",
"appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
"appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
"billing": {
"billing_note": "Additional billing notes.",
"referring_provider": "Name of the referring provider.",
"referring_provider_state": "Two-letter state code of the referring provider."
},
"created_at": "Timestamp when the appointment was created.",
"deleted_at": "Timestamp when the appointment was deleted, if applicable.",
"description": "Additional description of the appointment. Maximum 500 characters.",
"instructions": "Instructions for the appointment. Maximum 500 characters.",
"last_modified_at": "Timestamp when the appointment was last modified.",
"metadata": "Additional metadata associated with the appointment.",
"mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
"patient_id": "ID of the patient for this appointment.",
"payment": {
"amount": "Payment amount in decimal format.",
"appointment_id": "ID of the associated appointment.",
"bill": "Associated bill identifier, if any.",
"created_at": "Timestamp when the payment record was created.",
"deleted_at": "Timestamp when the payment record was deleted, if applicable.",
"id": "Unique identifier for the payment. Read-only field.",
"payment_collected_at": "Timestamp when the payment was collected."
},
"physician_id": "ID of the physician for this appointment.",
"practice_id": "ID of the practice for this appointment.",
"service_location": {
"address_line1": "First line of the service location address.",
"address_line2": "Second line of the service location address.",
"city": "City of the service location.",
"id": "Unique identifier for the service location.",
"name": "Name of the service location.",
"phone_number": "Contact phone number for the service location.",
"state": "State of the service location.",
"zip": "ZIP code of the service location."
},
"status": "Current status of the appointment.",
"time_slot_status": "Status of the time slot.",
"time_slot_type": "Type of time slot."
}
]
}