Press enter to see results or esc to cancel.

How to Integrate Convox Call Center Software with Clinicea

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:

Parameter Description Type
patmobile In order to search for a patient, a registered mobile number is required. This parameter will search for the patient for this particular mobile number.If the search is successful, it will return a JSON object which will have the appropriate patient details.

This is a STRING value.

 

countrycode It is the country code of the mobile number that is supposed to be passed. For ex: +91

This is a STRING value

 

Possible Responses:

Status Response

HTTP Code

Patient Search successful  

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

200

Patient not found No content

204

 

 

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:

Parameter Description Type
patID ID of the patient whose past appointment details would be returned This is a STRING value.

 

 

Possible Responses:

Status Response HTTP Code
Appointment data is found for the request A JSON object which will return the Appointment details for date range

200

Appointment data is not found for the request No content 204

 

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:

Parameter Description Type
clinicID ID of the clinic for which the appointment will be created. This is a mandatory value This is a STRING value.

 

clinicName The ID of the clinic for which the appointment needs to be booked. This is a mandatory value This is a String value
appointmentDate The date for which the Appointment will be booked. Format should be an ISO 8601 notation in UTC ex: 2015-03-21T14:30:10. This is a mandatory value This is a String value
appointmentStartTime The time when the Appointment will start. The format hh:mm. This is a mandatory value This is a String value
duration Appointment duration in minutes. This will be an String value.This is a mandatory value This is a String value
patientID ID of the patient against whom you need to create an apppoinment. This is a mandatory value This is a String value
staffID Staff ID against whom the Appointment will be booked. This is a String value
staffName The name of the Staff This is a String value
resourceName The Resource Name for which the Appointment needs to be booked.Please note either the combination of StaffID and StaffName or ResourceName is mandatory. This is a String value
serviceID Appointment can be associated with services. If you want a service to be linked with the appointment, then provide a valid service ID. This is a String value

Possible Responses:

Status Response HTTP Code
Appointment is successfully created on the Clinicea Calendar A JSON object which will return the Appointment details that has been created

200

Appointment could not be created successfully Error message explaining why appointment could not be created. 400

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:

Parameter Description Type
clinicID ID of the clinic for which the appointment will be created. This is a mandatory value This is a STRING value.

 

clinicName The ID of the clinic for which the appointment needs to be booked. This is a mandatory value This is an String value
appointmentDate The date for which the Appointment will be booked. Format should be an ISO 8601 notation in UTC ex: 2015-03-21T14:30:10. This is a mandatory value This is a String value
appointmentStartTime The time when the Appointment will start. The format hh:mm. This is a mandatory value This is a String value
duration Appointment duration in minutes. This will be an String value.This is a mandatory value This is a String value
patientFirstName The Last Name of the Patient for whom the Appointment will be booked.This is a mandatory value This is a String value
patientLastName The Last Name of the Patient for whom the Appointment will be booked. This is a mandatory value This is a String value
patientMobileNo The mobile phone number of the patient. Enter only the mobile number excluding the country code. This is a mandatory value This is a String value
patientDateofBirth The date of birth of the patient. Format should be an ISO 8601 notation in UTC ex: 2015-03-21. This is a mandatory value This is a String value
patientEmailAddress The email address of the patient. This is a mandatory value This is a String value
Gender Enter M for male and F for female This is a String value
staffID Staff ID against whom the Appointment will be booked. This is a String value
staffName The name of the Staff This is a String value
resourceName The Resource Name for which the Appointment needs to be booked.Please note either the combination of StaffID and StaffName or ResourceName is mandatory. This is a String value
serviceID Appointment can be associated with services. If you want a service to be linked with the appointment, then provide a valid service ID. This is a String value


Possible Responses:

Status Response HTTP Code
Appointment is successfully created on the Clinicea Calendar A JSON object which will return the Appointment details that has been created

200

Appointment could not be created successfully Error message explaining why appointment could not be created. 400