Appointment Slot

The Appointment slot APIs allows users to view and manage the appointment slots. These practice facing admin APIs allows you to perform the following actions:

  1. Create a new Appointment slot (for patients to book their appointments against)
  2. Freeze an existing Appointment slot (to ensure patients cannot book this slot)
  3. View all Appointment slots (using filters such as booked, un-booked)
  4. View all Appointment slots across all departments and providers
  5. Delete an existing Appointment slot (to ensure patients do not book against this slot)
  6. Cancel an existing patient Appointment in an Appointment Slot.

Two flags allow you to bypass the permissions set up around Web scheduling:

  • ignoreschedulablepermission
  • bypassscheduletimechecks

The open appointment slots functionality, designed for a patient scheduling an appointment online, looks, by default, for appointment reasons and obeys the practice's configuration around those reasons. (This configuration is generally done as part of the athenaCommunicator setup.) In cases where scheduling is done for other reasons (e.g., telemedicine, walk-in appointments via Digital Check-in, or other use cases), you may want to book by appointment type and to ignore the setup that was done controlling what appointments can be booked.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Get list of booked appointment slots

GET
/v1/{practiceid}/appointments/booked
Retrieves a list of booked appointments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
scheduledstartdate string Start of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
startdate string Start of the appointment search date range (mm/dd/yyyy). Inclusive.
showinsurance boolean Include patient insurance information. Shows insurance packages for the appointment if any are selected, and all patient packages otherwise.
showexpectedprocedurecodes boolean Show the expetcted procedurecodes.
ignorerestrictions boolean When showing patient detail for appointments, the patient information for patients with record restrictions and blocked patients will not be shown. Setting this flag to true will show that information for those patients.
appointmenttypeid integer Filter by appointment type ID.
endlastmodified string Identify appointments modified prior to this date/time (mm/dd/yyyy hh:mi:ss). Inclusive. Note: This can only be used if a startlastmodified value is supplied as well.
enddate string End of the appointment search date range (mm/dd/yyyy). Inclusive.
providerid array The athenaNet provider ID. Multiple IDs (either as a comma delimited list or multiple POSTed values) are allowed.
departmentid integer The athenaNet department ID.
showclaimdetail boolean Include claim information, if available, associated with an appointment.
appointmentstatus string Filter appointments by status.
startlastmodified string Identify appointments modified after this date/time (mm/dd/yyyy hh:mi:ss). Inclusive.
patientid integer The athenaNet patient ID. If operating in a Provider Group Enterprise practice, this should be the enterprise patient ID.
showcopay boolean By default, the expected co-pay is returned. For performance purposes, you can set this to false and copay will not be populated.
showpatientdetail boolean Include patient information for each patient associated with an appointment.
showcancelled boolean Include appointments that have been cancelled.
showremindercalldetail boolean Include all remindercall related results, if available, associated with an appointment.
scheduledenddate string End of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentconfirmationid string If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname string If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay string Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid string Appointment ID of the booked appointment
appointmentnotes array An array of appointment notes for this appointment.
appointmentstatus string The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype string The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid string This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby string If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid string If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname string If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow string If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable string If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired string This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason string This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims array As detailed in /claims, if requested.
coordinatorenterpriseyn string If true, the appointment was booked through athenaCoordinator Enterprise.
copay string Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date string The appointment date.
departmentid string
duration integer In minutes
encounterid string The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate string The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus string The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
frozenyn string If true, this appointment slot is frozen
hl7providerid integer This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances array List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
lastmodified string The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby string The user who last modified the appointment.
patient string See /patients for details
patientappointmenttypename string The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid string The athenaNet patient ID for this appointment
patientlocationid string The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid string
reasonid string A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid integer The referring provider ID.
reminderdetails array Detailed ReminderCall information made for this appointment.
renderingproviderid integer The rendering provider ID.
rescheduledappointmentid string When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby string The username who scheduled the appointment.
scheduleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin string The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime string As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin string The timestamp when the check-in process was finished for this appointment.
stopexamdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime string The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking string High risk score for Smart Scheduling
supervisingproviderid integer The supervising provider ID.
templateappointmentid string The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid string The original appointment type for this slot. This can change for generic appointments.
urgentyn string Urgent flag for the appointment.
useexpectedprocedurecodes array An array of expected procedure codes attached to this appointment.
Example Code

Get list of booked appointment slots for multiple departments and providers

GET
/v1/{practiceid}/appointments/booked/multipledepartment
Retrieves a list of booked appointments across multiple providers and departments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
scheduledstartdate string Start of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
startdate string Start of the appointment search date range (mm/dd/yyyy). Inclusive.
showinsurance boolean Include patient insurance information. Shows insurance packages for the appointment if any are selected, and all patient packages otherwise.
showexpectedprocedurecodes boolean Show the expetcted procedurecodes.
ignorerestrictions boolean When showing patient detail for appointments, the patient information for patients with record restrictions and blocked patients will not be shown. Setting this flag to true will show that information for those patients.
appointmenttypeid integer Filter by appointment type ID.
endlastmodified string Identify appointments modified prior to this date/time (mm/dd/yyyy hh:mi:ss). Inclusive. Note: This can only be used if a startlastmodified value is supplied as well.
enddate string End of the appointment search date range (mm/dd/yyyy). Inclusive.
providerid array The athenaNet provider ID. Multiple IDs (either as a comma delimited list or multiple POSTed values) are allowed.
departmentid array The athenaNet department ID. Multiple IDs (either as a comma delimited list or multiple POSTed values) are allowed.
showclaimdetail boolean Include claim information, if available, associated with an appointment.
appointmentstatus string Filter appointments by status.
startlastmodified string Identify appointments modified after this date/time (mm/dd/yyyy hh:mi:ss). Inclusive.
patientid integer The athenaNet patient ID. If operating in a Provider Group Enterprise practice, this should be the enterprise patient ID.
showcopay boolean By default, the expected co-pay is returned. For performance purposes, you can set this to false and copay will not be populated.
showpatientdetail boolean Include patient information for each patient associated with an appointment.
showcancelled boolean Include appointments that have been cancelled.
showremindercalldetail boolean Include all remindercall related results, if available, associated with an appointment.
scheduledenddate string End of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentconfirmationid string If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname string If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay string Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid string Appointment ID of the booked appointment
appointmentnotes array An array of appointment notes for this appointment.
appointmentstatus string The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype string The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid string This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby string If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid string If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname string If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow string If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable string If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired string This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason string This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims array As detailed in /claims, if requested.
coordinatorenterpriseyn string If true, the appointment was booked through athenaCoordinator Enterprise.
copay string Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date string The appointment date.
departmentid string
duration integer In minutes
encounterid string The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate string The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus string The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
frozenyn string If true, this appointment slot is frozen
hl7providerid integer This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances array List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
lastmodified string The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby string The user who last modified the appointment.
patient string See /patients for details
patientappointmenttypename string The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid string The athenaNet patient ID for this appointment
patientlocationid string The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid string
reasonid string A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid integer The referring provider ID.
reminderdetails array Detailed ReminderCall information made for this appointment.
renderingproviderid integer The rendering provider ID.
rescheduledappointmentid string When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby string The username who scheduled the appointment.
scheduleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin string The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime string As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin string The timestamp when the check-in process was finished for this appointment.
stopexamdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime string The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking string High risk score for Smart Scheduling
supervisingproviderid integer The supervising provider ID.
templateappointmentid string The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid string The original appointment type for this slot. This can change for generic appointments.
urgentyn string Urgent flag for the appointment.
useexpectedprocedurecodes array An array of expected procedure codes attached to this appointment.
Example Code

Freeze appointment slot

PUT
/v1/{practiceid}/appointments/{appointmentid}/freeze
Freezes an appointment slot so that patients can no longer schedule an appointment in that slot. Once frozen, the time slot will not be listed for booking an appointment.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
appointmentid integer appointmentid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If success is not true, this will detail the error that occurred.
success string Returns true if the call to freeze/unfreeze appointment was successful.
Example Code

Create a new appointment slot

POST
/v1/{practiceid}/appointments/open
Provides the ability to add new open appointment slots
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
appointmentids object An hash of appointment IDs to the time requested.
Example Code

Get list of open appointment slots

GET
/v1/{practiceid}/appointments/open
Retrieves access to open appointment slots
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
appointmenttypeid integer Normally, an appointment reason ID should be used which will map to the correct underlying appointment type in athenaNet. This field will ignore the practice's existing setup for what should be scheduled. Please consult with athenahealth before using. Either an appointmenttypeid or a reasonid must be specified or no results will be returned.
reasonid array The athenaNet patient appointment reason ID, from GET /patientappointmentreasons. While this is not technically required due to some unusual use cases, it is highly recommended for most calls. We do allow a special value of -1 for the reasonid. This reasonid will return open, web-schedulable slots regardless of reason. However, slots returned using a search of -1 may return slots that are not bookable by any reason ID (they may be bookable by specific appointment type IDs instead). This argument allows multiple valid reason IDs to be specified (e.g. reasonid=1,2,3), so if you are looking for slots that match "any" reason, it is recommended that you enumerate the set of reasons you are looking for. Either a reasonid or an appointmenttypeid must be specified or no results will be returned. If a reasonid other than -1 is specified then a providerid must also be specified.
bypassscheduletimechecks boolean Bypass checks that usually require returned appointments to be some amount of hours in the future (as configured by the practice, defaulting to 24 hours), and also ignores the setting that only shows appointments for a certain number of days in the future (also configurable by the practice, defaulting to 90 days).
enddate string End of the appointment search date range (mm/dd/yyyy). Inclusive. Defaults to seven days from startdate.
departmentid array The athenaNet department ID.
providerid array The athenaNet provider ID. Required if a reasonid other than -1 is specified.
startdate string Start of the appointment search date range (mm/dd/yyyy). Inclusive. Defaults to today.
ignoreschedulablepermission boolean By default, we show only appointments that are are available to scheduled via the API. This flag allows you to bypass that restriction for viewing available appointments (but you still may not be able to schedule based on this permission!). This flag does not, however, show the full schedule (that is, appointments that are already booked).
showfrozenslots boolean By default, we hide appointments that are frozen from being returned via the API. This flag allows you to show frozen slots in the set of results returned.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentid integer This is the ID of the appointment to use when booking. To be clear about the behind-the-scenes functionality, this is technically the first ID that will be used. Because of the ability to combine multiple "generic" slots into a single appointment, this may be first ID used. This is important only if trying to reconcile this against a practice's schedule template.
appointmenttype string The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid integer This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
date string The appointment date.
departmentid integer The athenaNet department ID for the appointment
duration integer In minutes
frozenyn string If true, this appointment slot is frozen
localproviderid integer The local athenaNet ID for the provider of the appointment.
patientappointmenttypename string The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
providerid integer The athenaNet ID for the provider of the appointment.
reasonid integer A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
renderingproviderid integer The rendering provider ID.
starttime string As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
validappointmenttypeids integer A list of Appointment Type IDs that are valid to be booked in this slot. This will only be included if "New Schedule Admin" is enabled for the practice.
Example Code

Get list of booked appointment slots for multiple departments and providers

GET
/v1/{practiceid}/appointments/booked/multipledepartment
Retrieves a list of booked appointments across multiple providers and departments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
scheduledstartdate string Start of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
startdate string Start of the appointment search date range (mm/dd/yyyy). Inclusive.
showinsurance boolean Include patient insurance information. Shows insurance packages for the appointment if any are selected, and all patient packages otherwise.
showexpectedprocedurecodes boolean Show the expetcted procedurecodes.
ignorerestrictions boolean When showing patient detail for appointments, the patient information for patients with record restrictions and blocked patients will not be shown. Setting this flag to true will show that information for those patients.
appointmenttypeid integer Filter by appointment type ID.
endlastmodified string Identify appointments modified prior to this date/time (mm/dd/yyyy hh:mi:ss). Inclusive. Note: This can only be used if a startlastmodified value is supplied as well.
enddate string End of the appointment search date range (mm/dd/yyyy). Inclusive.
providerid array The athenaNet provider ID. Multiple IDs (either as a comma delimited list or multiple POSTed values) are allowed.
departmentid array The athenaNet department ID. Multiple IDs (either as a comma delimited list or multiple POSTed values) are allowed.
showclaimdetail boolean Include claim information, if available, associated with an appointment.
appointmentstatus string Filter appointments by status.
startlastmodified string Identify appointments modified after this date/time (mm/dd/yyyy hh:mi:ss). Inclusive.
patientid integer The athenaNet patient ID. If operating in a Provider Group Enterprise practice, this should be the enterprise patient ID.
showcopay boolean By default, the expected co-pay is returned. For performance purposes, you can set this to false and copay will not be populated.
showpatientdetail boolean Include patient information for each patient associated with an appointment.
showcancelled boolean Include appointments that have been cancelled.
showremindercalldetail boolean Include all remindercall related results, if available, associated with an appointment.
scheduledenddate string End of the appointment scheduled search date range (mm/dd/yyyy). Inclusive.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentconfirmationid string If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname string If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay string Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid string Appointment ID of the booked appointment
appointmentnotes array An array of appointment notes for this appointment.
appointmentstatus string The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype string The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid string This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby string If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid string If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname string If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow string If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable string If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired string This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason string This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims array As detailed in /claims, if requested.
coordinatorenterpriseyn string If true, the appointment was booked through athenaCoordinator Enterprise.
copay string Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date string The appointment date.
departmentid string
duration integer In minutes
encounterid string The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate string The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus string The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
frozenyn string If true, this appointment slot is frozen
hl7providerid integer This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances array List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
lastmodified string The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby string The user who last modified the appointment.
patient string See /patients for details
patientappointmenttypename string The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid string The athenaNet patient ID for this appointment
patientlocationid string The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid string
reasonid string A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid integer The referring provider ID.
reminderdetails array Detailed ReminderCall information made for this appointment.
renderingproviderid integer The rendering provider ID.
rescheduledappointmentid string When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby string The username who scheduled the appointment.
scheduleddatetime string The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin string The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime string As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin string The timestamp when the check-in process was finished for this appointment.
stopexamdatetime string The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime string The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking string High risk score for Smart Scheduling
supervisingproviderid integer The supervising provider ID.
templateappointmentid string The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid string The original appointment type for this slot. This can change for generic appointments.
urgentyn string Urgent flag for the appointment.
useexpectedprocedurecodes array An array of expected procedure codes attached to this appointment.
Example Code

Delete open appointment slot

DELETE
/v1/{practiceid}/appointments/{appointmentid}
Deletes an open appointment slot, which will no longer allow appointments to be scheduled in that timeslot.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
appointmentid integer appointmentid

Output Parameters

Expand all
appointmentid string The appointment ID that was deleted.
Example Code