Understanding the Vocera VMP Adapter Rules

The Vocera VMP Adapter can be triggered to send alert messages to the VMP system when Vocera Platform receives data.

The alert message is composed using the static and dynamic values from the settings defined in the rule configuration. The message is sent to VMP using the username, password, and callback information from the adapter configuration, as well as the alert message, responses, and users to deliver to, based on the rule configuration and stored data.

See the Vocera Platform Dataset Guide for information about working with rules. See Configuring a Vocera VMP Adapter for information about adapter settings.

In the Adapter Settings, configure the Rule Settings fields to manage message delivery.

Setting Description
Rule Action

The action to be performed when a rule is triggered. This is a required field.

Select one option: Send User Message, Send Group Message, or Cancel Message.

Recipients

The destination or recipient that is to receive the generated message.

This is a required field when Rule Action selection is Send Message.

Deliver if Online Only

Check the Deliver if Online Only box when the message should be sent only to users who are online.

When this box is not checked, the message will be sent to all users.

Subject

The subject of the alert message to send to the recipients.

This is a required field when Rule Action selection is Send Message.

Message

The message to send to the recipients, displayed in the VCS application.

This is a required field when Rule Action selection is Send Message.

Short Message

The shorter summary of the full message for use with voise enunciation on badges.

High priority messages are read aloud to recipients; best practice is to keep messages short and protect PHI.

This is a required field when Rule Action selection is Send Message.

Priority

Establishes the message delivery prioritization. Allowed options are Urgent, High, Normal.

This is a required field when Rule Action selection is Send Message.

Accepted messages are delivered as a new high priority (value is 0) alert which vibrates and rings for 30 seconds. In configuration of the SEND ACCEPTED NOTIFICATION rule, care should be given to not contribute further to alarm fatigue for caregivers in choosing a default value for the priority field.

Enunciate

Select an option from the dropdown list for enunciation of the message to badges. This field is required.

Options are as follow:

  • Select System Default to specify that messages will be enunciated according to the adapter's configuration and rule settings.
  • Select Enunciate to allow the message to be read aloud on a badge.
  • Select Do Not Enunciate to specify that messages will not be read aloud on a badge.
Override DND

Check this box when an alert should attempt to deliver to a user in DND state.

Escalation Level

The escalation level for the message. This field may contain attribute expressions in the form #{...}.

This is a required field when Rule Action selection is Send Message.

Event Identifier

The unique identifier for the event that triggered the rule. This field may contain attribute expressions in the form #{...}.

This is a required field when Rule Action selection is Send Message, or Cancel.

Patient MRN

The MRN of the patient identified in the alert.

Expiration Time

The time, in minutes, the recipient is given to respond to the alert before the message expires.

Callback Number

The phone number to use to call back to the alerting device.

When selected, the Callback Response field is provided for configuration.

Callback Response

The value to store in the Response Action field when the user selects the callback option in response to an alert.

This field displays when Callback Number is configured.

Response Action

The path to the action to store and use when the user selects a response to the alert.

Username

The path to the username to store and use when the VMP system sends the response to the adapter.

Send (User or Group) Message Rule Action

When the Send (User or Group) Message Rule Action is selected, the following options can also be configured on the sent message.

Response Choices

Responses may be configured on the sent message to allow the recipient to respond to the message.

Setting Description
Display Value

The name (key) of the system parameter, used by the VMP system to find the values it needs.

This is a required field.

Stored Value

The value to store when the recipient selects this response.

This is a required field.

System Parameters

System parameters may be configured on the sent message to allow for the linking of arbitrary data for auxilary use (for example, Airstrip integration).

Setting Description
Name

The name (key) of the system parameter, used by VMP to find the values it needs.

This is a required field.

Value

The value of the system parameter. May contain attribute expressions in the form #{...}.

This is a required field.

Cancel Messages Rule Action

When the Cancel Message Rule Action is selected, only the Event Identifier field is configured. This option is used to cancel an alert message in the VMP system, and all events associated with the configured Event Identifier.