Generic Entity Template

The Generic Entity template lets you create any additional data entity that you would need on top of the built-in data entities and link those entities to the other entities in a manner that represents the functional linkage between them. For example, you can create an entity of medical expertise and link both hospital departments and clinicians to this expertise or you can create an entity of a file that can be linked to the device template.

The use of the Generic Entity template allows different Generic Entity types to be created when the standard templates (Device, Organization, Caregiver, Patient, Organization User) cannot fulfil that need (for example, non adherence, device alert, hospital department, device group, etc.). Defining attributes within Generic Entities enables the system to be taught what attributes and capabilities are required for each Generic Entity type.

As with other templates, the Generic Entity template comes with built-in attributes (pre-configured attributes) as well as providing you the ability to add any number of attributes you want.

For additional information on the different field types, see Attribute Types

Built-in Attributes for General Fields

FieldDescriptionField TypeRequired (R) / Optional (O)
Creation timeTime the Generic Entity was created in the system (this can represent any time you want).Date TimeO
Last modified timeTime of last change done to the Generic Entity (time it was last edited).Date TimeO
NameA name to be assigned to every Generic Entity.LabelR
Owner OrganizationA reference to the Organization the Generic Entity is associated with.EntityR

For more information on Generic Entity Templates, see Adding a Generic Entity Template.

Global Entity

Global Entities are a special type of Generic Entity that can exist across multiple organizations. They are particularly useful for manufacturers managing shared data, such as firmware versions, that apply to more than one organization.

Global Entities are created under the manufacturer organization and are visible in read-only mode to users in other organizations.

To make an entity global (accessible across all organizations), the Owner Organization must be removed during the creation process.

Configuration Requirements

  1. Remove the required Owner Organization from the template: This allows entities to exist without being tied to a specific organization. You can still assign a Global Entity to a particular organization later if you wish to limit its visibility.
  1. Add the Owner Organization field to the Add/Edit/Expand view in the template configuration. This ensures that you can manage and clear this field when creating new entities.
  2. Add a dedicated tab in the Manufacturer Portal. In the Portal Builder, go to the Manufacturer Portal → Main, and in the Tabs Section, add a new tab for the entity. Creating entities through an organization’s tab will automatically attach them to that organization, preventing them from being global.
  3. Create the entity in the Manufacturer Portal When adding the entity, make sure the Owner Organization field is empty before saving.

Because Global Entities are organization-agnostic, they can only reference other Global Entities. Referencing non-global entities would associate them with a specific organization, contradicting their global nature.

However, Global Entities can be referenced by any entity, including organization-specific ones. This enables shared use across the platform—for example, devices in multiple organizations can reference the same global firmware version entity.

📘

Notes

  • Entities cannot be converted from global to non-global, However, the reverse is supported.
  • It is recommended to avoid deleting organizations that are connected to global entities. This behavior will be improved in future releases.