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
| Field | Description | Field Type | Required (R) / Optional (O) |
|---|---|---|---|
| Creation time | Time the Generic Entity was created in the system (this can represent any time you want). | Date Time | O |
| Last modified time | Time of last change done to the Generic Entity (time it was last edited). | Date Time | O |
| Name | A name to be assigned to every Generic Entity. | Label | R |
| Owner Organization | A reference to the Organization the Generic Entity is associated with. | Entity | R |
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 multiple organizations.
These entities can be created under the manufacturer organization only and are visible in read-only mode to users in other organizations. To make an entity global (accessible across all organizations), the manufacturer organization must be removed during the creation of the entity.
When the template is configured to support Global Entities (by making the Owner Organization field optional), you can still assign a Global Entity to a specific organization, limiting its visibility accordingly.
Since Global Entities are meant to be organization-agnostic, they can only reference other Global Entities. Referencing non-global entities would tie them to a specific organization, which contradicts their global nature. However, Global Entities can be referenced by any entity, including those owned by specific organizations, enabling shared use across the platform. For example, a device in two different organizations can reference the same global firmware version entity.
Notes
- This feature is available upon request and not enabled by default.
- Entities cannot be converted from global to non-global, However, the reverse is supported.
- Attach operations are not supported for global entities.
- It is recommended to avoid deleting organizations that are connected to global entities. This behavior will be improved in future releases.
Updated 3 days ago