Skip to main content

Prepare to Deploy the Healthcare Action Engine

The InterSystems® Healthcare Action Engine (HAE) is an FHIR-enabled, EHR-agnostic alert and notification workflow orchestration engine designed to deliver real-time actionable insights. It provides a no-code environment for users to create, store, and organize all the components necessary to execute alerts and notifications.

The following pages describe how to deploy and configure an instance of the Healthcare Action Engine so that you can begin developing and serving synchronous CDS Hooks notification services to be consumed by compatible client applications. For more information about CDS Hooks, refer to the CDS Hooks specification: https://cds-hooks.hl7.org/2.0/Opens in a new tab

You can deploy the Healthcare Action Engine in one of two ways:

This page describes the initial tasks you must complete before you deploy the Healthcare Action Engine, regardless of the deployment method.

Note:

To quickly deploy an instance of the Healthcare Action Engine with demo data for testing purposes, the order in which steps must be completed may vary from the order described in the pages which follow. See Get Started with the Healthcare Action Engine Demo.

Important:

The deployment process described in the pages which follow do not provide support for mirroring.

Step 1: Configure Your Web Server to Use TLS

Because of the security requirements of the CDS Hooks standard, the web server which serves the Healthcare Action Engine must make its CDS Hooks API endpoints available over HTTPS, using TLS.

Therefore, you must deploy a web server and configure it to use TLS. Refer to the documentation for the web server you are using for instructions.

Important:

Prior to 2023.2, InterSystems IRIS installations included a minimal, private web server which serves the platform’s web-based utilities (such as the Management Portal). A Web Gateway container includes a private web server. While this private web server may be sufficient for developing and testing within a secured environment, do not use these private web servers in a production system.

The web server architecture you employ will depend on several factors, such as the number of concurrent users you expect to be on the system and your organization’s security needs.

Step 2: Obtain a License to Use Healthcare Action Engine

Ensure that you have a license key which includes the Healthcare Action Engine (see Licensing).

If you are unsure what your license key supports, check with an InterSystems representative.

Step 3: Download the Necessary Deployment Media (Installation Package or Container Image)

Download the appropriate deployment media by performing the procedure which corresponds to your chosen deployment method.

To Install on an Instance of InterSystems IRIS® for Health

If you want to install the Healthcare Action Engine on an instance of InterSystems IRIS for Health:

  1. Deploy an instance of InterSystems IRIS for Health. See Deploy Using an Installation Kit.

  2. Contact an InterSystems representative to acquire the Healthcare Action Engine installation package.

Continue the deployment procedure by performing the steps described in Install the Healthcare Action Engine on InterSystems IRIS for Health. Then, perform the configuration procedures described in Post-Deployment Tasks.

To Deploy as a Container

If you want to deploy the Healthcare Action Engine as a container:

  1. Log out of any container registries that you may be logged in to.

  2. Go to the InterSystems Container RegistryOpens in a new tab (containers.intersystems.comOpens in a new tab).

  3. Log in with your InterSystems SSO credentials.

  4. Select InterSystems HealthShare Product Family.

  5. Select healthshare_healthcareactionengine.

  6. Select the version number of the image you want to run (for example, 2023.2).

    Note:

    Consult the supported versions documentOpens in a new tab to determine which versions of HAE and which versions of our HealthShare® products are compatible with each other.

  7. Select the copy icon to copy the Docker login command.

  8. Use the Docker login command to log in to the InterSystems Container Registry.

  9. Select the copy icon to copy the Docker pull command for the desired container image.

  10. Use the Docker pull command to pull the container image.

  11. Optional: pull the latest-cd Web Gateway image from InterSystems IRIS Product Family > webgateway as well. If you do not pull the image in advance, Docker pulls the image at deployment time. You do not need to be logged in to download the Web Gateway container image.

    Note:

    In the current version of the Healthcare Action Engine, the only supported web server in containers is Apache.

Continue the deployment procedure by performing the steps described in Deploy a Healthcare Action Engine Container Stack (specifying the product image type HSEDS as the INSTANCE_NAME in the environment file). Then, perform the configuration procedures described in Post-Deployment Tasks.

Install the Healthcare Action Engine on InterSystems IRIS for HealthNext section
FeedbackOpens in a new tab