Skip to main content

Integration

An integration is a web application that interacts with the Healthblocks API.

Automate​

Integrations can behave as a robot performing any action that a user can, this way we can automate repetitive work. Or handle specific situations.

Extend​

Integrations can manage extensions,

Integrations can expose an endpoint that is callable by any user. This endpoint is available as part of the Healthblocks API and acts as a proxy to the integration service. This custom endpoint require no authentication to call, but the integration is passed a temporary access token in the headers.

Interopability​

Combining multiple systems typically requires some "glue code", that is one of the tasks of an integration. Even though we aim to support FHIR as good as possible, some data points need to be transformed before use.

Security​

Integrations have administrator permissions, so be careful of what you install.

Future​

Integrations have been designed to allow for serverless execution. This opens up the possibility to run custom integrations code on the fly without any DevOps effort.

Options​

display - the name of the integration.

slug - a URL-friendly name of the integration. It must be unique per server.

baseUrl - URL to embed in the admin dashboard to configure the integration.

endpointUrl - URL that will receive requests to /integration/<slug>/endpoint/*.

installationUrl - URL that will receive a POST request when the integration is installed.

context - indicates if an integration supports server and/or project level installations.