Viewing the Vocera Clinical API Adapter Requirements

The minimum requirements for a Vocera Clinical API Adapter installation are described here.

System

This adapter depends on Vocera Platform 6.1.0.

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.

The ASSIGNMENTS Dataset stores all assignments for staff. These are used to determine who to send alerts to.
The BEDS Dataset stores all information for beds that are registered.
The DEVICES Dataset stores all details of every device registered with the Vocera Platform. Each device to which Vocera can send a message must be listed in this dataset.
The FACILITIES Dataset stores all facility information. Represents a physical building location or campus.
The LINES Dataset stores each telephone line reported by a device when it is registered.
The LOCATIONS Dataset stores all locations. These represent a bed or group of beds to which assignments are made.
The PLACES Dataset stores all places.
The ROOMS Dataset stores all information for rooms that are registered.
The UNITS Dataset stores all unit information for a facility. Represents a unique care unit in a facility.
The USERS Dataset stores all Vocera users.

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	accepted_at	N/A	False	N/A	False	Date/Time	Attribute that stores the timestamp at which the assignment was accepted by the user.
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	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	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)

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	vendor	N/A	False	N/A	True	String	Attribute that stores the vendor of the device. For example, Cisco or XMPP.
Attribute	updated_at	N/A	False	N/A	False	Date/Time	Attribute that stores tThe timestamp at which the devices was updated.
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 for 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	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)

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 an actual telephone or directory number
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.
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	places	locs	False	False	N/A	Many-to-many	The LOCATIONS Dataset is linked to the PLACES Dataset, and the link order is m:n (many locations associated to many places)
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)

PLACES Dataset

Element	Name	Reverse Name	Key	Reverse Key	Required	Type	Description
Link	locs	places	False	False	N/A	Many-to-many	The PLACES Dataset is linked to the LOCATIONS Dataset, and the link order is m:n (many places associated to many locations)

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.
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)