Press enter to see results or esc to cancel.

How to Integrate VirtuaQ Ticketing System with Clinicea

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:

Parameter Description

Type

PatMobile In order to search for an appointment, either a mobile number or a NRIC number is required. This parameter will search for the next appointment for this particular mobile number which is either scheduled or confirmed on the calendar. If the search is successful, it will return a JSON object which will have the appropriate appointment details.

This a STRING value.

 

PatUniqueId In order to search for an appointment, either a mobile number or a NRIC number is required. This parameter will search for the next appointment for this particular unique ID which is either scheduled or confirmed on the calendar. If the search is successful, it will return a JSON object which will have the appropriate appointment details

Either unique id or the mobile number is mandatory

This a STRING value

 

Possible Responses:

Status Response

HTTP Code

Patient Search successful and appointment found  

A JSON object which will return the appointment details for that particular patient

 

200

Patient Search successful  and appointment not found No content

204

 

Patient Search unsuccessful No content

204

 

 

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:

Parameter Description Type
apptID This is the ID of the appointment whose status needs to be changed to waiting

This is a MANDATORY parameter

This is a GUID.

.

apptTicketID Ticket ID of an appointment which needs to be updated by the user. This is OPTIONAL parameter This is a Integer value
apptTicketNumber Ticket Number an appointment which needs to be updated. This is OPTIONAL parameter This is a String value

 

Possible Responses:

Status Response HTTP Code
Appointment Status changed to waiting successfully A string value which will have the message ‘appointment status changed to waiting’  

200

Appointment Status could not be changed to waiting A string value which will have the message ‘appointment status could not be changed to waiting’

200