Configuring a Vocera NaviCare Adapter

These settings enable direct communication between the Vocera NaviCare Adapter and the Vocera Platform.

Select an empty field and begin typing, or select an existing value and type over it. To keep an existing value, do not edit that field.

  1. Access the Vocera Platform Web Console and navigate to the adapters.
  2. Select New Adapter in the Action menu, or select an adapter you wish to configure and then select Edit, to display the configuration fields. The configuration fields are the same for new and existing adapters.
  3. Navigate to the New Adapter option, or navigate to an existing adapter to edit. See Creating a New Adapter and Editing an Adapter for instruction as needed.
    The configuration fields are the same for new and existing adapters.
  4. Complete the configuration fields as described in the table.
    Configuration Field Description
    Reference Name Enter a short descriptive name in the Reference Name field to uniquely identify an adapter instance. It may demonstrate the adapter function or other information; for example, Production adapter may differentiate a live adapter from a development or "sandbox" adapter.

    RESTRICTIONS

    None. All characters, including spaces, are valid for this field.

    Enabled Select the Enabled checkbox to allow the Vocera Platform to use the new adapter. The Vocera Platform ignores the adapter if this option is disabled.
  5. Enter the port that has been given by Hill Rom NaviCare. Port 12000 is the default.
  6. Complete the Message Types configuration fields as described in the table.

    Message Types are used to store message data within the Data Manager. Stored message data may trigger a Rule or be used at a later time for a display on a Workflow page, for filtering a View, be referenced in another Rule, or any other use of data permitted by Vocera Platform.

    The system matches message types in the order which they are defined. After the first message type has been successfully matched and processed, no further attempt is made to match any subsequent message type. If a message type is successfully matched, but there is an error in processing the data (See Understading Regular Expressions for an overview explanation and examples of Regex code and mappings), the system will continue to the next message type.

    Message Type Configuration Field Description
    Reference Name Enter a descriptive name for the collection of settings specified in the new Message Type being created, such as Alerts, or Cancelled Alerts. Replace the default entry (New Message Type) in the Reference Name field.
    Active Select the Active checkbox to allow the Vocera Platform to use the new Message Type. The Vocera Platform will ignore the Message Type if this option is disabled.
    Discard Select the Discard checkbox to discard messages matching the regular expression in this message type. When checked, all remaining fields are hidden except the Message Body Regex field.
    Starting Dataset Select the Starting Dataset from the drop-down list. Note that the dataset list may not display in alphabetical order. The selected dataset is the reference point for all attributes and attribute expressions used in the configuration.
    Message Reference

    Enter the Message Reference attribute configured in the starting Dataset. A Message Reference attribute stores the ID (reference number) of a NaviCare message that is transmitted to Vocera Platform. This attribute is used to identify which message a response refers to when Vocera Platform transmits an acknowledgment or acceptance back to NaviCare.

    Note: Add a Message Reference column, defined as a key, to the NurseCalls dataset, as it does not exist in the default configuration. The Message Reference attribute must be a key on the Starting Dataset for the Clear Mapping function to perform properly.
    Store Message Recipient

    Select the Store Message Recipient? checkbox if the message recipient of the incoming message should be stored in the Data Manager.

    Recipient Path

    Specify the attribute path to the receipient of the incoming message.

    Store Message Priority

    Select the Store Message Priority? checkbox if the message priority should be stored in the Data Manager in order to ensure that the appropriate action can be taken via rules that look at the priority. For example, a higher priority message from NaviCare may dictate a rule where Vocera Platform sends a message to multiple parties, and a lower priority message may not.

    Priority Path

    Specify the attribute path to the priority of the incoming message.

    Store Message Subject

    Select the Store Message Subject? checkbox if the subject content of a NaviCare message should be stored in the Data Manager.

    Subject Path

    Specify the attribute path to the subject of the incoming message.

    Store Message Callback Number

    Select the Store Message Callback Number? checkbox if the callback number belonging to a received NaviCare message should be stored in the Data Manager.

    Callback Number Path

    Specify the attribute path to the callback number of the incoming message.

    Regex

    Specify the regular expression (Regex) necessary to parse the body of the incoming message into the value expressions contained in the Regex Mapping field.

    Each set of parentheses in the Regex character string is a segment, and each segment corresponds with a line in the Regex Mapping field. An example Regex is: (\d+\+(\d+)\+(1|2))\s+(.+)

    REQUIREMENT

    The Regex code must produce values for the specified attribute(s) in the corresponding mapping. If there is not a match, the adapter will report event code 309 "Failed to identify a matching message type" in the Audit Log.
    Regex Mapping Specify one or more attributes or attribute expressions in the Regex Mapping field which correspond to the code segments entered in the Regex field. The attribute expressions must be appropriate for the Starting Dataset from which the attributes are derived. See Understading Regular Expressions for an overview explanation and examples of Regex code and mappings.
    Clear Mapping Clear Mapping is an optional setting that allows Vocera Platform to clear a nurse call alert, if configured. Without a Clear Mapping configuration, the adapter will report event code 309 "Failed to identify a matching message type" in the Audit Log.

    When a recipient accepts a Hill-Rom alert from Vocera Platform, Vocera Platform sends a message back to Hill-Rom that places the alert on a reminder list. Hill-Rom then sends a message to Vocera Platform when the recipient clears the alert. If Clear Mapping is configured, then Vocera Platform also clears the alert in the system.

    Attribute Path Enter the attribute expression that stores the Clear Mapping data.
    Value Enter the value that will be stored in the attribute expression specified in the Attribute Path.
    Clone Message Type Select Clone to make a duplicate configuration of the selected message type. The cloned version of the message type will have a unique reference name and will not be active, by default.
    Remove Message Type Select Remove to remove the Message Type from the configuration information.
  7. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.
  8. Repeat these instructions, using a different port, for any additional NaviCare clusters.