Skip to main content

Get Started with the Healthcare Action Engine Demo

The pages which follow describe how to set up a demo instance of the InterSystems® Healthcare Action Engine populated with example notification workflows. They then provide a series of exercises which explore how a client application would interact with this demo instance to receive synchronous decision support.

These exercises guide you through the execution of a sequence of increasingly advanced interactions, using Postman (https://www.postman.com/Opens in a new tab) as a simulated client application. For convenience, templates of the client requests involved in these interactions are available as a Postman collection.

The final exercises demonstrate two secure service call workflows which fully adhere to the CDS Hooks specification: one where the client provides an access token authorizing the Healthcare Action Engine to request the data that it needs from your HL7® FHIR® resource server; and another where the client provides prefetched FHIR data to the Healthcare Action Engine as part of its request.

The exercises include specific instructions for completing these interactions using a HealthShare Unified Care Record® instance’s Operational Data Store (ODS) FHIR endpointOpens in a new tab and OAuth 2.0 server as (respectively) a FHIR resource server and its corresponding authorization server. They also include specific instructions for authorizing access to the Healthcare Action Engine’s CDS Hooks endpoints using the Healthcare Action Engine’s own built-in OAuth 2.0 server. However, it is possible to use any properly configured FHIR server and OAuth 2.0 server for these purposes.

Deploy a Demo Environment

InterSystems provides a InstallDemo() method to initialize a Healthcare Action Engine demo instance. This demo instance contains a set of example triggers, rules, and cards. It also includes files which contain sample patient data. Each file contains data which is designed to return an expected result when that data is evaluated by one of the example rules, as described by the table in Sample Data. Using similar methods to set up a demo Unified Care Record system and demo TLS configurations, you can quickly deploy an entire environment for exploring the Healthcare Action Engine demo. To do so, perform the following steps:

  1. If you have not already done so, install a stand-alone instance of HealthShare for the Healthcare Action Engine. Do not set up the Healthcare Action Engine namespace yet.

  2. Optional: if you want to deploy a demo Unified Care Record instance to use alongside your Healthcare Action Engine demo instance:

    1. Install an instance of HealthShare for Unified Care Record.

    2. Set up a simple demo Unified Care Record system, including productions, users, interoperability credentials, and a demo TLS configuration. Essentially, this setup can be achieved by issuing the following commands from an ObjectScript shell within the Unified Care Record instance’s HSLIB namespace:

       set status = ##class(%ZHSLIB.TLS.API).ConfigSecureHSDemo()
       set status2 = ##class(HS.Util.Installer).InstallDemo()
    3. Start all of the Unified Care Record productions.

  3. Set up a demo TLS configuration for Healthcare Action Engine. Within the Healthcare Action Engine instance, open an ObjectScript shell and issue the following command:

      set status = ##class(%ZHSLIB.TLS.API).ConfigSecureHSDemo()

    Alternatively, you can define a TLS configuration using your own certificates.

  4. Start your Healthcare Action Engine production, if you have not done so already.

  5. Within your Healthcare Action Engine instance, open an ObjectScript shell and ensure you are in your Healthcare Action Engine namespace.

  6. Execute the following command:

     set status = ##class(HSEDS.Util.Installer).InstallDemo(<InstallOption>)
    

    where <InstallOption> is one of the following:

    • 1 — Purges all existing configuration data from tables before loading data for the demo production.

    • 2 — Does not purge existing configuration data, but overwrites existing demo production demo based on ID.

    • 3 — Does not purge or overwrite existing configuration data. Only loads new data for the demo production.

Download and Import the Healthcare Action Engine Demo Walkthrough Postman Collection

To demonstrate synchronous decision support interactions with the Healthcare Action Engine, the exercises on the pages which follow guide you through a sequence of increasingly advanced HTTPS interactions. Templates for the requests which are involved in these interactions have been preconfigured in Postman, a common API development platform (https://www.postman.com/Opens in a new tab). Postman will serve as a simulated CDS Hooks client application.

These requests have been numbered and packaged into a Postman Collection. The requests in the collection incorporate a set of common collection variables (https://learning.postman.com/docs/sending-requests/variables/Opens in a new tab); in most cases, to adapt one of the requests into a request which is valid within your demo environment, you only need to update the current values of collection variables as instructed.

To use the Healthcare Action Engine Demo Walkthrough Postman Collection:

  1. If you do not already have a Postman account, create one: https://identity.getpostman.com/signupOpens in a new tab

  2. Download the collection, which is available as a GitHub repository: https://github.com/intersystems/Healthcare-Action-Engine-Demo-WalkthroughOpens in a new tab

  3. Download and run the Postman Agent (see https://www.postman.com/downloads/postman-agent/Opens in a new tab). The Postman Agent is required to send API requests using the Postman web application.

  4. Import the Postman Collection into your Postman workspace (see https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-and-exporting-overview/Opens in a new tab).

Import Sample Patient Data into Your FHIR Resource Server

The Healthcare Action Engine demo includes several files containing sample patient data, stored in the Healthcare Action Engine’s <durable-hs-data-ingestion> directory. Each file corresponds to one of the demo rules. When the patient data contained in the file is evaluated according to that rule (during a service call) it returns an expected result. The Sample Data section details the sample data files and the rules they correspond to.

For each demo synchronous rule you want to try out, import the data in the corresponding sample data file into your FHIR resource server. As is, the service requests in the Healthcare Action Engine Demo Walkthrough collection are preconfigured to invoke the demo rules EDSDemoElevatedINR and EDSDemoVaccineMeningococcal.

Note:

If you are using a HealthShare Unified Care Record® instance’s Operational Data Store (ODS) FHIR endpoint as your FHIR resource server, simply copy the sample data files you want to import into the Unified Care Record <durable-hs-data-ingestion> directory.

FeedbackOpens in a new tab