Using the CDS Hooks Connection Broker

Before configuring connections between the CDS Hooks Connection Broker and any servers, ensure that your authorization server meets the specifications listed below.

Authorization Server Requirements

Note:

For more information about authorization servers in the context of CDS Hooks, please see their documentationOpens in a new tab.

Clients authenticate to CDS Hooks servers via signed JSON web tokensOpens in a new tab that must be obtained from a trusted authorization server. When configuring your FHIR and CDS Hooks servers on the Broker, you must specify the authorization server that will be used to authenticate requests to these servers.

Your authorization server must meet the following specifications:

It must support the confidential client type.
It must support the client credentials grant type.
It must accept the basic (client_secret_basic) client authentication type.

You must complete the steps to register the underlying instance of InterSystems IRIS as a client application to this authorization server. Your client configuration must also meet the specifications listed above.

Adding a FHIR Server for CDS Hooks

To complete CDS Hooks requests, a CDS Hooks server may need to access FHIR resources. Servers with FHIR resources are configured in the Broker as FHIR servers.

To register a FHIR server with the CDS Hooks Connection Broker:

Log in to the Management Portal for your CDS Hooks Connection Broker instance.
Select HealthShare or Health and then select the name of your CDS Hooks Connection Broker Namespace to enter the configuration page.
Select FHIR Servers.
Select Add FHIR Server, and enter values for the following fields:
- FHIR Server Name — a name for this FHIR server.
- FHIR Version — a fully identified version of the FHIR specification.
- Server Base URL — the baseURL for this server’s FHIR endpoint.
- Authorization Server URL — an authorization server to which the underlying instance of InterSystems IRIS is registered as a client. After selecting an option from the drop down menu, you must fill the additional field:
  - OAuth Client Name — select from the set of client configurations created for your specified authorization server.
- SSL Config — If the pre-configured HSEDS.Basic option does not work for your server, you may need to set up another SSL configuration.
- Grant Type — select client_credentials.

Adding a CDS Hooks Server

To register a Hooks server with the CDS Hooks Connection Broker:

Log in to the Management Portal for your CDS Hooks Connection Broker instance.
Select HealthShare or Health and then select the name of your CDS Hooks Connection Broker Namespace to enter the configuration page.
Select CDS Hooks Servers.
Select Add CDS Hooks Server, and enter values for the following fields:
- CDS Hooks Server Name — a name for this CDS Hooks server.
- FHIR Version — a fully identified version of the FHIR specification.
- Server Base URL — the URL of the Discovery endpoint for this CDS Hooks server.
- Authorization Server URL — an authorization server to which the underlying instance of InterSystems IRIS is registered as a client. After selecting an option from the drop down menu, you must fill the additional field:
  - OAuth Client Name — select from the set of client configurations created for your specified authorization server.
- SSL Config — If the pre-configured HSEDS.Basic option does not work for your server, you may need to set up another SSL configuration.
- Grant Type — select client_credentials.
- FHIR Source — from the drop down menu, select a FHIR source registered with the CDS Hooks Connection Broker.

Using the CDS Hooks Connection Broker API

Installing the CDS Hooks Connection Broker