Setting up Telstra Health integration for Assurance
Who is this article for?Administrators who want guidance on setting up the Telstra Health integration in Assurance.
Administration access is required.
Assurance has a custom integration, that Aged Care customers can use to connect their Clinical Manager platform, to pull completed resident incident forms into Assurance.
This article provides step-by-step instructions on how to setup your Telstra Health integration in Assurance, once you have completed the initial setup requirements.
Prior to following the instructions in this article, please ensure that you have completed the initial setup requirements, and that you have a successful connection. If you cannot establish a successful connection, please refer to our troubleshooting guide.
1. Mapping integration fields
Once you have a successful connection, you can start to map fields in Assurance where you would like to pull the data from Clinical Manager.
To map fields:
- Access Administration (Cog icon) from the navigation bar.
- Select Registers & Forms Templates.
- Open the template you will be adding the fields to.
- 5Switch to the Fields tab.
- Click + New Field.
- Select Create a New Field.
You cannot change a field from non-integration to integration (and vice versa) as it will wipe all pre-existing data. All integration fields are not editable on Assurance Forms.
- Enter the Name and Instruction as required.
- Open the Integration Metadata dropdown.
You will see all the available fields from your Clinical Manager system that you can map across to Assurance.
- Make your selection.
In the example below, we are mapping across the Your position field. Once we select it, the answers from Clinical Manger will now appear in Assurance.
- Highlight and copy the answers that appear for your chosen field.
- Select Add Answers below.
- Paste the answers into the text field.
- Click Add.
The answers for this field should now be mapped into Assurance.
It is imperative that the information pasted in the above step is an exact copy of the information copied in Step 10.
If the information pasted does not match the information copied, the integration will not be successful.
- Click Create add the field.
Repeat Steps 5 to 14 for the remaining fields that require mapping into Assurance.
2. Enabling integration
Once you have mapped all the fields onto your incident template in Assurance, you can switch on the integration.
To enable the integration:
- Access Administration (Cog icon) in from the navigation bar.
- Select Integration.
- Choose Telstra Health.
- Click Edit in the top left.
- Switch to the Automated batch data collection tab.
- Update the information in the following fields:
- Automated batch schedule - choose when Assurance pulls the data from Clinical Manager.
- Incident Status - the integration only pulls through incidents that have a completed status.
- Contract template - from the dropdown, choose the template that you have mapped the integration fields for.
- Click Save .
The first time the integration is turned on, six months of data is pulled through in the fields that have been mapped (and existed) in this period.
We recommend switching off your Assurance notifications while this occurs.
You should start to receive your first batch of data in one hour. If you turn on the scheduler at 12:10, you may start to receive your first incidents at 13:10 or after. If there is a lot of data, this may take more time.
3. Understanding how the scheduler works
3.1. Consideration regarding the scheduler
In our custom integration, we use a scheduler to monitor for new incident forms. While this approach allows us to pull completed incident forms, it is important to note some drawbacks:
- Scheduler Frequency: Polling too often can overload the server, leading to performance issues and potential downtime.
-
Server Load: Continuous polling places a significant load on the server, especially during peak times. This can lead to slower response times and increased chances of server errors, impacting the overall user experience.
-
Real-Time Updates: Unlike webhooks, which push updates in real-time, the scheduler relies on periodic checks. This means there is always a delay between the occurrence of an event (e.g., the completion of a new incident form) and the detection of that event by the scheduler.
-
Resource Intensive: The scheduler can be resource-intensive, requiring constant API calls and processing.
While the scheduler we have implemented in our custom integration is robust, it will never fully match the efficiency and real-time capabilities of webhooks. Webhooks are inherently designed to push updates as they happen, whereas our scheduler relies on periodic checks.
3.2. Advantages of using webhooks
Webhooks offer a more efficient and reliable solution by pushing updates to Assurance as they occur. This ensures real-time notifications and reduces the load on the server. Unfortunately, the current API from Telstra Health does not support webhooks. We are working with Telstra Health to explore the possibility of implementing webhook functionality or finding alternative solutions to improve the efficiency and reliability of incident form monitoring. We appreciate your understanding and patience as we work towards enhancing the integration.
4. Troubleshooting integration
4.1. Technical assistance
Before contacting us for assistance, please ensure that you have completed the following:
- tested that your connection is successful
- followed the instructions in our troubleshooting guide to troubleshoot the integration
If you have not received any incidents within three hours of turning on the scheduler and you have completed the steps above, open a Support ticket.
4.2. Setup assistance
If you require additional assistance with setting up the integration, our Professional Services team is here to help.
Our consultants can assist you with the setup process, ensuring a seamless and efficient integration tailored to your specific needs.
To engage our Professional Services team, please get in touch today, and we will be happy to assist you further.