Viewing the Vocera Hill-Rom Staff Assignment Adapter Requirements

The minimum requirements for an Vocera Platform installation are described here.

In order to use this Vocera Hill-Rom Staff Assignment Adapter, the facility requires an enterprise email system, such as Outlook.

Datasets

An adapter defines a default Dataset structure in order to function. Attributes are organized by Datasets and store the information required by the adapter. Adapters use this data during the process of receiving and sending messages.

Not all adapters require Datasets to function. When an adapter does require Datasets, the system will determine if they already exist. If they do not exist, the system will create the needed Datasets.

When creating or editing an adapter, use the following information to select the appropriate datasets in the Required Datasets section.

ASSIGNMENTS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute assignment_id N/A True N/A N/A String Attribute that stores the unique identifier for the assignment.
Attribute interface_id N/A True N/A N/A String Attribute that stores the identifier for the interface owning this assignment.
Attribute level N/A True N/A N/A String Attribute that stores the level of the assignment.
Attribute assigned_at N/A False N/A False Date/Time Attribute that stores the timestamp at which the assignment was assigned to the user.
Attribute ends_at N/A False N/A False Date/Time Attribute that stores the timestamp at which the assignment is scheduled to end.
Attribute external N/A False N/A False String Attribute that stores whether or not the assignment came from an external system.
Attribute starts_at N/A False N/A False Date/Time Attribute that stores the timestamp at which the assignment is scheduled to start.
Attribute state N/A False N/A False String Attribute that stores the state of the assignment. Possible values are active, next, expired, and deleted.
Link location assignments False False N/A Many-to-one The ASSIGNMENTS Dataset is linked to the LOCATIONS Dataset, and the link order is n:1 (many assignments associated to one location)
Link role assignments False False N/A Many-to-one The ASSIGNMENTS Dataset is linked to the FUNCTIONAL_ROLES Dataset, and the link order is n:1 (many assignments associated to one functional_role)
Link usr assignments False False N/A Many-to-one The ASSIGNMENTS Dataset is linked to the USERS Dataset, and the link order is n:1 (many assignments associated to one user)

BEDS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute bed_number N/A True N/A N/A String Attribute that stores the number of the bed.
Link room beds True False N/A Many-to-one The BEDS Dataset is linked to the ROOMS Dataset, and the link order is n:1 (many beds associated to one room)
Link locations beds False False N/A Many-to-many The BEDS Dataset is linked to the LOCATIONS Dataset, and the link order is m:n (many beds associated to many locations)

DEVICES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute name N/A True N/A N/A String Attribute that stores the name that identifies the device, often based upon the MAC address of the device.
Attribute status N/A False N/A True String Attribute that stores the current registration status of the device. Possible values are Registered, Disconnected, Virtual, or Unregistered.
Attribute vendor N/A False N/A True String Attribute that stores the vendor of the device. For example, Cisco or XMPP.
Attribute ip_address N/A False N/A False String Attribute that stores the current IP address of the device. In some cases Engage needs to keep track of the IP address of a device, such as with a Cisco phone.
Attribute priority N/A False N/A False String Attribute that stores the priority level of the most recent message sent to a device. Required by the device management library, but not set by the XMPP adapter. It is used as a filter to prevent less important messages from being sent to a user currently handling a critical issue.
Attribute token N/A False N/A False String Attribute that stores a special identifier needed by some devices, such as smart phones, in order to deliver a message.
Link lines devices False False N/A One-to-many The DEVICES Dataset is linked to the LINES Dataset, and the link order is 1:n (one device associated to many lines)
Link usr devices False False N/A Many-to-one The DEVICES Dataset is linked to the USERS Dataset, and the link order is n:1 (many devices associated to one user)

FACILITIES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute name N/A True N/A N/A String Attribute that stores the unique name of the facility.
Link locations facility False True N/A One-to-many The FACILITIES Dataset is linked to the LOCATIONS Dataset, and the link order is 1:n (one facility associated to many locations)
Link roles facility False True N/A One-to-many The FACILITIES Dataset is linked to the FUNCTIONAL_ROLES Dataset, and the link order is 1:n (one facility associated to many functional_roles)
Link rooms facility False True N/A One-to-many The FACILITIES Dataset is linked to the ROOMS Dataset, and the link order is 1:n (one facility associated to many rooms)
Link units facility False True N/A One-to-many The FACILITIES Dataset is linked to the UNITS Dataset, and the link order is 1:n (one facility associated to many units)

FUNCTIONAL_ROLES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute name N/A True N/A N/A String Attribute that stores the name of the role.
Link facility roles True False N/A Many-to-one The FUNCTIONAL_ROLES Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many functional_roles associated to one facility)
Link assignments role False False N/A One-to-many The FUNCTIONAL_ROLES Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one functional_role associated to many assignments)

IDENTITIES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute name N/A True N/A N/A String Attribute that stores the name of the user's identity.
Link interface identities False False N/A Many-to-one The IDENTITIES Dataset is linked to the INTERFACES Dataset, and the link order is n:1 (many identities associated to one interface)
Link usr identities False False N/A Many-to-one The IDENTITIES Dataset is linked to the USERS Dataset, and the link order is n:1 (many identities associated to one user)

INTERFACES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute reference_name N/A True N/A N/A String Attribute that stores the interface's identifying name.
Link identities interface False False N/A One-to-many The INTERFACES Dataset is linked to the IDENTITIES Dataset, and the link order is 1:n (one interface associated to many identities)

LINES Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute number N/A True N/A N/A String Attribute that stores the number of the line.
Link devices lines False False N/A Many-to-one The LINES Dataset is linked to the DEVICES Dataset, and the link order is n:1 (many lines associated to one device)

LOCATIONS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute location_id N/A True N/A N/A String Attribute that stores the unique identifier for the location.
Attribute name N/A False N/A False String Attribute that stores the name of the location.
Link facility locations True False N/A Many-to-one The LOCATIONS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many locations associated to one facility)
Link assignments location False False N/A One-to-many The LOCATIONS Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one location associated to many assignments)
Link beds locations False False N/A Many-to-many The LOCATIONS Dataset is linked to the BEDS Dataset, and the link order is m:n (many locations associated to many beds)
Link units locations False False N/A Many-to-many The LOCATIONS Dataset is linked to the UNITS Dataset, and the link order is m:n (many locations associated to many units)

PRESENCE_UPDATE Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute timestamp N/A True N/A N/A Date/Time Attribute that stores the time this PresenceUpdate record was created.
Attribute show N/A False N/A False String Attribute that stores the show of the presence to set.
Attribute status N/A False N/A False String Attribute that stores the status of the presence to set.
Link usr presence_updates True False N/A Many-to-one The PRESENCE_UPDATE Dataset is linked to the USERS Dataset, and the link order is n:1 (many presence_updates associated to one user)

ROOMS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute room_number N/A True N/A N/A String Attribute that stores the room number.
Link facility rooms True False N/A Many-to-one The ROOMS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many rooms associated to one facility)
Link beds room False True N/A One-to-many The ROOMS Dataset is linked to the BEDS Dataset, and the link order is 1:n (one room associated to many beds)
Link unit rooms False False N/A Many-to-one The ROOMS Dataset is linked to the UNITS Dataset, and the link order is n:1 (many rooms associated to one unit)

UNITS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute name N/A True N/A N/A String Attribute that stores the unique name for a unit in a facility.
Link facility units True False N/A Many-to-one The UNITS Dataset is linked to the FACILITIES Dataset, and the link order is n:1 (many units associated to one facility)
Link locations units False False N/A Many-to-many The UNITS Dataset is linked to the LOCATIONS Dataset, and the link order is m:n (many units associated to many locations)
Link rooms unit False False N/A One-to-many The UNITS Dataset is linked to the ROOMS Dataset, and the link order is 1:n (one unit associated to many rooms)

USERS Dataset

Element Name Reverse Name Key Reverse Key Required Type Description
Attribute login N/A True N/A N/A String Attribute that stores the login name of the user.
Attribute first_name N/A False N/A False String Attribute that stores the first name of the user.
Attribute last_name N/A False N/A False String Attribute that stores the last name of the user.
Attribute middle_initials N/A False N/A False String Attribute that stores the initials of any middle names of the user.
Attribute presence_show N/A False N/A False String Attribute that stores the current presence show value for the user.
Attribute presence_status N/A False N/A False String Attribute that stores the current presence status message for the user.
Link assignments usr False False N/A One-to-many The USERS Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one user associated to many assignments)
Link devices usr False False N/A One-to-many The USERS Dataset is linked to the DEVICES Dataset, and the link order is 1:n (one user associated to many devices)
Link identities usr False False N/A One-to-many The USERS Dataset is linked to the IDENTITIES Dataset, and the link order is 1:n (one user associated to many identities)
Link presence_updates usr False True N/A One-to-many The USERS Dataset is linked to the PRESENCE_UPDATE Dataset, and the link order is 1:n (one user associated to many presence_updates)