Understanding a Vocera Assignment Manager Adapter Configuration |
The minimum requirements for a Vocera Assignment Manager Adapter are described here.
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 | 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 | ended_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the assignment actually ended. |
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. |
Attribute | timestamp | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the assignment was received. |
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 | patient | assignments | False | False | N/A | Many-to-one | The ASSIGNMENTS Dataset is linked to the PATIENTS Dataset, and the link order is n:1 (many assignments associated to one patient). |
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). |
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 | functional_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 | 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). |
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 | functional_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). |
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 | 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). |
PATIENTS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | mrn | N/A | True | N/A | N/A | String | Attribute that stores the Medical Record Number of the patient. |
Attribute | status | N/A | False | N/A | False | String | Attribute that stores the admission status of the patient. |
Link | assignments | patient | False | False | N/A | One-to-many | The PATIENTS Dataset is linked to the ASSIGNMENTS Dataset, and the link order is 1:n (one patient associated to many assignments). |
Link | current_place | patient | False | False | N/A | One-to-one | The PATIENTS Dataset is linked to the PLACES Dataset, and the link order is 1:1 (one patient associated to one place). |
Link | patient_assignments | patient | False | False | N/A | One-to-many | The PATIENTS Dataset is linked to the PATIENT_ASSIGNMENTS Dataset, and the link order is 1:n (one patient associated to many patient_assignments). |
PATIENT_ASSIGNMENTS Dataset
Element | Name | Reverse Name | Key | Reverse Key | Required | Type | Description |
---|---|---|---|---|---|---|---|
Attribute | interface_ref_name | N/A | True | N/A | N/A | String | Attribute that stores the identifier for the interface owning this patient assignment. |
Attribute | patient_assignment_id | N/A | True | N/A | N/A | String | Attribute that stores the unique identifier for the patient assignment. |
Attribute | assigned_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment was assigned. |
Attribute | created_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment was created. |
Attribute | ended_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment actually ended. |
Attribute | ends_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment is scheduled to end. |
Attribute | external | N/A | False | N/A | False | Boolean | Attribute that stores whether or not the assignment came from an external system. |
Attribute | started_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment actually started. |
Attribute | starts_at | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient 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. |
Attribute | timestamp | N/A | False | N/A | False | Date/Time | Attribute that stores the timestamp at which the patient assignment was received. |
Link | patient | patient_assignments | False | True | N/A | Many-to-one | The PATIENT_ASSIGNMENTS Dataset is linked to the PATIENTS Dataset, and the link order is n:1 (many patient_assignments associated to one patient). |
Link | role | patient_assignments | False | False | N/A | Many-to-one | The PATIENT_ASSIGNMENTS Dataset is linked to the FUNCTIONAL_ROLES Dataset, and the link order is n:1 (many patient_assignments associated to one functional_role). |
Link | usr | patient_assignments | False | True | N/A | Many-to-one | The PATIENT_ASSIGNMENTS Dataset is linked to the USERS Dataset, and the link order is n:1 (many patient_assignments associated to one user). |
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). |
Link | patient | current_place | False | False | N/A | One-to-one | The PLACES Dataset is linked to the PATIENTS Dataset, and the link order is 1:1 (one place associated to one patient). |
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. |
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). |