Appointment Expedited

The Appointment Expedite API feature will allow the user to schedule an appointment for a patient and check in that patient for their appointment simultaneously. 

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

This call will create an appointment and complete the check-in process. In order to use this endpoint, the practice setting 'Expedited Encounters and Deferred Insurance'must be configured.

POST
/v1/{practiceid}/appointments/expedited
Information about a single patient's appointments
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
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
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.
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.
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.
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.
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
referringproviderid integer The referring provider ID.
renderingproviderid integer The rendering provider ID.
rescheduledappointmentid string When an appointment is rescheduled, this is the ID of the replacement appointment.
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.
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.
supervisingproviderid integer The supervising provider ID.
urgentyn string Urgent flag for the appointment.
Example Code