Introduction:
Convox is a Call Center Software. The way it works is that the Call Center will receive a call from a patient who is registered inside Clinicea and ask for his registered phone number and will search for that patient using that number inside the Clinicea database. If it is found, the patient details will be displayed on the screen. Also, if the patient has a past appointment then the details of the past appointment along with the address details of the clinic will also be shown in the screen. If the details are not found using the registered mobile number, based on the consent of the patient, the Call Center will create a new patient with that phone number.

During the conversation, the Call Center will record the appointment related details in there software and once they end the call, a appointment must be booked in the Clinicea Calendar with these details.

So for the purpose of dealing with the above requirement, there will be 4 API calls you need to plugin in to. The 4 API calls required are as follows.

  1. searchPatientByMobileNumber

  2. getPatientPastCompletedAppointment

  3. postAppointmentByPatientID

  4. postAppointment

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

1. searchPatientByMobileNumber

This API method is accessible through Patient Controller. This a GET method. The method will return the details of the patient when searched using a particular phone number.

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

Details:

Possible Responses:

2. getPatientPastCompletedAppointment

This API method is accessible through Appointment Controller. This a GET method. The method will return the details of the past appointments (where the status is checked out) of the Patient who will be found in Step 1.

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

Details:

Possible Responses:

3. postAppointmentByPatientID

This API method is accessible through Appointment Controller. This a POST method. The method create an appointment on the Clinicea Calendar for a patient which will be found in STEP 1.

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

Details:

Possible Responses:

4. postAppointment

This API method is accessible through Appointment Controller Controller. This a GET method. In case a patient was not found using the mobile number, then this method will be used to create a new patient and an appointment along with it.

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

Details:


Possible Responses:


Did this answer your question?