Adding a Device Template

This page will help you add a new device template.

Medical devices differ in their intended use, and therefore in the kind of attributes you want to use for describing them. You should have a Device template for each type of device you want to connect to BioT.

❗️

Important

If this is the first device type you are adding, you should edit the "Device Type 1" template before adding a new Device Template (see Editing a Device Template).

Follow the procedure below to add a new device template.

Step 1 - Templates Tab

  1. Launch the BioT Console.
    The console opens on the Templates tab.
17221722
  1. From the Templates tab, click Add+.
  2. Select the Device template type from the dropdown menu.
15671567

Add Device Template

Step 2 - Overview Tab

  1. Add a name and optional description for the template. Use a template name that reflects the device type ( for example, "Glucometer").
33863386

New Device Template Overview

  1. Click Next.

Step 3 - General Fields

The General fields page is displayed with the list of built-in attributes.
General attributes include data that users want to track about the device, but that does not affect the day-to-day function of the device. For example, one of the General attributes may be a Patient attribute which describes which patient the device belongs to.

21452145

Built-In General Fields

📘

Note

You can click the trash can icon to remove (or disable in case of built-in attributes) any unneeded field from the template.

The following built-in General attributes appear in all new Device templates:

Name

Attribute type: Label
The device name.
Note that if you name the device after its patient, then the Name field contains protected health information, and you should check the PHI checkbox. This field is mandatory and cannot be disabled.

870870

Name Field

Description

Attribute type: Paragraph
If the Name field of the device is not enough for your users to describe the device, use the Description field to elaborate. If you don't need it, click on the trashcan icon to disable it.

870870

Description Field

Unique ID

Attribute type: Label
The unique ID the Manufacturer assigned to the device. Many times this is the serial number of the device. If this is the case, you may rename the field name to “Serial Number”. This field is mandatory and cannot be disabled.

856856

Unique ID Field

Time Zone

Attribute type: Timezone
The time zone the device is generally located in.

856856

Time Zone Field

Creation Time

Attribute Type: Date Time
When the Device record was first created in the cloud.

870870

Creation Time Field

Last Modified Time

Attribute Type: Date Time
When the Device record was last edited.

870870

Last Modified Time Field

Owner Organization

Attribute Type: Entity
Refers to the Organization that owns the device.

870870

Owner Organization Field

Patient

Attribute Type: Entity
This field shows an example of a permanent connection between a Device and a specific Patient. This is mostly relevant for home use devices, including implants. If your device is not a personal patient device, you may disable this attribute.

870870

Patient Field

Step 4 - Add General Field

📘

Note

You should only add General fields for attributes of the device itself. Any Configuration or Status fields should be added through the Status or Configuration tabs.

If your users need to track additional device attributes, scroll to the bottom of the General attributes list and:

  1. Click + Add General Field.
21442144

Add General Field

  1. Click Please choose a name and enter a name for the new field.
19291929

Choosing a Field Name

  1. Click the Choose Type dropdown and select the attribute type from the list (see Attribute Types for a full list of types and their parameters).
19291929

Choose Attribute Type

  1. Complete the remaining parameters for the Attribute Type.
  2. If the field contains protected health information, select the PHI checkbox. When you do that, BioT adds additional safeguards for the field and refrains from storing or sending it to non-HIPAA Eligible media (e.g. using it in the content of an email) along with patient data.
  3. For fields that you require your users to fill, select Required.
19291929

PHI and Required

  1. Click Next.

Step 5 - Status Fields

The Status attributes page is displayed with the list of built-in attributes.
Status attributes provide information about the device that the device senses on itself or that BioT senses about the device, such as whether or not the device is connected to the cloud, the device’s current operational (malfunction) status, etc. Note that this is NOT the place to define medical measurement fields (these are defined in the Patient template).

21512151

Status Attributes Page

📘

Note

You can click the trash can icon to remove any unneeded field from the template.

FW Version

Attribute Type: Label
The installed firmware version, as reported by the device.

❗️

Important!

There must be perfect alignment between the JSON name defined for the attribute and the actual JSON the device sends when it reports the status of the attribute. If you want to change the JSON name of the device, you must make sure to change the name of the attribute in the BioT platform as well.

19701970

Firmware Version Field with Highlighted JSON Name

HW Version

Attribute Type: Label
The hardware version, as reported by the device.

860860

Connected

Attribute Type: Boolean
Whether or not BioT communicated with the device recently.

868868

IP Address

Attribute Type: Label
The IP address, as reported by the device.

868868

Last Connected Time

Attribute Type: Date Time
The last time the device was connected to the cloud.

868868

Certificate Status

Attribute Type: Single Select
The current status of device certificates. Can be either Not installed, Bootstrap or Permanent. This field is only relevant for devices that connect directly to BioT and not devices that use a gateway (for example a device that connects to a mobile app which in turn connects to BioT). You can remove this field if it is not used.

868868

Boot Time

Attribute Type: Date Time
The last time the device was booted.

868868

Operational Status

Attribute Type: Single Select
The device’s operational status. Can be either: OK, Minor, Major or Critical.

882882

Operational Message

Attribute Type: Paragraph
A message describing the most severe malfunction the device is experiencing now.

868868

Step 6 - Add Status Field

To add a new Status field, scroll to the bottom of the Status attributes list, click + Add Status Field, then follow the instructions in Step 4.

Step 7 - Configuration Fields

After adding any new Status fields, click Next at the bottom of the Status Fields page. The Configuration page is shown.

21982198

Configuration attributes provide information to the device about how BioT requires it to set itself up. Examples for various devices may include brightness, fan speed, measurements upload frequency, etc...

📘

Note

Configuration fields are not populated in the default template. They may be added when you create or edit your template.

Step 8 - Add Configuration Field

To add a Configuration field, click + Add Configuration Field, then follow the instructions in Step 4.

Step 9 - Usage Types

After adding any configuration fields, at the bottom of the page, click Next. The Usage Types page is shown.
Usage Types allow you to specify what kinds of activities each device can perform and the parameters required for each of these activities.

Step 10 - Add New Usage Types

To add a new Usage Type:

  1. Click + Add Usage Type.
586586

Overview Tab

  1. The New Usage Type Template page is displayed. Add a name and optional description for the template. Use a template name that reflects the Usage Type (for example, "Heart Rate Monitoring") and optionally change how frequently it is measured (the default is 1000ms). The usage type describes the type of usage and not the content of the usage.
11741174
  1. Click Next.

General Fields

  1. The General fields page is displayed with the list of built-in attributes.
    General attributes include data that users want to track about the Usage Type. For example, one of the General attributes may be a timeframe attribute which describes when the device was last modified.
551551

📘

Note

The Usage Type Template Name, that is automatically linked throughout the different attributes tabs and appears as the name of the usage type plus usage session, can be edited (select the pen edit logo).

  1. The following built-in General attributes appear in all New Usage Type templates:

Creation Time

Attribute Type: Date Time
When the Device record was first created in the cloud.

679679

Device

Attribute Type: Entity
Link the usage type to other entities and define whether it applies to all device templates (any) or a specific device template.

679679

End Time

Attribute Type: Date Time
When the Device record ended.

679679

Last Modified Time

Attribute Type: Date Time
When the Device record was last edited.

679679

Owner Organization

Attribute Type: Entity
Refers to the Organization that owns the device and defines whether it applies to all organization templates (any) or a specific organization template.

679679

Patient

Attribute Type: Entity
This field shows an example of a permanent connection between usage of the Device and a Patient. Define whether it applies to all patient templates (any) or a specific patient template. For example, if the usage type is Heart Rate Monitoring and it is connected to a Patient template, then all instances of this usage type will be heart rate monitoring sessions performed for that specific patient.

679679

Session Initiator

Attribute Type: Single Select
Refers to how the session was started.

680680

Start Time

Attribute Type: Date Time
When the device record started.

679679

State

Attribute Type: Single Select
The state of the device recording, e.g., active, paused, stopping etc...

680680
  1. To add additional Device Usage Type attributes, scroll to the bottom of the General attributes list and:

Click + Add General Field.

949949
  1. Click Please choose a name and enter a name for the new field.
945945
  1. Click the Choose Type dropdown and select the attribute type from the list (see Attribute Types for a full list of types and their parameters).
19291929

Attribute Type: Entity can be used to create a reference link to another entity in the system. For example, linking a Device Log File.

📘

Note

If the object defined in the Generic Entity is achieved by the device itself, then it also needs to be defined for the Usage Type. For example, the type of device alert is defined in the Generic Entity, then linked to a create device alerts Usage Type.

  1. Complete the remaining parameters for the Attribute Type.
  2. If the field contains protected health information, select the PHI checkbox. When you do that, BioT adds additional safeguards for the field and refrains from storing or sending it to non-HIPAA Eligible media (e.g. using it in the content of an email) along with patient data.
  3. For fields that you require your users to fill, select Required.
19291929
  1. Click Next

Configuration Fields

Configuration attributes provide information to the device about how BioT requires it to set itself up for the Usage Type.

  1. To add a Configuration field, click + Add Configuration Field, then follow the instructions in Step 4.

  2. Click Next

Summary Fields

905905

A Summary Field presents an average or variance for each instance of usage of the device. For example, for Usage Type Monitoring, each record will be a summary of the monitoring session.

Summary fields can be used as a reference to an observation field in the form of a data type ‘link’ to establish the connection between a ‘streaming observation field’ (live telemetry) and the concluding or summarizing value of this field for the entire session. For example, live telemetry throughout the monitoring session will show the dynamic heart rate with a value sent each second, while the summary field in the usage type will show the average heart rate of the entire session.

  1. The following built-in Summary attributes appear in all New Usage Type Templates:

Stop Reason

Attribute Type: Label
The reason why the device was stopped set as a regular expression.

905905

Stop Reason Code

Attribute Type: Single Select
The stop reason code, e.g., completion, general device error or timeout.

904904
  1. To add a Summary field, click + Add Summary Field, then follow the instructions in Step 4.

Attribute Type: Entity can be used to create a reference link to another entity in the system including Generic Entities or specific templates. For example, linking a Device Log File.

Attribute Type: Linked can be used to create a reference link to any observation in the patient template.

📘

Note

Other Summary attributes can refer to the device (such as device intensity or level of utilization) but cannot be linked to other entities. For these attributes, it is necessary to define Usage Types as the attributes will not inherit the references.

  1. Click Next

📘

Note

Make sure to add names for any usage types you add, as well as selecting the field type for any fields you add to the usage type.

Step 11 - Finish Template

When you have finished adding Usage Types, click Create. The template is created, and you return to the template list.

📘

Note

You can click Cancel at any time to discard the template and return to the templates list.


Did this page help you?