Configuring Carescape Message Types

Configure the fields in the Message Types section of the Vocera Carescape Adapter.

The Vocera Carescape Adapter message types include a regex mapping for the event data from the Carescape clinical event. The regex mapping stores the event data as a clinical alert. The type of alert is mapped to the attribute alert_type in the Clinicals dataset and the additional details are mapped to the attributes clinical_details.detail_type and clinical_details.value in the ClinicalDetails dataset.

Although only one message type is required to create the adapter, implementation specialists may add, remove, or modify message types as needed. See the Understanding Regular Expressions (Regex) documentation for more information on regular expressions.

  1. Access the Vocera Carescape Adapter configuration page, and locate the Message Types section.
  2. Expand New Message Type to define the regular expressions needed to capture unit and bed data. Select Add to create additional locations as needed.
  3. Complete the configuration fields as described in the table, for new or existing adapters.
    Configuration Field Description
    Reference Name Enter a descriptive name to identify the message type. This field is required.
    Active Select this checkbox to indicate whether or not the location type is active.
    Discard Select the Discard checkbox to not process the alarm message received if it matches this specific message type. Message types may be created for alarm messages which are expected to be received but are of no interest; by marking these for discard, the messages may be filtered from the audit log.
    Regex Enter the regular expression to capture values from the event data of a clinical event received from the Carescape server. This field is required.
    Regex Mapping Enter one or more attributes or attribute paths, one per line, to be filled with data from the above regex. This field is required. Specify the regex mapping from the capture groups of the Regex field above to attribute paths starting from the Clinicals dataset.

    Two attribute mapping patterns are supported; plain attribute list, and statement of equality.

    Plain attribute list: Each item in the mapping is a simple attribute path. The first capture group of the matched regular expression is used as the value of the first attribute path in the list, and so on. The number of capture groups in the regex must match the number of attribute paths in the list. The syntax is dataset_link_attribute_name.attribute_name, or dataset_attribute_name.

    Statement of equality: The left-hand side of the statement is the attribute path, while the right-hand side is the value that the attribute path should be set to. On the right, use numbered captured groups (such as $1) to reference elements matched, or literal strings. The syntax is dataset_link_attribute_name.attribute_name=LITERAL, or dataset_attribute_name=$1, or example_with_two_capture_groups=$2:$1.

    Clone Message Type Select Clone Message Type to create a duplicate configuration of the selected message type. The duplicate's reference name will be unique and will not be active, by default.
    Remove Message Type If more than one location type is created, the ability to remove a location type becomes active. Select Remove under the message type to remove it from the configuration.
  4. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.