SMART Web Messaging
1.0.0 - trial-use

SMART Web Messaging, published by HL7 International - FHIR Infrastructure WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of and changes regularly. See the Directory of published versions

Activity Catalog

These activities serve as navigation targets for ui.launchActivity messages. They are designed to describe navigation points within an EHR environment. We focus on defining common activities that are likely to exist across multiple EHR systems, rather than creating a fine-grained EHR-specific workflow model. It’s important to note that this is an extensible set; while we define a set of standardized activities using “bare” keywords like order-sign, any EHR may support custom activities using fully-qualified URIs like https://my-ehr/custom-activity-name.

Standardized activities follow the same naming convention as CDS Hooks, with noun-verb form. In addition to following the same naming convention, we’ll align with the actual names of existing CDS Hooks activities where feasible.

Conformance Language

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this specification are to be interpreted as described in RFC2119.


See CDS Hooks appointment-book


Name Optionality Description
appointmentLocations REQUIRED FHIR Bundle of FHIR Appointment resource locations in draft status, and any other supporting data.


See CDS Hooks order-sign for a similar operation.


Name Optionality Description
draftOrderLocations REQUIRED array of draft order locations (references to) already existing in the scratchpad. See the scratchpad.* operations.


Allow the EHR user to add a new problem to the patient’s problem list.


Name Optionality Description
problemLocation REQUIRED Reference to a pre-existing FHIR Condition resource which is used by the EHR to pre-populate the data entry screen presented to the user.