> ## Documentation Index > Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt > Use this file to discover all available pages before exploring further. # Appointment > Event payload details and trigger documentation for Appointment data from Athena images/athena.svg # Events ## Triggering Webhook Types The following event types are associated with the Appointment event payload from Athena. * `Athena Appointment Scheduled` * `Athena Appointment Checked In` * `Athena Appointment Checked Out` * `Athena Appointment Cancelled` * `Athena Appointment Open` * `Athena Appointment Charge Entered` ```json Example theme={null} { "appointment_confirmation_id": "12345", "appointment_confirmation_name": "Appointment Confirmation Name", "appointment_date": "July 12, 2024", "appointment_datetime": "2020-10-25T00:00:00Z", "appointment_day_of_month": "12th", "appointment_day_of_week": "Friday", "appointment_id": "3132", "appointment_length_minutes": 30, "appointment_month": "July", "appointment_notes": "Note 1, Note 2", "appointment_patient_timezone_identifier": "America/New_York", "appointment_provider_id": "1", "appointment_status": "FUTURE", "appointment_time": "10:00AM", "appointment_timezone_offset": "-04:00", "appointment_timezone_offset_seconds_east_of_utc": -14400, "appointment_timezone_short_name": "EDT", "appointment_type_id": "11", "appointment_type_title": "FOLLOW UP 30 - Virtual", "cancel_reason_id": "12345", "cancel_reason_name": "Patient has no insurance", "cancel_reason_no_show": false, "cancel_reason_slot_available": false, "cancelled_by": "jbloggs", "cancelled_datetime": "2020-07-15T15:00:00Z", "charge_entry_not_required": false, "charge_entry_not_required_reason": "Patient has no insurance", "check_in_datetime": "2020-07-15T15:00:00Z", "check_out_datetime": "2020-07-15T16:02:00Z", "claims": [ { "billed_provider_id": 12345, "billed_service_date": "2020-07-15", "claim_created_date": "2020-07-15T13:01:49Z", "claim_id": "CL12345", "custom_fields": [ { "custom_field_id": "CF123", "custom_field_value": "Value for non-select field", "option_id": "OPT456" } ], "department_id": 12345, "diagnoses": [ { "deleted_diagnosis": "DX12345", "diagnosis_category": "Checkup", "diagnosis_code": "DX12345", "diagnosis_codeset": "ICD-10", "diagnosis_description": "Checkup", "diagnosis_id": "DX12345", "diagnosis_raw_code": "DX12345" } ], "patient_id": "12345", "procedures": [ { "charge_amount": "100.00", "procedure_category": "Checkup", "procedure_code": "PC12345", "procedure_description": "Checkup", "transaction_id": "TX12345" } ] } ], "coordinator_enterprise": false, "coordinator_enterprise_yn": null, "copay": "25.00", "department_id": "1", "encounter_id": "12345", "encounter_status": "Open", "frozen_yn": "true", "insurances": [ { "eligibility_last_checked": "2023-05-01T14:30:00Z", "eligibility_reason": "Active coverage", "eligibility_status": "ELIGIBLE", "id": "123", "insurance_id": "INS456", "insurance_id_number": "ABC123456789", "insurance_package_address1": "123 Insurance St", "insurance_package_city": "Boston", "insurance_package_id": 789, "insurance_package_state": "MA", "insurance_package_zip": "02108", "insurance_phone": "+15551234567", "insurance_plan_display_name": "Blue Cross Blue Shield PPO", "insurance_plan_name": "PPO", "insurance_policy_holder": "John Smith", "insurance_policy_holder_address1": "123 Main St", "insurance_policy_holder_city": "Boston", "insurance_policy_holder_country_code": "US", "insurance_policy_holder_country_iso3166": "USA", "insurance_policy_holder_dob": "1980-01-15", "insurance_policy_holder_first_name": "John", "insurance_policy_holder_last_name": "Smith", "insurance_policy_holder_sex": "M", "insurance_policy_holder_state": "MA", "insurance_policy_holder_zip": "02108", "insurance_type": "Commercial", "insured_address": "123 Main St", "insured_city": "Boston", "insured_country_code": "US", "insured_country_iso3166": "USA", "insured_dob": "1980-01-15", "insured_entity_type_id": 1, "insured_first_name": "John", "insured_last_name": "Smith", "insured_sex": "M", "insured_state": "MA", "insured_zip": "02108", "irc_name": "IRC123", "relationship_to_insured": "SELF", "relationship_to_insured_id": 1, "sequence_number": 1 } ], "last_modified_at": "2020-07-15T13:01:49Z", "last_modified_by": "fterragna", "patient_appointment_type_name": "FOLLOW UP 30 - Virtual", "patient_id": "1", "patient_location_id": "1", "referring_provider_id": "RFP12345", "reminder_details": [ { "call_time": "09:00", "message_result_id": "MSG12345", "message_type": "SMS", "result": "DELIVERED" } ], "rendering_provider_id": "RNP12345", "rescheduled_appointment_id": "APT98765", "scheduled_by": "fterragna", "scheduled_datetime": "2020-07-15T13:01:49Z", "start_check_in_datetime": "2020-07-15T15:00:00Z", "start_check_out_datetime": "2020-07-15T16:02:00Z", "stop_check_in_datetime": "2020-07-15T15:10:00Z", "stop_exam_datetime": "2020-07-15T15:10:00Z", "stop_intake_datetime": "2020-07-15T15:10:00Z", "stop_sign_off_datetime": "2020-07-15T15:10:00Z", "suggested_overbooking": null, "supervising_provider_id": "SPP12345", "template_appointment_id": "3132", "template_appointment_type_id": "11", "urgent_yn": "true", "use_expected_procedure_codes": [ { "procedure_code": "PROC12345", "procedure_code_description": "Checkup" } ], "visit_id": "V12345" } ``` ```json Description theme={null} { "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" } ``` ### Payload Field Details Appointment ID of the booked appointment ```json CEL theme={null} appointment_id ``` ```json Example theme={null} "3132" ``` Notes associated with the appointment ```json CEL theme={null} appointment_notes ``` ```json Example theme={null} "Note 1, Note 2" ``` Mapped array of: ID of the note ```json CEL theme={null} appointment_notes.map(x, x.note_id) ``` ```json Example theme={null} [ "1103" ] ``` Mapped array of: Text content of the note ```json CEL theme={null} appointment_notes.map(x, x.note_text) ``` ```json Example theme={null} [ "https://zoom.us/j/96387053799?pwd=aEZma0hnVS82b2c5aldDbVgxanlMZz09" ] ``` Mapped array of: When the note was created ```json CEL theme={null} appointment_notes.map(x, x.created_at) ``` ```json Example theme={null} [ "2020-07-15T13:01:49Z" ] ``` Mapped array of: Who created the note ```json CEL theme={null} appointment_notes.map(x, x.created_by) ``` ```json Example theme={null} [ "Dr. Joseph Lister" ] ``` Mapped array of: Whether to display the note on the schedule ```json CEL theme={null} appointment_notes.map(x, x.display_on_schedule) ``` ```json Example theme={null} [ false ] ``` Mapped array of: Text content of the note ```json CEL theme={null} appointment_notes.map(x, x.text) ``` ```json Example theme={null} [ "https://zoom.us/j/96387053799?pwd=aEZma0hnVS82b2c5aldDbVgxanlMZz09" ] ``` Mapped array of: ID of the note ```json CEL theme={null} appointment_notes.map(x, x.id) ``` ```json Example theme={null} [ 1103 ] ``` ID of the appointment confirmation ```json CEL theme={null} appointment_confirmation_id ``` ```json Example theme={null} "12345" ``` Name of the appointment confirmation ```json CEL theme={null} appointment_confirmation_name ``` ```json Example theme={null} "Appointment Confirmation Name" ``` The athenaNet appointment status. x=cancelled f=future o=open 2=checked in 3=checked out 4=charge entered ```json CEL theme={null} appointment_status ``` ```json Example theme={null} athena.v1.AppointmentStatus.APPOINTMENT_STATUS_SCHEDULED athena.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_IN athena.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_OUT athena.v1.AppointmentStatus.APPOINTMENT_STATUS_CANCELLED athena.v1.AppointmentStatus.APPOINTMENT_STATUS_OPEN athena.v1.AppointmentStatus.APPOINTMENT_STATUS_CHARGE_ENTERED ``` The practice-friendly name for this appointment type ```json CEL theme={null} appointment_type_title ``` ```json Example theme={null} "FOLLOW UP 30 - Virtual" ``` The ID for the appointment type ```json CEL theme={null} appointment_type_id ``` ```json Example theme={null} "11" ``` User who cancelled the appointment ```json CEL theme={null} cancelled_by ``` ```json Example theme={null} "jbloggs" ``` Date and time when the appointment was cancelled ```json CEL theme={null} cancelled_datetime ``` ```json Example theme={null} "2020-07-15T15:00:00Z" ``` ID of the reason for cancellation ```json CEL theme={null} cancel_reason_id ``` ```json Example theme={null} "12345" ``` Name of the reason for cancellation ```json CEL theme={null} cancel_reason_name ``` ```json Example theme={null} "Patient has no insurance" ``` Whether the cancellation was due to a no-show ```json CEL theme={null} cancel_reason_no_show ``` ```json Example theme={null} false ``` Whether the slot became available due to cancellation ```json CEL theme={null} cancel_reason_slot_available ``` ```json Example theme={null} false ``` Whether charge entry is not required for this appointment ```json CEL theme={null} charge_entry_not_required ``` ```json Example theme={null} false ``` Reason why charge entry is not required ```json CEL theme={null} charge_entry_not_required_reason ``` ```json Example theme={null} "Patient has no insurance" ``` Date and time when the patient checked in ```json CEL theme={null} check_in_datetime ``` ```json Example theme={null} "2020-07-15T15:00:00Z" ``` Date and time when the patient checked out ```json CEL theme={null} check_out_datetime ``` ```json Example theme={null} "2020-07-15T16:02:00Z" ``` As detailed in /claims, if requested ```json CEL theme={null} claims ``` ```json Example theme={null} [ { "billed_provider_id": 12345, "billed_service_date": "2020-07-15", "claim_created_date": "2020-07-15T13:01:49Z", "claim_id": "CL12345", "custom_fields": [ { "custom_field_id": "CF123", "custom_field_value": "Value for non-select field", "option_id": "OPT456" } ], "department_id": 12345, "diagnoses": [ { "deleted_diagnosis": "DX12345", "diagnosis_category": "Checkup", "diagnosis_code": "DX12345", "diagnosis_codeset": "ICD-10", "diagnosis_description": "Checkup", "diagnosis_id": "DX12345", "diagnosis_raw_code": "DX12345" } ], "patient_id": "12345", "procedures": [ { "charge_amount": "100.00", "procedure_category": "Checkup", "procedure_code": "PC12345", "procedure_description": "Checkup", "transaction_id": "TX12345" } ] } ] ``` Mapped array of: ID of the claim ```json CEL theme={null} claims.map(x, x.claim_id) ``` ```json Example theme={null} [ "CL12345" ] ``` Mapped array of: Date and time when the claim was created ```json CEL theme={null} claims.map(x, x.claim_created_date) ``` ```json Example theme={null} [ "2020-07-15T13:01:49Z" ] ``` Mapped array of: ID of the provider who billed the claim ```json CEL theme={null} claims.map(x, x.billed_provider_id) ``` ```json Example theme={null} [ 12345 ] ``` Mapped array of: Date when the service was billed ```json CEL theme={null} claims.map(x, x.billed_service_date) ``` ```json Example theme={null} [ "2020-07-15" ] ``` Mapped array of: ID of the department where the service was billed ```json CEL theme={null} claims.map(x, x.department_id) ``` ```json Example theme={null} [ 12345 ] ``` Mapped array of: Procedures associated with the claim ```json CEL theme={null} claims.map(x, x.procedures) ``` ```json Example theme={null} [ [ { "charge_amount": "100.00", "procedure_category": "Checkup", "procedure_code": "PC12345", "procedure_description": "Checkup", "transaction_id": "TX12345" } ] ] ``` Mapped array of: Diagnoses associated with the claim ```json CEL theme={null} claims.map(x, x.diagnoses) ``` ```json Example theme={null} [ [ { "deleted_diagnosis": "DX12345", "diagnosis_category": "Checkup", "diagnosis_code": "DX12345", "diagnosis_codeset": "ICD-10", "diagnosis_description": "Checkup", "diagnosis_id": "DX12345", "diagnosis_raw_code": "DX12345" } ] ] ``` Mapped array of: ID of the patient who was billed ```json CEL theme={null} claims.map(x, x.patient_id) ``` ```json Example theme={null} [ "12345" ] ``` Mapped array of: Custom fields associated with the claim ```json CEL theme={null} claims.map(x, x.custom_fields) ``` ```json Example theme={null} [ [ { "custom_field_id": "CF123", "custom_field_value": "Value for non-select field", "option_id": "OPT456" } ] ] ``` Whether the coordinator is enterprise ```json CEL theme={null} coordinator_enterprise ``` ```json Example theme={null} false ``` Enterprise coordinator status as Y/N ```json CEL theme={null} coordinator_enterprise_yn ``` ```json Example theme={null} null ``` Expected copay for this appointment ```json CEL theme={null} copay ``` ```json Example theme={null} "25.00" ``` The appointment date and time ```json CEL theme={null} appointment_datetime ``` ```json Example theme={null} "2020-10-25T00:00:00Z" ``` The athenaNet department id ```json CEL theme={null} department_id ``` ```json Example theme={null} "1" ``` Duration of the appointment in minutes ```json CEL theme={null} appointment_length_minutes ``` ```json Example theme={null} 30 ``` ID of the encounter associated with the appointment ```json CEL theme={null} encounter_id ``` ```json Example theme={null} "12345" ``` Status of the encounter ```json CEL theme={null} encounter_status ``` ```json Example theme={null} "Open" ``` If true, this appointment slot is frozen ```json CEL theme={null} frozen_yn ``` ```json Example theme={null} "true" ``` Insurance information for the appointment ```json CEL theme={null} insurances ``` ```json Example theme={null} [ { "eligibility_last_checked": "2023-05-01T14:30:00Z", "eligibility_reason": "Active coverage", "eligibility_status": "ELIGIBLE", "id": "123", "insurance_id": "INS456", "insurance_id_number": "ABC123456789", "insurance_package_address1": "123 Insurance St", "insurance_package_city": "Boston", "insurance_package_id": 789, "insurance_package_state": "MA", "insurance_package_zip": "02108", "insurance_phone": "+15551234567", "insurance_plan_display_name": "Blue Cross Blue Shield PPO", "insurance_plan_name": "PPO", "insurance_policy_holder": "John Smith", "insurance_policy_holder_address1": "123 Main St", "insurance_policy_holder_city": "Boston", "insurance_policy_holder_country_code": "US", "insurance_policy_holder_country_iso3166": "USA", "insurance_policy_holder_dob": "1980-01-15", "insurance_policy_holder_first_name": "John", "insurance_policy_holder_last_name": "Smith", "insurance_policy_holder_sex": "M", "insurance_policy_holder_state": "MA", "insurance_policy_holder_zip": "02108", "insurance_type": "Commercial", "insured_address": "123 Main St", "insured_city": "Boston", "insured_country_code": "US", "insured_country_iso3166": "USA", "insured_dob": "1980-01-15", "insured_entity_type_id": 1, "insured_first_name": "John", "insured_last_name": "Smith", "insured_sex": "M", "insured_state": "MA", "insured_zip": "02108", "irc_name": "IRC123", "relationship_to_insured": "SELF", "relationship_to_insured_id": 1, "sequence_number": 1 } ] ``` Mapped array of: Insurance ID ```json CEL theme={null} insurances.map(x, x.id) ``` ```json Example theme={null} [ "123" ] ``` Mapped array of: Insurance identifier ```json CEL theme={null} insurances.map(x, x.insurance_id) ``` ```json Example theme={null} [ "INS456" ] ``` `PII` Mapped array of: Insurance ID number ```json CEL theme={null} insurances.map(x, x.insurance_id_number) ``` ```json Example theme={null} [ "ABC123456789" ] ``` Mapped array of: Insurance package address - 1st line ```json CEL theme={null} insurances.map(x, x.insurance_package_address1) ``` ```json Example theme={null} [ "123 Insurance St" ] ``` Mapped array of: Insurance package city ```json CEL theme={null} insurances.map(x, x.insurance_package_city) ``` ```json Example theme={null} [ "Boston" ] ``` Mapped array of: Insurance package ID ```json CEL theme={null} insurances.map(x, x.insurance_package_id) ``` ```json Example theme={null} [ 789 ] ``` Mapped array of: Insurance package state (2 letter abbreviation) ```json CEL theme={null} insurances.map(x, x.insurance_package_state) ``` ```json Example theme={null} [ "MA" ] ``` Mapped array of: Insurance package zip code ```json CEL theme={null} insurances.map(x, x.insurance_package_zip) ``` ```json Example theme={null} [ "02108" ] ``` Mapped array of: Insurance phone number ```json CEL theme={null} insurances.map(x, x.insurance_phone) ``` ```json Example theme={null} [ "+15551234567" ] ``` Mapped array of: Insurance plan display name ```json CEL theme={null} insurances.map(x, x.insurance_plan_display_name) ``` ```json Example theme={null} [ "Blue Cross Blue Shield PPO" ] ``` Mapped array of: Insurance plan name ```json CEL theme={null} insurances.map(x, x.insurance_plan_name) ``` ```json Example theme={null} [ "PPO" ] ``` `PII` Mapped array of: Insurance policy holder ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder) ``` ```json Example theme={null} [ "John Smith" ] ``` `PII` Mapped array of: Insurance policy holder address - 1st line ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_address1) ``` ```json Example theme={null} [ "123 Main St" ] ``` `PII` Mapped array of: Insurance policy holder city ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_city) ``` ```json Example theme={null} [ "Boston" ] ``` Mapped array of: Insurance policy holder country code ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_country_code) ``` ```json Example theme={null} [ "US" ] ``` Mapped array of: Insurance policy holder country (ISO 3166-1) ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_country_iso3166) ``` ```json Example theme={null} [ "USA" ] ``` `PII` Mapped array of: Insurance policy holder date of birth ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_dob) ``` ```json Example theme={null} [ "1980-01-15" ] ``` `PII` Mapped array of: Insurance policy holder first name ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_first_name) ``` ```json Example theme={null} [ "John" ] ``` `PII` Mapped array of: Insurance policy holder last name ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_last_name) ``` ```json Example theme={null} [ "Smith" ] ``` `PII` Mapped array of: Insurance policy holder sex ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_sex) ``` ```json Example theme={null} [ "M" ] ``` Mapped array of: Insurance policy holder state (2 letter abbreviation) ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_state) ``` ```json Example theme={null} [ "MA" ] ``` `PII` Mapped array of: Insurance policy holder zip code ```json CEL theme={null} insurances.map(x, x.insurance_policy_holder_zip) ``` ```json Example theme={null} [ "02108" ] ``` Mapped array of: Insurance type ```json CEL theme={null} insurances.map(x, x.insurance_type) ``` ```json Example theme={null} [ "Commercial" ] ``` `PII` Mapped array of: Insured person's address ```json CEL theme={null} insurances.map(x, x.insured_address) ``` ```json Example theme={null} [ "123 Main St" ] ``` `PII` Mapped array of: Insured person's city ```json CEL theme={null} insurances.map(x, x.insured_city) ``` ```json Example theme={null} [ "Boston" ] ``` Mapped array of: Insured person's country code ```json CEL theme={null} insurances.map(x, x.insured_country_code) ``` ```json Example theme={null} [ "US" ] ``` Mapped array of: Insured person's country (ISO 3166-1) ```json CEL theme={null} insurances.map(x, x.insured_country_iso3166) ``` ```json Example theme={null} [ "USA" ] ``` `PII` Mapped array of: Insured person's date of birth ```json CEL theme={null} insurances.map(x, x.insured_dob) ``` ```json Example theme={null} [ "1980-01-15" ] ``` Mapped array of: Insured entity type ID ```json CEL theme={null} insurances.map(x, x.insured_entity_type_id) ``` ```json Example theme={null} [ 1 ] ``` `PII` Mapped array of: Insured person's first name ```json CEL theme={null} insurances.map(x, x.insured_first_name) ``` ```json Example theme={null} [ "John" ] ``` `PII` Mapped array of: Insured person's last name ```json CEL theme={null} insurances.map(x, x.insured_last_name) ``` ```json Example theme={null} [ "Smith" ] ``` `PII` Mapped array of: Insured person's sex ```json CEL theme={null} insurances.map(x, x.insured_sex) ``` ```json Example theme={null} [ "M" ] ``` Mapped array of: Insured person's state (2 letter abbreviation) ```json CEL theme={null} insurances.map(x, x.insured_state) ``` ```json Example theme={null} [ "MA" ] ``` `PII` Mapped array of: Insured person's zip code ```json CEL theme={null} insurances.map(x, x.insured_zip) ``` ```json Example theme={null} [ "02108" ] ``` Mapped array of: IRC name ```json CEL theme={null} insurances.map(x, x.irc_name) ``` ```json Example theme={null} [ "IRC123" ] ``` Mapped array of: Relationship to insured person ```json CEL theme={null} insurances.map(x, x.relationship_to_insured) ``` ```json Example theme={null} [ "SELF" ] ``` Mapped array of: Relationship to insured person ID ```json CEL theme={null} insurances.map(x, x.relationship_to_insured_id) ``` ```json Example theme={null} [ 1 ] ``` Mapped array of: Sequence number ```json CEL theme={null} insurances.map(x, x.sequence_number) ``` ```json Example theme={null} [ 1 ] ``` Mapped array of: When eligibility was last checked ```json CEL theme={null} insurances.map(x, x.eligibility_last_checked) ``` ```json Example theme={null} [ "2023-05-01T14:30:00Z" ] ``` Mapped array of: Reason for eligibility status ```json CEL theme={null} insurances.map(x, x.eligibility_reason) ``` ```json Example theme={null} [ "Active coverage" ] ``` Mapped array of: Status of eligibility ```json CEL theme={null} insurances.map(x, x.eligibility_status) ``` ```json Example theme={null} [ "ELIGIBLE" ] ``` Date and time when the appointment was last modified ```json CEL theme={null} last_modified_at ``` ```json Example theme={null} "2020-07-15T13:01:49Z" ``` User who last modified the appointment ```json CEL theme={null} last_modified_by ``` ```json Example theme={null} "fterragna" ``` The patient-friendly name for this appointment type ```json CEL theme={null} patient_appointment_type_name ``` ```json Example theme={null} "FOLLOW UP 30 - Virtual" ``` The athenaNet patient ID for this appointment ```json CEL theme={null} patient_id ``` ```json Example theme={null} "1" ``` ID of the patient's location ```json CEL theme={null} patient_location_id ``` ```json Example theme={null} "1" ``` The athenaNet provider ID ```json CEL theme={null} appointment_provider_id ``` ```json Example theme={null} "1" ``` The referring provider ID ```json CEL theme={null} referring_provider_id ``` ```json Example theme={null} "RFP12345" ``` Details about appointment reminders ```json CEL theme={null} reminder_details ``` ```json Example theme={null} [ { "call_time": "09:00", "message_result_id": "MSG12345", "message_type": "SMS", "result": "DELIVERED" } ] ``` Mapped array of: Time of the reminder call ```json CEL theme={null} reminder_details.map(x, x.call_time) ``` ```json Example theme={null} [ "09:00" ] ``` Mapped array of: ID of the message result ```json CEL theme={null} reminder_details.map(x, x.message_result_id) ``` ```json Example theme={null} [ "MSG12345" ] ``` Mapped array of: Type of the message ```json CEL theme={null} reminder_details.map(x, x.message_type) ``` ```json Example theme={null} [ "SMS" ] ``` Mapped array of: Result of the reminder ```json CEL theme={null} reminder_details.map(x, x.result) ``` ```json Example theme={null} [ "DELIVERED" ] ``` The rendering provider ID ```json CEL theme={null} rendering_provider_id ``` ```json Example theme={null} "RNP12345" ``` When an appointment is rescheduled, this is the ID of the replacement appointment ```json CEL theme={null} rescheduled_appointment_id ``` ```json Example theme={null} "APT98765" ``` User who scheduled the appointment ```json CEL theme={null} scheduled_by ``` ```json Example theme={null} "fterragna" ``` Date and time when the appointment was scheduled ```json CEL theme={null} scheduled_datetime ``` ```json Example theme={null} "2020-07-15T13:01:49Z" ``` The appointment check in start time ```json CEL theme={null} start_check_in_datetime ``` ```json Example theme={null} "2020-07-15T15:00:00Z" ``` The appointment check out start time ```json CEL theme={null} start_check_out_datetime ``` ```json Example theme={null} "2020-07-15T16:02:00Z" ``` The appointment check in end time ```json CEL theme={null} stop_check_in_datetime ``` ```json Example theme={null} "2020-07-15T15:10:00Z" ``` Date and time when the exam was completed ```json CEL theme={null} stop_exam_datetime ``` ```json Example theme={null} "2020-07-15T15:10:00Z" ``` Date and time when the intake was completed ```json CEL theme={null} stop_intake_datetime ``` ```json Example theme={null} "2020-07-15T15:10:00Z" ``` The appointment sign off end time ```json CEL theme={null} stop_sign_off_datetime ``` ```json Example theme={null} "2020-07-15T15:10:00Z" ``` Suggested overbooking status ```json CEL theme={null} suggested_overbooking ``` ```json Example theme={null} null ``` The supervising provider ID ```json CEL theme={null} supervising_provider_id ``` ```json Example theme={null} "SPP12345" ``` ID of the template appointment ```json CEL theme={null} template_appointment_id ``` ```json Example theme={null} "3132" ``` ID of the template appointment type ```json CEL theme={null} template_appointment_type_id ``` ```json Example theme={null} "11" ``` Urgent flag for the appointment ```json CEL theme={null} urgent_yn ``` ```json Example theme={null} "true" ``` An array of expected procedure codes attached to this appointment ```json CEL theme={null} use_expected_procedure_codes ``` ```json Example theme={null} [ { "procedure_code": "PROC12345", "procedure_code_description": "Checkup" } ] ``` Mapped array of: Code for the procedure ```json CEL theme={null} use_expected_procedure_codes.map(x, x.procedure_code) ``` ```json Example theme={null} [ "PROC12345" ] ``` Mapped array of: Description of the procedure code ```json CEL theme={null} use_expected_procedure_codes.map(x, x.procedure_code_description) ``` ```json Example theme={null} [ "Checkup" ] ``` Visit ID of the appointment ```json CEL theme={null} visit_id ``` ```json Example theme={null} "V12345" ``` The timezone short name of the appointment ```json CEL theme={null} appointment_timezone_short_name ``` ```json Example theme={null} "EDT" ``` The timezone offset of the appointment ```json CEL theme={null} appointment_timezone_offset ``` ```json Example theme={null} "-04:00" ``` The timezone offset of the appointment in seconds east of UTC ```json CEL theme={null} appointment_timezone_offset_seconds_east_of_utc ``` ```json Example theme={null} -14400 ``` The timezone name of the appointment ```json CEL theme={null} appointment_patient_timezone_identifier ``` ```json Example theme={null} "America/New_York" ``` Day of the week of the Appointment ```json CEL theme={null} appointment_day_of_week ``` ```json Example theme={null} "Friday" ``` Day (ordinal) of the month of the Appointment ```json CEL theme={null} appointment_day_of_month ``` ```json Example theme={null} "12th" ``` Month of the Appointment ```json CEL theme={null} appointment_month ``` ```json Example theme={null} "July" ``` Month of the Appointment ```json CEL theme={null} appointment_date ``` ```json Example theme={null} "July 12, 2024" ``` Time of the Appointment (in the Appointment's registered timezone) ```json CEL theme={null} appointment_time ``` ```json Example theme={null} "10:00AM" ```