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