*This integration is supported for both SMB & Enterprise businesses.

Integrating BirdEye with PointClickCare
User Manual

Integration Requirements

Information required from the BirdEye client

Supported Triggers
Organisation UUID
Facility Code (Optional)
Contact Preference Order(Optional)

Details required from the BirdEye dashboard

Enterprise ID for multi-location account and Business IDs for all locations
Business ID in the case of an SMB business

Integration Process

Business Integration Group

Create Integration Group (Curl Command)
Fetch information for all the triggers (Curl Command)
Find business integration group details (Curl Command)

Business Integration Mapping

How it works
Finding the Organisation UUID and Facility Code

Complete Integration within PointClickCare EHR

Introduction

PointClickCare is an electronic health record (EHR) software used by healthcare practitioners to connect, communicate and access relevant insights for faster decision making and seamless transactions. Integrating PointClickCare with BirdEye will automate the process of sending out review requests to the patients on a daily basis.

Once PointClickCare is integrated with BirdEye, our system will be receiving webhook request from PointClickCare based on patient’s status updates. BirdEye collects the first name, last name, email address and phone number of your patients and automatically sends them review requests based on the preferences set within the BirdEye dashboard.

Integration Requirements

Supported triggers

BirdEye allows you to fetch data from your CRM using some predefined triggers. Here is the supported trigger for PointClickCare:

Trigger Name	Trigger Description
PointClickCare Patient Activity Trigger	This trigger is used to fetch a patient's details based on activities such as admit, discharge or transfer from PointClickCare.

Information required from BirdEye Dashboard

For single location SMB account - Business ID
For multi-location account - Enterprise ID of all locations
Enterprise ID

Integration process

Before you can integrate PointClickCare with BirdEye, you will need to set up following configurations:

Business Integration Group: A business integration group is a configuration that supports the business hierarchy of individual businesses on the BirdEye platform. The properties that are common for all business integrations are entered at the group level. Setting up business integration group allows you to associate multiple business locations with the Enterprise account. Below are the list of curl commands that you will need to run to set this up.

(a) Create Integration Group (Curl Command)

Copy this Curl Command

curl -X PUT https://common-services.birdeye.com/integration/add/businessintegrationgroup -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d
'{
"parentBusinessNumber": 157830527666739,
"integrationSourceId": 72,
"integrationGroupTriggers": [
{
"actionIds": [
1
],
"triggerId": 99,
"triggerTypeId": 2
}
],
"integrationGroupProperties": [{"propertyKey": "org_uuid","propertyValue": "2TDY2SGY9E7Z1"}, {"propertyKey": "contact_preference_order","propertyValue": "Responsible Party|POA - Power of Attorney"}]
}'

157830527666739 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
86- Integration Trigger ID - It represents the trigger ID for the PointClickCare Trigger.
2TDY2SGY9E7Z1 - Organisation UUID - To be shared by the client from the PointClickCare Portal.
Responsible Party|POA - Power of Attorney - Contact Preference Order(Optional) - If client wanted to fetch out contacts based on preference they can mention it in the contact preference order separated by pipe operator(‘|’)

NOTE: We will get the group ID once we run the first curl (Integration Group) and make a note of group ID as that will be required while we will be doing the integration mapping.

(b) Fetch information for all the triggers available for PointClickCare (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/72 -H 'cache-control: no-cache' -H 'content-type: application/json'

Sample response: A sample response like this (see below) will appear after you run the curl command. The response will have the trigger name, description and the ID. This trigger ID will be utilized while creating the integration group. An integration can have one or more triggers. To use more than one trigger, enter comma separated values while creating the integration group.

[{"id": 99,
"integrationSourceId": 72,
"triggerService": "pointClickCarePatientActivityTriggerService",
"displayName": "PointClickCare Patient Activity Trigger",
"description": "This trigger is used to fetch a patient\'s details based on activities such as admit, discharge or transfer from PointClickCare.",
"active": true,
"integrationSourceName": "PointClickCare",
"integrationTriggerType":[{"id":2,"name":"WEBHOOK"}]
}]

99 - Trigger IDs

(c) Find business integration group details (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/149581663020602 -H 'Cache-Control: no-cache'

149581663020602 - Business ID: Enter the Business ID here to get the integration group ID for the business.

Sample Response

[
 {
"groupId": 25,
"integrationSourceType": {
"id": 15,
"integrationSource": "POINTCLICKCARE",
"sourceCategory": "HealthCare",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 86,
"triggerTypeId": 2
}
],
"integrationProperties": [{"propertyKey": "org_uuid","propertyValue": "2TDY2SGY9E7Z1"}]
}]

25 - Group ID: A group ID will be returned in the sample response with the details of the existing trigger for the business.

Business Integration Mapping

This configuration is developed to create the actual business integration mapping. Each business integration mapping corresponds to the individual business location.

How it works

Copy this Curl Command

curl -X PUT https://common-services.birdeye.com/integration/add/businessintegrationmapping -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d '{"businessNumber": 151980725935863,"active": true,"integrationGroupId" : 25,"integrationProperties":[{"propertyKey" : "facility_code","propertyValue": "6647"}, {"propertyKey" : "event_type_list","propertyValue": "patient.admit, patient.discharge"}]}'

151980725935863 - Business ID- Enter the Business ID here.
25 - Group ID- Enter the Group ID that was returned when the Integration group was created.
6647 - Facility Code(Optional) - This is an optional field, should be used for multi-location setup. Facility Code(not Facility Id) will be provided by the client. The corresponding Facility Code can be fetched using steps described in the section below.
patient.admit,patient.discharge - Event Types(Optional) - This is an optional field, depending on the use case if the client wants to check-in only a particular category of customers, then they should fill it. Valid values are(patient.admit, patient.discharge, patient.transfer). If they wish to provide more than one value they can include them using a comma separator(,)

Finding the Organisation UUID and Facility Code

The organization UUID will be provided by the client and the ‘Facility Code’ can be obtained from the PointClickCare account. Once logged in, the user needs to click on the ‘Facility’ section on the top right corner. This will open a dialog box containing the list of facilities associated with the Organization. The ‘Facility Code’ is the integral number before the ‘Facility Name’.

Completing the integration within PointClickCare EHR

Alternatively, you can click on the link below: https://marketplace.pointclickcare.com/English/directory/partner/1195082/birdeye

Integration requests can be submitted through the PointClickCare EHR.

To learn more about it, access the help section within the PointClickCare account. Log in to the PointClickCare account and navigate through the path below:

Home > Other > Help > Skilled Nursing or Senior living > Admin > Self-serve Activation for Marketplace Applications

After the request is submitted on PointClickCare, BirdEye will receive an email at integrations-support@birdeye.com. After we approve the request, the integration will be activated within approximately 2-3 business days.(You have to specifically reply “Approved” as mentioned on the Application Activation Request Mail from PointClickCare. If you have not received any mail regarding it and PointClickCare has confirmed that they have sent it, you can follow the alternate steps as mentioned in Approval Application Request from PointClickCare Developer Portal)

Re-Authorise Business

Sometimes it happens the credentials entered were wrong during setup or are expired so we receive 401 Unauthorized Error while running the Integration and as a result Integration will be marked unauthorized. It will not run until the credentials are corrected and the business is authorized again which involves the steps as given in the below document.

Re-Authorise Document

Campaigns Tags

Campaign tags are used to setup campaigns within the BirdEye dashboard.These tags are either provided by the client or can be fetched from Kibana for already checkedIn contacts.

PointClickCare Campaign tags are:

pms_event_type,pms_patient_status,discharge_status, destination, destination_type, admission_source, origin, origin_type

Approving Application Request from PointClickCare Developer Portal

After the PointClickCare has processed your

You can login to the portal https://amplify.pointclickcare.com/spa using the below credentials and move to the Apps section.

Credentials: pointclickcare@birdeye.com/BirdEye123!

Now you have to set up the 2FA authentication for which you can download any 2FA app from app store or playstore on your mobile and scan the below QR code.

After login you can click on Birdeye Reviews App and click on the View App Request Tab to see the list of unapproved requests.

Click on Approve to activate the approval request.

Restriction Reason

Restriction reason is used to identify the contacts which have been opted-out(restricted) from sending a review request. This reason can be fetched from Kibana for contacts that are checked-in already.

Possible restriction reasons for PointClickCare are: