Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Roles

Roles are a set of Permissions grouped together under a name. Each Organization defines its own roles and the permissions they contain. 

A User can only be associated with a single Role.

Permissions

 

IDOrganization-RelatedDescriptionUsed In
list_organizationsNoUsers with this permission can get a list of all organizations.
  • List Organizations
read_organizationYesUsers with this permission can request information of a specific organization.
  • Read Organization

list_facilitiesYesUsers with this permission can get a list of all organizations within an organization.
  • List Organization's Facilities
read_facilityYesUsers with this permission can request information of a specific facility of an organization.
  • Read Organization's Facility
list_roomsYesUsers with this permission can get a list of all the room of any facility for an organization.
  • List Facility's Rooms
  • Rooms Search
read_roomYesUsers with this permission can request information of a specific room of an organization.
  • Read Facility's Room
  • Rooms Search
list_rolesYesUsers with this permission can get a list of all the roles within a specific organization.
  • List Organization's Roles
read_roleYesUsers with this permission can request information of a specific role in an organization.
  • Read Organization's Role
list_usersYesUsers with this permission can get a list of all the users within a specific organization.
  • List Users
list_users_from_all_organizationsNoUsers with this permission can get a list of all the users from all the organizations.
  • List Users (if 'location' is not specified, this permission is required)
read_userYesUsers with this permission can read information of users from the specified organization.
  • Read User Information
delete_userYesUsers with this permission can delete users from the specified organization.
  • Delete User
modify_userYesUsers with this permission can modify information about users from the specified organization.
  • Update User Information
list_patients_from_all_organizationsNoUsers with this permission can get a list of all the patients from all the organizations.
  • List Patients
list_patients_from_current_organizationNoUsers with this permission can get a list of all the patients from the organizations where they belong.
  • List Patients
list_patients_from_current_facilityNoUsers with this permission can get a list of all the patients from the facility where they belong.
  • List Patients
list_discharged_patientsYesUsers with this permission will get discharged patients in the list returned by List Patient operation.
  • List Patients
discharge_patientsYesUsers with this permission can submit the special 'discharge patient' form.
  • Forms Submission
final_discharge_patientsYesUsers with this permission can submit the special 'discharge final patient' form.
  • Forms Submission

User Statuses

Each user has an associated Status in the System. User Statuses are defined at a system level: all organizations share the same set of possible statuses.  

The current supported statuses are:

StatusDescriptionUsed In
ACTIVEThis status is required for a User in order to log in into the application.
  • Login
PENDINGThe default status for newly created users.
  • User Registration
SUSPENDEDUsers may be suspended to avoid them to log in into the system for a period of time.
  • Update User Information
INACTIVEUsers are never deleted from the database. Instead, their status is changed to INACTIVE.
  • Delete User



Even if the API doesn't impose any limitation between the transition from one status to another, the UI implements the following state machine:

 

Image Added