CDS Hooks Sandbox Walkthrough

1. Landing on the Sandbox

When you access the CDS Hooks Sandbox, you’ll arrive at the main dashboard. This dashboard simulates the experience of using Clinical Decision Support (CDS) Hooks in an Electronic Health Record (EHR) system. It includes panels for FHIR server settings, CDS service configurations, and various hooks for testing.

2. Overview of Each Component

• Top Menu Navigation:

  • Hooks Tabs: Displays the available CDS Hooks for testing, such as patient-view, order-select, and order-sign.
  • Settings Menu: Access by selecting the ⚙️ icon located at the top right of the page. It provides options for:
    • Add CDS Services: Add new CDS services by entering a discovery URL. Refer to the discovery documentation for more details.
    • Configure CDS Services: Manage active CDS services, enabling or disabling them as needed.
    • Change Patient: Switch between patients available in the connected FHIR server.
    • Change FHIR Server: Select or configure the FHIR server providing clinical data.
    • FHIR Server Settings: View and modify the current FHIR server configuration.
    • Reset Configuration: Restore the default configuration settings.

• Main Dashboard Panels:

  • Hook Panel: Lists options for invoking different CDS Hooks, such as patient-view, order-select, and order-sign.
  • Developer Panel: Allows you to select a CDS service for evaluation and view the JSON request/response of CDS Hooks invocations. Error messages are displayed in the browser console, which can typically be accessed by right-clicking on the page, selecting Inspect, and navigating to the Console tab.

3. Invoking patient-view

1. Navigate to the Patient View tab to simulate an EHR loading a patient's record.
2. The Hook Panel will show cards generated by the active CDS services for the selected patient. The Developer Panel allows you to review the request and response JSON to diagnose any issues.

Note: The patient-view hook is commonly used to offer patient-specific recommendations when opening a patient's chart.

Example

TODO

4. Invoking order-select

1. Navigate to the Rx View tab to simulate selecting orders (e.g., medications or tests) for a patient.
2. The Hook Panel will display any responses, such as recommendations or alerts related to the selected orders.

Note: The order-select hook provides real-time decision support based on the orders being chosen by the clinician.

Example

TODO

5. Invoking order-sign

1. Navigate to the Rx Sign tab to simulate finalizing or signing an order for a patient.
2. View any decision support recommendations or warnings in the Hook Panel before completing the order.

Note: The order-sign hook is used to offer relevant guidance just before the order is finalized.

Example

TODO

6. Changing the Patient

1. Select the Change Patient option from the settings menu (⚙️ icon at the top right).
2. Select a different patient from the list.
3. The chosen patient's data will be used for subsequent CDS Hooks invocations.

7. Changing the FHIR Server

1. Select the Change FHIR Server option from the settings menu (⚙️ icon at the top right).
2. Enter a new FHIR server URL.
3. Click Next to apply the change, connecting the Sandbox to the new server.

8. Adding CDS Services

1. Select the Add CDS Services option from the settings menu (⚙️ icon at the top right).
2. Provide the discovery URL for the new CDS service (see discovery documentation).
3. Click Save to confirm. The new service will appear in the Configure CDS Services section.

---

This guide provides a detailed overview of testing and exploring CDS Hooks functionalities within the simulated EHR environment of the CDS Hooks Sandbox.