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 ConsoleBioT Console - The BioT Console is the portal you use as a device manufacturer, to configure the entire BioT PaaS to your needs..
    The console opens on the Templates tab.
  1. From the Templates tab, click Add+.
  2. Select the Device template type from the dropdown menu.
Add Device TemplateAdd Device Template

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").
New Device Template OverviewNew Device Template Overview

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.

Built-In General FieldsBuilt-In General Fields

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 PHIPHI - Protected Health Information under the U.S. law is any information about health status, provision of health care, or payment for health care that is created or collected by a Covered Entity, and can be linked to a specific individual. checkbox. This field is mandatory and cannot be disabled.

Name FieldName Field

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.

Description FieldDescription Field

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.

Unique ID FieldUnique ID Field

Unique ID Field

Time Zone

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

Time Zone FieldTime Zone Field

Time Zone Field

Creation Time

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

Creation Time FieldCreation Time Field

Creation Time Field

Last Modified Time

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

Last Modified Time FieldLast Modified Time Field

Last Modified Time Field

Owner Organization

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

Owner Organization FieldOwner Organization Field

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.

Patient FieldPatient Field

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.
Add General FieldAdd General Field

Add General Field

  1. Click Please choose a name and enter a name for the new field.
Choosing a Field NameChoosing a Field Name

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).
Choose Attribute TypeChoose Attribute Type

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.
PHI and RequiredPHI and Required

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

Status Attributes PageStatus Attributes Page

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.

Firmware Version Field with Highlighted JSON NameFirmware Version Field with Highlighted JSON Name

Firmware Version Field with Highlighted JSON Name

HW Version

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

Connected

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

IP Address

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

Last Connected Time

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

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.

Boot Time

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

Operational Status

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

Operational Message

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

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.

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.
  1. Choose a name for the new usage type and optionally change how frequently it is measured (the default is 1000ms).
  1. Optionally add additional fields to the usage type. For example, you could add a field that specifies the usage intensity.

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?