Introduction
OpenSpecimen allows controlling data access by assigning roles to users. The privileges can be controlled at a very granular level for each resource in the system.
OpenSpecimen provides default roles which administrators can assign to different users. To view details about default user roles, follow the below steps:
Navigate to the 'Roles' card.
- Click on any of the roles to view more information.
Only Super Admins can create custom roles or edit existing roles.
Default Roles
OpenSpecimen is installed with some default roles.
Privileges of Users
PHI Fields
The below fields that are marked as PHI in OpenSpecimen won't be visible to the roles with 'Participant (DeId)' privileges:
- First Name
- Middle Name
- Last Name
- Birth Date
- Social Security Number
- Death Date
- Master Patient Index
- Medical Record Number (MRN)
- Surgical Pathology Number
- Any custom fields marked as PHI.
Edit Default Roles
- The default role listed below should not be renamed or edited. They get auto-assigned to specific users, as stated below:
| Role | Auto-assigned to |
|---|---|
| Administrator | Institute Administrator, Site Coordinators |
2. The rest of the default roles can be edited.
3. No role can be deleted via UI.
4. While editing a role, it is mandatory to keep at least one resource privilege.
Add Coordinator or PI at CP Level
- CP level PI and coordinators are not assigned any role by default.
- After creating the CP, the admin has to manually assign specific roles to all the users who need to access the CP.
Create Custom Role
You can create new roles to suit your local needs.
- Log in as a super admin user.
- Click the 'Roles' card from the home page.
- Click the 'Create' button, enter valid details.
- Click the 'Resources' dropdown and select the desired resources.
- Check the check-boxes of the privileges to be assigned on selected resources and click 'Create.'
- Repeat steps 4 & 5 to add new resources.
Import / Export
If you have 'Exp/Imp' privilege along with 'Create' or 'Update' on any resources, you will be able to perform bulk import and export operations of those resources.
Query Resource (v6.3)
- The 'query' resource allows you to access the query module.
- CRUD + IE rights on the 'Query' resource is added to all the system shipped roles but the 'Researcher.' The 'Researcher' role, by default, acquires only the Read and IE rights.
- Users who do not have Read privilege on the 'Query' resource will not be able to view the query module in OpenSpecimen.
- More details on operations associated with every privilege on query resource: Query Resource Privilege.