Setting up the Integration on mCare Side:
For 3rd parties to integrate successfully with mCare they will require your unique per-care-site key which is generated as part of the Generic API configuration screen. To do this you must be an organisation administrator to access the relevant area of mCare to complete the configuration.
For Admin Access, you will need the ‘Change communities/sites and organisation customisation’ staff access right. This can be granted by someone who already has this access right. Please speak to your manager regarding receiving this access if you do not have this. Due to GRPR PCS are unable to amend staff access rights on your behalf.
1) Firstly, navigate to Admin > Organisation Details
2) Once you have clicked Organisation Details you will need to find your care site, which will have a feint blue background to identify it. Select the care site with the feint blue background. In the example below this would be ‘Kings Bridge’.
3) Once clicking on the care site, you will find on the right side of the screen a section calledIntegrations. This is where you start the configuration of the Generic API.
4) To configure the Generic API, you need to find it listed in the Integrations section. If you do not see this, please get in touch with our Support team who will be able to arrange for this to be set up. Click on the icon cog icon to start configuration.
After selecting the cog icon, you will be presented with a screen requiring some sections to be completed.
5) Firstly, select the communities which will be using the Generic API integration. You may have training communities listed, however these usually contain data that is not relevant to 3rd party integrations, so simply select your sub communities name and not the top community.
6) Now set the access mode from ‘View Only’ to ‘Read and Write’. This sets the integration up as one which will allow care notes to start pulling through once the integration is set up.
7) Click on the Active Services item, and this will then expand to show you a list of available integrations partners that PCS work with using the Generic API.
You will be presented with an expanded list of available integrations. Find the one you have placed the order for and click it.
You will see a toggle for Oomph! Wellness. Clicking it will change the slider from white to green to indicate it is now active.
8) Finally set the status of the integration to live by clicking the status option and ensuring it goes from white to green.
To complete the setup, click the green Save button in the top right of this screen
9) Once you have set up the integration, you will then need to go back and obtain your unique API key for the location you have set up. To do this click on the cog icon again to enter the configuration screen again (you will now see that this appears green as the Generic API set up is now live.
10) Once here you will see that two fields now have unique keys in them. We are interested in the Internal API Key
Select the key (excluding the “Internal API key” words to the left) and copy it. You will need this API key later in the guide when doing the set up on Oomph! side.
Setting Up Integration on the Oomph! Side:
Once you set the integration up on mCare side, you will now be ready to do the set up on Oomph! side.
To set up the integration, you will need to be logged into a Home Manager account which will provide you access to the ‘Admin’ option on your staff account.
1) Navigate to the Residents page, by clicking Residents in the blue navigation bar
2) Click the ‘Import Residents From PCS’ Button in the top right hand corner of the page.
3) The following pop ups box will appear. Please review the terms and conations and click Confirm.
4) Paste the API Key you have obtained from mCare into the API Key field highlighted.
5) Once you have added the API Key, click Add. The Api key will then show in the table below.
4) Once the API Key has been successfully added, click the ‘Import All Residents’ button. The resident(s) will appear in the Residents section.
Any future residents added via mCare will automatically come through.