Appointment Checkin

Digital check-in is the ability to electronically collect and verify key patient information necessary for a patient to be seen for an appointment . This process vary by practice, but typically we recommend that the following components be included in the partner UI, leveraging the appropriate API calls to exchange the latest athenaNet information and data.

Check-in is the first stage of the 5-stage patient encounter. This feature allows the user to see if the check-in requirements have been met ("check-in") before a patient can be cleared to start the checked-in process ("startcheckin"). It is important to note that these calls return the patient's readiness status but do not allow you to modify the information needed to check-in a patient. Once started, this process can be stopped ("cancelcheckin").

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Check in this appointment.
POST
/v1/{practiceid}/appointments/{appointmentid}/checkin

Check in this appointment.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
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
message string Shows which section caused the check-in to fail.
success string Indicates whether the check-in was successful.
Example Code
Initiate appointment check-in process
POST
/v1/{practiceid}/appointments/{appointmentid}/startcheckin

Notifies that the appointment check-in process has started

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
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
message string Debugging text in case of failure.
success string Indicates that this call was successful. Processing should still continue even if there was an error with this call. Generally, this will only be false if the appointment is in a good state to start the process, but the startcheckin call was already used. Other errors may occur, similar to potential errors with /appointments/{appointmentid}/checkin.
Example Code
Cancel appointment check-in process
POST
/v1/{practiceid}/appointments/{appointmentid}/cancelcheckin

Cancel appointment check-in process. It cannot be called if the check-in process has been completed.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
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
message string Debugging in case of failure.
success string See documentation for /appointments/{appointmentid}/startcheckin. This is very similar, except this endpoint is used for canceling the check-in process rather than starting it.
Example Code
Returns the list of conditions required before check-in.
GET
/v1/{practiceid}/appointments/{appointmentid}/checkin

Shows what is required before an appointment can be checked in. 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 <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmentid integer appointmentid

Output Parameters

Expand all
complete string Whether the requirements for this section have been successfully completed.
fields array Detailed information about the requirements for each section and their status.
name string Name of the group of requirements. Can be Demographics, Insurance, Privacy Forms, Check In, and Health History Forms. The Check In section just gives you the current status.
required string Whether this section is required to be completed before check in will be allowed.
Example Code