Introduction

VirtuaQ is a Ticketing system used by businesses. It issues a ticket number to the visitors of the business based on a first come basis. The ticket number is issued by a hardware kiosk and the number displayed on a large screen in the waiting area.

The way it works is that the VirtuaQ kiosk prompts the Patient to enter their NRIC or Mobile number. It then passes this information to Clinicea. Clinicea checks if there exists any appointment “Today” belonging to a Patient is found. If found the appointment status is changed to waiting.

So for the purpose of handling this Integration there are 2 new API calls in Clinicea as follows.

  1. GetTodaysAppointment

  2. SetAppointmentToWaiting

Let’s get down to the details of both this API calls one by one.

1. GetTodaysAppointment:

This API method is accessible through Appointment Controller. This a GET method. The method will search for the scheduled or confirmed appointments of the patient based on the NRIC number or the Phone number that will be passed by the user. If the search is successful, it will fetch the next appointment and will return the appointment details of the user.

Authorization: The API role must have the necessary calendar permissions enabled in the Clinicea Application.

Details:

Possible Responses:

2. SetAppointmentToWaiting

This API call is accessible through Appointment Controller. This is a PUT API method.

The dependent API call for this method has been explained in point no. 1. The API method “get_next_patient_appointment” will return a JSON object which will contain the appointment details for the patient which will also have the appointment id. This appointment ID will be used in this method. This method will take this appointment id and will change the status of the appointment to waiting. It will also update the ticket number and the ticket status for this particular appointment.

Authorization: The API role must have the necessary calendar permissions enabled in the Clinicea Application.

Details:

Possible Responses:

Did this answer your question?