Patient Appointment
The Patient Appointments feature allows the user to view a list of appointments for a specific patient.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Get list of patient's appointments
GET
/v1/{practiceid}/patients/{patientid}/appointments
Retrieves a list of patient's 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
showcancelled
string
Show cancelled appointments
showpast
string
Show appointments that were before today
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.
showexpectedprocedurecodes
string
Show expected procedure codes.
showtelehealth
boolean
Show indicator for if this is a native athenatelehealth appointment
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
appointmentcancelreasonid
string
The appointment cancel reason id if the appointment is cancelled
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.
cancelleddate
string
The appointment cancel date if the appointment is cancelled
claims
array
As detailed in /claims, if requested.
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
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.
nativeathenatelehealth
string
If true, then this is a native athenatelehealth appointment.
patient
string
As detailed in /patients, if requested.
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
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.
useexpectedprocedurecodes
array
An array of expected procedure codes attached to this appointment.
Example Code
Get patient's specific appointment
GET
/v1/{practiceid}/patients/{patientid}/appointments/{appointmentid}
Retrieves a specific appointment for the patient 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
appointmentid
integer
appointmentid
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.
showclaimdetail
boolean
Include claim information, if available, associated with the appointment.
showinsurance
boolean
Include patient insurance information.
showexpectedprocedurecodes
boolean
Show expected procedure codes
showpatientdetail
boolean
Include patient information for each patient associated with an appointment.
showtelehealth
boolean
Show indicator for if this is a native athenatelehealth appointment
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.
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.
claims
array
As detailed in /claims, if requested.
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.
insurances
array
List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
patient
string
As detailed in /patients, if requested.
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.
useexpectedprocedurecodes
array
An array of expected procedure codes attached to this appointment.
Example Code