This page provides an overview of the PainChek/AutumnCare Integration. It’s designed to provide PainChek clients and their IT teams with an understanding of how PainChek integrates with the AutumnCare System.
The PainChek AutumnCare Integration serves two main purposes:
It allows resident data that is created or updated in AutumnCare, to be reflected in the PainChek system
It allows PainChek assessments that are created in the PainChek system to be reflected in AutumnCare
The resident integration process will look for changes such as:
A new resident being created
An existing resident being updated (e.g. their profile image is updated)
The admission details or status of a resident being updated
At its simplest, the integration can be represented as:
In reality, the integration is more complex than that first diagram indicates. There is actually a separate integration module that is using the APIs (Application Programming Interfaces) that PainChek makes available.
The PainChek/AutumnCare Integration Module is a component developed by AutumnCare.
The PainChek API provides a secure means to integrate with third parties using industry-standard REST protocols. AutumnCare cannot directly access the PainChek database - all access is via the PainChek API. PainChek has no access, direct or otherwise, to AutumnCare system.
In order for the Integration Module to be able to access the AutumnCare API, a PainChek integration client id and secret is generated in PainChek and shared with AutumnCare/the Client so that they can be configured in the PainChek/AutumnCare component.
The PainChek/AutumnCare Integration Module needs to be able to access the PainCheck API (typically at https://prod.ap.painchek.com) using secure (HTTPS) communication (i.e. TLS 1.2 or later protocols).
The PainChek API will allow requests from external systems, so whitelisting of the AutumnCare servers is not needed.
The PainChek/AutumnCare Integration Module initiates all communication (there is no outbound communication from PainChek).
The complete infrastructure typically looks like this:
Note that AutumnCare may be deployed as a cloud hosted solution or an on-prem solution, and so your architecture may vary from the above diagram.
The integration process uses a polling infrastructure (to detect changes to AutumnCare patients or new PainChek assessments). The process runs regularly; typically this is every few minutes in production environments.
When synchronising resident details, the process will look for changes such as:
a new resident being created
an existing resident being updated (e.g. their profile image is updated)
the admission details or status of a resident being updated
AutumnCare is considered the source of truth for resident data, and that is the only system where resident data should be added or updated.
PainChek is the source of truth for the assessment data.