By the word "integrations" we mean technical integrations between two or more systems. These are applications such as an EHR or a BI-tool and the Minddistrict platform. Integrations can be useful for administrative or research purposes.
There are two types of integrations:
- An integration for authentication: automated login from one system to another system
- Integrations for synchronisation: data is exchanged between systems
For each integration described below, you will find the type.
There are costs associated when making integrations available and configuring them. Would you like to make use of this or receive more information? Please contact your account manager.
In the configuration tile of most integrations, you can access an error log. Is something not going as expected? Always check the error log.
Active Directory
This is an integration for synchronising data.
This integration will automatically create, update and deactivate employee accounts in the Minddistrict platform directly from your organisation's source database. Thus, the management of these accounts within Minddistrict is standardised, simplified and also a lot more secure.
The moment this integration is made available to you, you configure it yourself. Every field and the introduction contain an explanation.
Do you combine Azure AD synchronisation with the authentication method SAML, which uses the same registration source? Logging into your organisation's working environment then means that professionals no longer have to log into the platform manually.
Minddistrict integrates with both Azure Active Directory and AD on premise.
Check the error log, via the button at the top right, the moment the API link does not work as expected. Usually, you will find relevant information about the issue here already.
API Users
This is an integration for synchronising data.
Via the (REST) API, you execute tasks and information retrieval automatically.
The (REST) API consists of all kinds of so-called 'endpoints'. Each endpoint is equivalent to a function of the platform. You query these from another system, such as an EPD, client portal or BI tool. Depending on the system's request, the REST API can respond to information requests, create new data or modify existing data.
1 Add an API user
The 'Add' button allows you to add multiple API users. This allows you to use the REST API for multiple interactions with your EHR and/or BI tool.
Once you click 'Add' you will be taken to the screen below:
In this screen, click 'add', after filling in the correct details. You will then be directed to the screen where you will see a token:
Note that you will see the token only once. Save this token immediately in a safe place.
2 Error log
Is the REST API not working as you expected? Check the error log. You can find this via the button at the top right.
If you contact the Minddistrict service desk because there is an issue with the API, we always ask you to check this error log and report the error.
Are you in the process of setting up the REST API? Check out the available technical documentation on the API.(Opens in new window)
Delegated logon
This is an authentication integration.
Delegated login (SSO) allows professionals and/or clients to log in to multiple systems using the same login credentials. For example: a professional logs in to the EHR and continues from there to the Minddistrict platform without logging in again. Or a client can go straight to the platform via the SSO without logging in again there.
The moment this integration is made available to you, you configure it yourself (possibly with the organisation you want to integration with).
Adding
The information from both systems are integrated and secured by means of a logon key. You generate this key within the Minddistrict platform. To do so, go to the page where this delegated logon key (secret key) is generated via the 'add' button.
Please note that you will see this key only once due to security reasons. For the same reasons, it is necessary that you send this key securely to the third-party system (e-mail is not a secure way of exchanging this information).
Active for clients and friends and/or professionals
In these two fields, you select the target group(s) for which delegated login (SSO) will be available.
Technical documentation on the delegated logon(Opens in new window) helps you to (re)set up the SSO or if the SSO is not working as expected.
HL7
Using the HL7 integration, data is synchronised.
The HL7 integration is a passive data integration. This means that the Minddistrict platform can receive and process HL7 messages from an external system such as an EHR, but does not send back HL7 messages itself.
In the platform, the messages trigger actions such as creating or updating a client account. Or creating a relation between a therapist and a client. This supports various workflows within your organisation.
Has the HL7 integration been made available to you? Possible errors are recorded and can be accessed via the 'Error log' button.
Technical documentation on the HL7 integration(Opens in new window) can be used when you run into an error or when you want to (re)setup the integration.
SAML
This is an authentication integration.
SAML is a Single Sign On (SSO) method. With SAML, employees no longer need to manually log in to the Minddistrict platform if they are already logged in to a system such as a work environment or an EHR. This simplifies the login process in a secure and standardised way, especially when the work environment requires 2FA: this way, the platform's two-factor authentication for the professional is no longer needed.
Is your organisation using (Azure) Active directory? Combine! Then it becomes possible to also create and update Minddistrict accounts for employees automatically from the same registration source.