Getting started with Actimi Signals API

The main function of Actimi Signals system is to collect patients' health observations and create alerts when one of the observation values requires medical attention.

Roles

In additionally to the patient being observed the system defines three active roles of users:

1. manager - the main role is to create and manage submitters, subscribers, and patients. Managers can also create other managers
2. submitter - can submit patient's observations to the system. Prior to that, the submitter has to be associated with the patient
3. subscriber - listen to events (including alerts) about patients. Only patients associated with the subscriber can be observed.

Tenant logical space

This is a multitenant system. Every user belongs to a specific tenant and their data is isolated. That means that all users can work only inside their tenant space. For instance, If a particular patient needs to be observed by subscribers from different tenants this patient has to be registered to both tenants (registered twice).

Every tenant has tenantId. The tenantId is used only for authentication and there is no need to use it during normal operations. When patients are registered by managers they are automatically assigned to the manager's tenant id

Tenants are registered by Actimi Signals administrators. At least one manager has to be created and assigned to the tenant.

API Client workflow

The recommended workflow for a registered user if following

1. If you already have a JWT token, check/renew it using User Info endpoint and go to step 3. If failed go to step 2
2. Otherwise, obtain the JWT token using Authenticate enpoint.
3. Use the new JWT token to authorize access to other API calls

Note: Internally (in the code and database), notifications are for historical reasons defined as "alerts." However, this definition does not imply an urgent situation. These notifications are solely intended to inform the user.