This page provides an overview of the PainChek/Manad Integration. It’s designed to provide PainChek clients and their IT teams with an understanding of how PainChek integrates with the Manad System.
The PainChek Manad Integration serves two main purposes:
-
It allows resident data that is created or updated in Manad, to be reflected in the PainChek system
-
It allows PainChek assessments that are created in the PainChek system to be reflected in Manad
At it’s simplest, the integration can be represented as:
Manad 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.
The Manad server is generally located on-premise at the clients site.
The PainChek server is a multi-tenanted cloud-hosted solution (housed in the AWS cloud).
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 both Manad and PainChek make available.
The PainChek and Manad APIs provide a secure means to integrate with third parties using industry standard REST protocols. PainChek can’t directly access the Manad database - all interaction is via the Manad API and vice versa.
In order for the Integration Module to be able to access the Manad API, PainChek integration needs to be enabled in Manad and the resulting API key supplied to PainChek. That process is documented here.
We often find that the Manad API is not accessible to third parties (such as PainChek) by default as Manad is typically configured to support local, on-premise access only.
In order for PainChek Integration Module to be able to connect to the Manad API, external access needs to be enabled for the PainChek servers. This entails:
-
Whitelisting the PainChek servers on the client's firewall - this site documents the IP addresses that need to be whitelisted, and
-
Enabling secure (HTTPS) communication with the Manad API (using TLS 1.2 or later protocols).
Note: It is technically possible to use HTTP to access the Manad API, however, our obligations under the Privacy Act 1988 would infer the HTTPS is required.
The complete infrastructure typically looks like this:
The red flow represent the secure HTTPS data flows from the PainChek Integration Module through to the Manad API and back.