API
How to use the API
Before you begin, do ensure you have purchased the API Access. API Access is not available as part of any plan and is an add-on that can be purchased by contacting your Account Manager. Let us show you how you can setup Access to Clinicea API. Login into Clinicea using your admin account details Goto Tools Organization Select an Organization. Scroll down to Preferences and click on “IntegSome readersWhat is the API Pricing
Access & Pricing API Access available in Enterprise Plan only. Up to 3000 API calls a month is included per Practitioner license. If you have a requirement which needs to make heavy usage of the API, additional blocks of API capacity can be purchased as follows: Additional 3,000 API Calls a month, $59 per month. Additional 6,000 API Calls a month, $99 a month. Additional 12,000 API Calls a month, $150 a month.Few readersWhat is Clinicea API
The Clinicea API is used by 3rd party developers to integrate their IT systems with Clinicea. In order to access the API you just need a valid API Key. The API is REST based and can be involved via curl, fiddler, or any other tool of your choice that can make basic HTTP Calls. The API also comes with an inbuilt API Explorer. Once a valid API Key has been provided to the API Explorer, you can go around clicFew readersHow 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 shoFew readersHow to Integrate a 3rd Party Financial System with Clinicea
Introduction: Sometimes when you come on board Clinicea, you may already be using a 3rd Party ERP for Inventory Management, or for Financial Accounting. 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 andFew readersWhat are the API Limits
Your API is limited to the API Plan you have purchased. However whichever plan you are on, to ensure calls to API are under fair usage policy, these are certain limits you need to remember when coding. They are as follows: Maximum of 20 API Calls per minute Maximum of 300 API Calls per Hour Maximum of 10 API connections at a time. Pagination is set to 100 records at a time. Please note that if 100 records are fetched, it will count towards 100 APIFew readersHow 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 reviewFew readersHow to Fetch Patient Visit Data from Clinicea via API
Introduction Sometimes a Client might require to fetch the patient encounter data from Clinicea for their own requirements. This data can be fetched via Clinicea API. According to this approach an API call will fetch the encounter data (in XML format). Client can use the same call to fetch the data and format it as per your requirement. So for the purpose of handling this, the API calls in Clinicea as follows. getPatientVisit Let’s get down to the details of both this APFew readersHow 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 PatientFew readers
Integrations
A step by step guide to Zoom Integration
How to create Clinicea App inside Zoom App Marketplace How to connect Clinicea with your Zoom account How to create a Zoom video appointment in Clinicea How to start a Zoom video call inside CliniceaSome readersHow to create a app in your Zoom Account
STEPS to create a Private App in the Zoom Marketplace 1. Go to the Zoom App Marketplace website (URL - https://marketplace.zoom.us/) and Sign In using the licensed Zoom account credentials shared by the client. 2. After this, you have to click on Develop and then Build App from the dropdown menu. (https://stoSome readersHow to setup your clinic to use Zoom
Table of Contents: How to create Clinicea App inside Zoom App Marketplace How to connect Clinicea with your Zoom account How to create a Zoom video appointment in Clinicea How to start a Zoom video call inside Clinicea How to see Zoom video recordings in Clinicea How to disconnect Zoom in Clinicea How to connect Clinicea with your Zoom account You can seamlessly cSome readersHow to setup your individual staff account to use personal Zoom account
1. Goto your Staff profile. 2. Scroll to bottom to Preferences and select Zoom Settings. Note: You will only see this button of Zoom Settings, if your Clinic administrator has enabled zoom as explained here. 3. Click "Zoom Settings". 4. By default all users are selected to use the common clinic account. (https://storage.crisp.chat/users/helpdesk/website/ba78b6621452eFew readersHow to create Clinicea App inside Zoom App Marketplace
STEPS Go to the Zoom App Marketplace website (URL - https://marketplace.zoom.us/) and Sign In using the licensed Zoom account credentials shared by the client. After this, you have to click on Develop and then Build App from the dropdown menu. Now, in Choose your app type you have to click on Create undeFew readersHow to integrate Clinicea into your WordPress Website
There are many different components in Clinicea that you can integrate with your website. You will find all the links in 1 place to copy from e.g. Tools Organization Primary Organization Links are all on the right hand side. Lets review them all. A. Clinic Staff Login IntegrationFew readersHow to use the QR Reader for E-invoicing in Saudi Arabia
Introduction As we know, the Zakat, Tax and Customs Authority (ZATCA) in the KSA had mandated businesses to adopt e-invoicing starting 4 December 2021. Using Clinicea, Clinics in KSA can stay compliant with these regulations and can issue invoices to their Clients as per the required guidelines of the e-invoice. One of the key components of an e-invoice is the QR code. Scanning the QR code helps Clinics to validate the e-invoice and get the details of the invoice. ZATCA have launched theFew readersHow to access data from a card reader in Clinicea
Card readers cannot be accessed via the browser most of the times. There are 2 workarounds to it Magnetic card reader upto Track 3. You can check what info your specific card reader provides, by doing the following a. Open a notepad b. put your mouse cursor on it c. connect your card reader to the computer via USB d. swipe a card in your card reader e. your notepad should have some data appearing on it. The data you can see is what can be read from the card by your card reFew readersHow to use Zoom to do teleconsults
Let's take you step by step on how to use zoom for video calling your patients, once its setup. 1. Open the video call appointment. 2. Once you have made the appointment, open your zoom account. You will see the appointment as well in the format: Dr. Name - Service with Patient Name.Few readersHow to setup your MailChimp account with Clinicea
MailChimp is a simple email marketing software (EMS) which gives you a number of easy options for designing, sending and saving templates of your emails. MailChimp allows you to easily create newsletters of varying types and then provides simple options for sharing them through various social media platforms. Clinicea has also integrated Mailchimp to help your Clinic grow. Before we start you, must have a valid MailChimp account. Disclaimer: (i). In order to setup Mailchimp witFew readers