How to Integrate a 3rd Party CRM System with Clinicea

Introduction:

Sometimes when you come on board Clinicea, you may already be using a 3rd Party CRM Software. While it is ideal to use 1 single system, but in practicality you may need to continue using multiple systems to ensure existing workflows and personnel are not impacted by changes in your technology setup. To achieve this, all such disparate systems need to to be in sync i.e. integration between them is required, so that data flows in and out seamlessly. In this guide we will review how to achieve this integration

So for the purpose of pulling out data from Clinicea, there will be 3 API calls you need to plugin in to. The 3 API calls required are as follows.

getLeads

getPatients

getAppointments

getPatientPackages (optional)


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

This API method is accessible through Lead Controller. This a GET method. The method will return the details of all the Leads that have been created or modified from the particular sync date.The data will return the first 100 rows for from that sync date.

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

Details:




Possible Responses:



This API method is accessible through Patient Controller. This a GET method. The method will return the details of the Patients that have been created or modified from the given date.The data will return the first 100 rows for from that sync date.

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

Details:




Possible Responses:



This API method is accessible through Appointment Controller. This a GET method. The method will return the Appointment details for the Patients from a particular date. This will include the data related to the new as well as updated Appointments. The data will return the first 100 rows for from that sync date.

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

Details:




Possible Responses:



This API method is accessible through PatientPackageController . This a GET method. The method will return the details of the packages assigned to Patients that have been created or modified from the given date.The data will return the first 100 rows for from that sync date.

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

Details:




Possible Responses:



If you want to push data from your system into Clinicea, the following are the API calls you need to plugin in to.

postAppointmentByPatientID

postAppointment

postLead

postPatient


This API method is accessible through Appointment Controller. This a POST method. This is useful when the patient already exists in the system and you need to create an appointment for that patient.

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

Details:



Possible Responses:



This API method is accessible through Appointment Controller. This a GET method. In case a patient was not found , 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:



This API method is accessible through Lead Controller . This a Post method. This allows you to insert new leads in Clinicea

Authorization: The API role must have the necessary CRM & Call Center permissions enabled in the Clinicea Application.

Details:




Possible Responses:



This API method is accessible through Patient Controller . This a Post method. This allows you to insert new Patients in Clinicea

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

Details:




Possible Responses:

Updated on: 14/06/2023