Appointment Confirmation Status

The Appointment Confirmation Status feature allows the user to view and update the confirmation of an appointment. The Appointment Confirmation Status Reference allows the user to view a list of available confirmations to choose from for an upcoming appointment.

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

Get appointment confirmation status

GET
/v1/{practiceid}/appointments/{appointmentid}/confirmationstatus
Retrieve the confirmation status of a specific 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

Output Parameters

Expand all
confirmationname string Description of appointment confirmation status.
shortname string If defined then the status is a positive confirmation.
Example Code

Update appointment confirmation status

PUT
/v1/{practiceid}/appointments/{appointmentid}/confirmationstatus
Update the confirmation status of a specific 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
success string Whether the operation was successful.
Example Code

Get list of appointment confirmation statuses

GET
/v1/{practiceid}/reference/appointmentconfirmationstatus
Retrieve the types of confirmation statuses configured in the system to put on the 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
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
name string Appointment Confirmation Status.
statusid integer Status Id
Example Code