{ "appointment_confirmation_id": "ID of the appointment confirmation", "appointment_confirmation_name": "Name of the appointment confirmation", "appointment_date": "Month of the Appointment", "appointment_datetime": "The appointment date and time", "appointment_day_of_month": "Day (ordinal) of the month of the Appointment", "appointment_day_of_week": "Day of the week of the Appointment", "appointment_id": "Appointment ID of the booked appointment", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_month": "Month of the Appointment", "appointment_notes": { "created_at": "When the note was created", "created_by": "Who created the note", "display_on_schedule": "Whether to display the note on the schedule", "id": "ID of the note", "note_id": "ID of the note", "note_text": "Text content of the note", "text": "Text content of the note" }, "appointment_patient_timezone_identifier": "The timezone name of the appointment", "appointment_provider_id": "The athenaNet provider ID", "appointment_status": "The athenaNet appointment status. x=cancelled f=future o=open 2=checked in 3=checked out 4=charge entered", "appointment_time": "Time of the Appointment (in the Appointment's registered timezone)", "appointment_timezone_offset": "The timezone offset of the appointment", "appointment_timezone_offset_seconds_east_of_utc": "The timezone offset of the appointment in seconds east of UTC", "appointment_timezone_short_name": "The timezone short name of the appointment", "appointment_type_id": "The ID for the appointment type", "appointment_type_title": "The practice-friendly name for this appointment type", "cancel_reason_id": "ID of the reason for cancellation", "cancel_reason_name": "Name of the reason for cancellation", "cancel_reason_no_show": "Whether the cancellation was due to a no-show", "cancel_reason_slot_available": "Whether the slot became available due to cancellation", "cancelled_by": "User who cancelled the appointment", "cancelled_datetime": "Date and time when the appointment was cancelled", "charge_entry_not_required": "Whether charge entry is not required for this appointment", "charge_entry_not_required_reason": "Reason why charge entry is not required", "check_in_datetime": "Date and time when the patient checked in", "check_out_datetime": "Date and time when the patient checked out", "claims": { "billed_provider_id": "ID of the provider who billed the claim", "billed_service_date": "Date when the service was billed", "claim_created_date": "Date and time when the claim was created", "claim_id": "ID of the claim", "custom_fields": { "custom_field_id": "Corresponds to the /customfields customfieldid", "custom_field_value": "For a non-select custom field, the value", "option_id": "For a select custom field, the selectid value (from /customfield's selectlist)" }, "department_id": "ID of the department where the service was billed", "diagnoses": { "deleted_diagnosis": "Whether the diagnosis was deleted", "diagnosis_category": "Category of the diagnosis", "diagnosis_code": "Code for the diagnosis", "diagnosis_codeset": "Codeset for the diagnosis", "diagnosis_description": "Description of the diagnosis", "diagnosis_id": "ID of the diagnosis", "diagnosis_raw_code": "Raw code for the diagnosis" }, "patient_id": "ID of the patient who was billed", "procedures": { "charge_amount": "Amount of the charge", "procedure_category": "Category of the procedure", "procedure_code": "Code for the procedure", "procedure_description": "Description of the procedure", "transaction_id": "ID of the transaction" } }, "coordinator_enterprise": "Whether the coordinator is enterprise", "coordinator_enterprise_yn": "Enterprise coordinator status as Y/N", "copay": "Expected copay for this appointment", "department_id": "The athenaNet department id", "encounter_id": "ID of the encounter associated with the appointment", "encounter_status": "Status of the encounter", "frozen_yn": "If true, this appointment slot is frozen", "insurances": { "eligibility_last_checked": "When eligibility was last checked", "eligibility_reason": "Reason for eligibility status", "eligibility_status": "Status of eligibility", "id": "Insurance ID", "insurance_id": "Insurance identifier", "insurance_id_number": "Insurance ID number", "insurance_package_address1": "Insurance package address - 1st line", "insurance_package_city": "Insurance package city", "insurance_package_id": "Insurance package ID", "insurance_package_state": "Insurance package state (2 letter abbreviation)", "insurance_package_zip": "Insurance package zip code", "insurance_phone": "Insurance phone number", "insurance_plan_display_name": "Insurance plan display name", "insurance_plan_name": "Insurance plan name", "insurance_policy_holder": "Insurance policy holder", "insurance_policy_holder_address1": "Insurance policy holder address - 1st line", "insurance_policy_holder_city": "Insurance policy holder city", "insurance_policy_holder_country_code": "Insurance policy holder country code", "insurance_policy_holder_country_iso3166": "Insurance policy holder country (ISO 3166-1)", "insurance_policy_holder_dob": "Insurance policy holder date of birth", "insurance_policy_holder_first_name": "Insurance policy holder first name", "insurance_policy_holder_last_name": "Insurance policy holder last name", "insurance_policy_holder_sex": "Insurance policy holder sex", "insurance_policy_holder_state": "Insurance policy holder state (2 letter abbreviation)", "insurance_policy_holder_zip": "Insurance policy holder zip code", "insurance_type": "Insurance type", "insured_address": "Insured person's address", "insured_city": "Insured person's city", "insured_country_code": "Insured person's country code", "insured_country_iso3166": "Insured person's country (ISO 3166-1)", "insured_dob": "Insured person's date of birth", "insured_entity_type_id": "Insured entity type ID", "insured_first_name": "Insured person's first name", "insured_last_name": "Insured person's last name", "insured_sex": "Insured person's sex", "insured_state": "Insured person's state (2 letter abbreviation)", "insured_zip": "Insured person's zip code", "irc_name": "IRC name", "relationship_to_insured": "Relationship to insured person", "relationship_to_insured_id": "Relationship to insured person ID", "sequence_number": "Sequence number" }, "last_modified_at": "Date and time when the appointment was last modified", "last_modified_by": "User who last modified the appointment", "patient_appointment_type_name": "The patient-friendly name for this appointment type", "patient_id": "The athenaNet patient ID for this appointment", "patient_location_id": "ID of the patient's location", "referring_provider_id": "The referring provider ID", "reminder_details": { "call_time": "Time of the reminder call", "message_result_id": "ID of the message result", "message_type": "Type of the message", "result": "Result of the reminder" }, "rendering_provider_id": "The rendering provider ID", "rescheduled_appointment_id": "When an appointment is rescheduled, this is the ID of the replacement appointment", "scheduled_by": "User who scheduled the appointment", "scheduled_datetime": "Date and time when the appointment was scheduled", "start_check_in_datetime": "The appointment check in start time", "start_check_out_datetime": "The appointment check out start time", "stop_check_in_datetime": "The appointment check in end time", "stop_exam_datetime": "Date and time when the exam was completed", "stop_intake_datetime": "Date and time when the intake was completed", "stop_sign_off_datetime": "The appointment sign off end time", "suggested_overbooking": "Suggested overbooking status", "supervising_provider_id": "The supervising provider ID", "template_appointment_id": "ID of the template appointment", "template_appointment_type_id": "ID of the template appointment type", "urgent_yn": "Urgent flag for the appointment", "use_expected_procedure_codes": { "procedure_code": "Code for the procedure", "procedure_code_description": "Description of the procedure code" }, "visit_id": "Visit ID of the appointment"}
Athena
Appointment
Event payload details and trigger documentation for Appointment data from Athena
{ "appointment_confirmation_id": "ID of the appointment confirmation", "appointment_confirmation_name": "Name of the appointment confirmation", "appointment_date": "Month of the Appointment", "appointment_datetime": "The appointment date and time", "appointment_day_of_month": "Day (ordinal) of the month of the Appointment", "appointment_day_of_week": "Day of the week of the Appointment", "appointment_id": "Appointment ID of the booked appointment", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_month": "Month of the Appointment", "appointment_notes": { "created_at": "When the note was created", "created_by": "Who created the note", "display_on_schedule": "Whether to display the note on the schedule", "id": "ID of the note", "note_id": "ID of the note", "note_text": "Text content of the note", "text": "Text content of the note" }, "appointment_patient_timezone_identifier": "The timezone name of the appointment", "appointment_provider_id": "The athenaNet provider ID", "appointment_status": "The athenaNet appointment status. x=cancelled f=future o=open 2=checked in 3=checked out 4=charge entered", "appointment_time": "Time of the Appointment (in the Appointment's registered timezone)", "appointment_timezone_offset": "The timezone offset of the appointment", "appointment_timezone_offset_seconds_east_of_utc": "The timezone offset of the appointment in seconds east of UTC", "appointment_timezone_short_name": "The timezone short name of the appointment", "appointment_type_id": "The ID for the appointment type", "appointment_type_title": "The practice-friendly name for this appointment type", "cancel_reason_id": "ID of the reason for cancellation", "cancel_reason_name": "Name of the reason for cancellation", "cancel_reason_no_show": "Whether the cancellation was due to a no-show", "cancel_reason_slot_available": "Whether the slot became available due to cancellation", "cancelled_by": "User who cancelled the appointment", "cancelled_datetime": "Date and time when the appointment was cancelled", "charge_entry_not_required": "Whether charge entry is not required for this appointment", "charge_entry_not_required_reason": "Reason why charge entry is not required", "check_in_datetime": "Date and time when the patient checked in", "check_out_datetime": "Date and time when the patient checked out", "claims": { "billed_provider_id": "ID of the provider who billed the claim", "billed_service_date": "Date when the service was billed", "claim_created_date": "Date and time when the claim was created", "claim_id": "ID of the claim", "custom_fields": { "custom_field_id": "Corresponds to the /customfields customfieldid", "custom_field_value": "For a non-select custom field, the value", "option_id": "For a select custom field, the selectid value (from /customfield's selectlist)" }, "department_id": "ID of the department where the service was billed", "diagnoses": { "deleted_diagnosis": "Whether the diagnosis was deleted", "diagnosis_category": "Category of the diagnosis", "diagnosis_code": "Code for the diagnosis", "diagnosis_codeset": "Codeset for the diagnosis", "diagnosis_description": "Description of the diagnosis", "diagnosis_id": "ID of the diagnosis", "diagnosis_raw_code": "Raw code for the diagnosis" }, "patient_id": "ID of the patient who was billed", "procedures": { "charge_amount": "Amount of the charge", "procedure_category": "Category of the procedure", "procedure_code": "Code for the procedure", "procedure_description": "Description of the procedure", "transaction_id": "ID of the transaction" } }, "coordinator_enterprise": "Whether the coordinator is enterprise", "coordinator_enterprise_yn": "Enterprise coordinator status as Y/N", "copay": "Expected copay for this appointment", "department_id": "The athenaNet department id", "encounter_id": "ID of the encounter associated with the appointment", "encounter_status": "Status of the encounter", "frozen_yn": "If true, this appointment slot is frozen", "insurances": { "eligibility_last_checked": "When eligibility was last checked", "eligibility_reason": "Reason for eligibility status", "eligibility_status": "Status of eligibility", "id": "Insurance ID", "insurance_id": "Insurance identifier", "insurance_id_number": "Insurance ID number", "insurance_package_address1": "Insurance package address - 1st line", "insurance_package_city": "Insurance package city", "insurance_package_id": "Insurance package ID", "insurance_package_state": "Insurance package state (2 letter abbreviation)", "insurance_package_zip": "Insurance package zip code", "insurance_phone": "Insurance phone number", "insurance_plan_display_name": "Insurance plan display name", "insurance_plan_name": "Insurance plan name", "insurance_policy_holder": "Insurance policy holder", "insurance_policy_holder_address1": "Insurance policy holder address - 1st line", "insurance_policy_holder_city": "Insurance policy holder city", "insurance_policy_holder_country_code": "Insurance policy holder country code", "insurance_policy_holder_country_iso3166": "Insurance policy holder country (ISO 3166-1)", "insurance_policy_holder_dob": "Insurance policy holder date of birth", "insurance_policy_holder_first_name": "Insurance policy holder first name", "insurance_policy_holder_last_name": "Insurance policy holder last name", "insurance_policy_holder_sex": "Insurance policy holder sex", "insurance_policy_holder_state": "Insurance policy holder state (2 letter abbreviation)", "insurance_policy_holder_zip": "Insurance policy holder zip code", "insurance_type": "Insurance type", "insured_address": "Insured person's address", "insured_city": "Insured person's city", "insured_country_code": "Insured person's country code", "insured_country_iso3166": "Insured person's country (ISO 3166-1)", "insured_dob": "Insured person's date of birth", "insured_entity_type_id": "Insured entity type ID", "insured_first_name": "Insured person's first name", "insured_last_name": "Insured person's last name", "insured_sex": "Insured person's sex", "insured_state": "Insured person's state (2 letter abbreviation)", "insured_zip": "Insured person's zip code", "irc_name": "IRC name", "relationship_to_insured": "Relationship to insured person", "relationship_to_insured_id": "Relationship to insured person ID", "sequence_number": "Sequence number" }, "last_modified_at": "Date and time when the appointment was last modified", "last_modified_by": "User who last modified the appointment", "patient_appointment_type_name": "The patient-friendly name for this appointment type", "patient_id": "The athenaNet patient ID for this appointment", "patient_location_id": "ID of the patient's location", "referring_provider_id": "The referring provider ID", "reminder_details": { "call_time": "Time of the reminder call", "message_result_id": "ID of the message result", "message_type": "Type of the message", "result": "Result of the reminder" }, "rendering_provider_id": "The rendering provider ID", "rescheduled_appointment_id": "When an appointment is rescheduled, this is the ID of the replacement appointment", "scheduled_by": "User who scheduled the appointment", "scheduled_datetime": "Date and time when the appointment was scheduled", "start_check_in_datetime": "The appointment check in start time", "start_check_out_datetime": "The appointment check out start time", "stop_check_in_datetime": "The appointment check in end time", "stop_exam_datetime": "Date and time when the exam was completed", "stop_intake_datetime": "Date and time when the intake was completed", "stop_sign_off_datetime": "The appointment sign off end time", "suggested_overbooking": "Suggested overbooking status", "supervising_provider_id": "The supervising provider ID", "template_appointment_id": "ID of the template appointment", "template_appointment_type_id": "ID of the template appointment type", "urgent_yn": "Urgent flag for the appointment", "use_expected_procedure_codes": { "procedure_code": "Code for the procedure", "procedure_code_description": "Description of the procedure code" }, "visit_id": "Visit ID of the appointment"}
Events
Triggering Webhook Types
The following event types are associated with the Appointment event payload from Athena.
{ "appointment_confirmation_id": "ID of the appointment confirmation", "appointment_confirmation_name": "Name of the appointment confirmation", "appointment_date": "Month of the Appointment", "appointment_datetime": "The appointment date and time", "appointment_day_of_month": "Day (ordinal) of the month of the Appointment", "appointment_day_of_week": "Day of the week of the Appointment", "appointment_id": "Appointment ID of the booked appointment", "appointment_length_minutes": "Duration of the appointment in minutes", "appointment_month": "Month of the Appointment", "appointment_notes": { "created_at": "When the note was created", "created_by": "Who created the note", "display_on_schedule": "Whether to display the note on the schedule", "id": "ID of the note", "note_id": "ID of the note", "note_text": "Text content of the note", "text": "Text content of the note" }, "appointment_patient_timezone_identifier": "The timezone name of the appointment", "appointment_provider_id": "The athenaNet provider ID", "appointment_status": "The athenaNet appointment status. x=cancelled f=future o=open 2=checked in 3=checked out 4=charge entered", "appointment_time": "Time of the Appointment (in the Appointment's registered timezone)", "appointment_timezone_offset": "The timezone offset of the appointment", "appointment_timezone_offset_seconds_east_of_utc": "The timezone offset of the appointment in seconds east of UTC", "appointment_timezone_short_name": "The timezone short name of the appointment", "appointment_type_id": "The ID for the appointment type", "appointment_type_title": "The practice-friendly name for this appointment type", "cancel_reason_id": "ID of the reason for cancellation", "cancel_reason_name": "Name of the reason for cancellation", "cancel_reason_no_show": "Whether the cancellation was due to a no-show", "cancel_reason_slot_available": "Whether the slot became available due to cancellation", "cancelled_by": "User who cancelled the appointment", "cancelled_datetime": "Date and time when the appointment was cancelled", "charge_entry_not_required": "Whether charge entry is not required for this appointment", "charge_entry_not_required_reason": "Reason why charge entry is not required", "check_in_datetime": "Date and time when the patient checked in", "check_out_datetime": "Date and time when the patient checked out", "claims": { "billed_provider_id": "ID of the provider who billed the claim", "billed_service_date": "Date when the service was billed", "claim_created_date": "Date and time when the claim was created", "claim_id": "ID of the claim", "custom_fields": { "custom_field_id": "Corresponds to the /customfields customfieldid", "custom_field_value": "For a non-select custom field, the value", "option_id": "For a select custom field, the selectid value (from /customfield's selectlist)" }, "department_id": "ID of the department where the service was billed", "diagnoses": { "deleted_diagnosis": "Whether the diagnosis was deleted", "diagnosis_category": "Category of the diagnosis", "diagnosis_code": "Code for the diagnosis", "diagnosis_codeset": "Codeset for the diagnosis", "diagnosis_description": "Description of the diagnosis", "diagnosis_id": "ID of the diagnosis", "diagnosis_raw_code": "Raw code for the diagnosis" }, "patient_id": "ID of the patient who was billed", "procedures": { "charge_amount": "Amount of the charge", "procedure_category": "Category of the procedure", "procedure_code": "Code for the procedure", "procedure_description": "Description of the procedure", "transaction_id": "ID of the transaction" } }, "coordinator_enterprise": "Whether the coordinator is enterprise", "coordinator_enterprise_yn": "Enterprise coordinator status as Y/N", "copay": "Expected copay for this appointment", "department_id": "The athenaNet department id", "encounter_id": "ID of the encounter associated with the appointment", "encounter_status": "Status of the encounter", "frozen_yn": "If true, this appointment slot is frozen", "insurances": { "eligibility_last_checked": "When eligibility was last checked", "eligibility_reason": "Reason for eligibility status", "eligibility_status": "Status of eligibility", "id": "Insurance ID", "insurance_id": "Insurance identifier", "insurance_id_number": "Insurance ID number", "insurance_package_address1": "Insurance package address - 1st line", "insurance_package_city": "Insurance package city", "insurance_package_id": "Insurance package ID", "insurance_package_state": "Insurance package state (2 letter abbreviation)", "insurance_package_zip": "Insurance package zip code", "insurance_phone": "Insurance phone number", "insurance_plan_display_name": "Insurance plan display name", "insurance_plan_name": "Insurance plan name", "insurance_policy_holder": "Insurance policy holder", "insurance_policy_holder_address1": "Insurance policy holder address - 1st line", "insurance_policy_holder_city": "Insurance policy holder city", "insurance_policy_holder_country_code": "Insurance policy holder country code", "insurance_policy_holder_country_iso3166": "Insurance policy holder country (ISO 3166-1)", "insurance_policy_holder_dob": "Insurance policy holder date of birth", "insurance_policy_holder_first_name": "Insurance policy holder first name", "insurance_policy_holder_last_name": "Insurance policy holder last name", "insurance_policy_holder_sex": "Insurance policy holder sex", "insurance_policy_holder_state": "Insurance policy holder state (2 letter abbreviation)", "insurance_policy_holder_zip": "Insurance policy holder zip code", "insurance_type": "Insurance type", "insured_address": "Insured person's address", "insured_city": "Insured person's city", "insured_country_code": "Insured person's country code", "insured_country_iso3166": "Insured person's country (ISO 3166-1)", "insured_dob": "Insured person's date of birth", "insured_entity_type_id": "Insured entity type ID", "insured_first_name": "Insured person's first name", "insured_last_name": "Insured person's last name", "insured_sex": "Insured person's sex", "insured_state": "Insured person's state (2 letter abbreviation)", "insured_zip": "Insured person's zip code", "irc_name": "IRC name", "relationship_to_insured": "Relationship to insured person", "relationship_to_insured_id": "Relationship to insured person ID", "sequence_number": "Sequence number" }, "last_modified_at": "Date and time when the appointment was last modified", "last_modified_by": "User who last modified the appointment", "patient_appointment_type_name": "The patient-friendly name for this appointment type", "patient_id": "The athenaNet patient ID for this appointment", "patient_location_id": "ID of the patient's location", "referring_provider_id": "The referring provider ID", "reminder_details": { "call_time": "Time of the reminder call", "message_result_id": "ID of the message result", "message_type": "Type of the message", "result": "Result of the reminder" }, "rendering_provider_id": "The rendering provider ID", "rescheduled_appointment_id": "When an appointment is rescheduled, this is the ID of the replacement appointment", "scheduled_by": "User who scheduled the appointment", "scheduled_datetime": "Date and time when the appointment was scheduled", "start_check_in_datetime": "The appointment check in start time", "start_check_out_datetime": "The appointment check out start time", "stop_check_in_datetime": "The appointment check in end time", "stop_exam_datetime": "Date and time when the exam was completed", "stop_intake_datetime": "Date and time when the intake was completed", "stop_sign_off_datetime": "The appointment sign off end time", "suggested_overbooking": "Suggested overbooking status", "supervising_provider_id": "The supervising provider ID", "template_appointment_id": "ID of the template appointment", "template_appointment_type_id": "ID of the template appointment type", "urgent_yn": "Urgent flag for the appointment", "use_expected_procedure_codes": { "procedure_code": "Code for the procedure", "procedure_code_description": "Description of the procedure code" }, "visit_id": "Visit ID of the appointment"}