From RolePermission.schema.yaml (cleo/RolePermission.schema)
---
$id: https://skeleton.botmd.io/cleo/RolePermission.schema
$schema: http://json-schema.org/draft-07/schema#
title: Role Permission
description: >-
The list of permissions that are associated with a role.
Note that `mutate_*` and `query_*` permissions are mutually exclusive; mutate implies query permissions.
type: array
items:
type: string
oneOf:
- title: Clinic (Mutate)
description: Allowed to mutate and query clinic. This is currently unused.
const: mutate_clinics
- title: Globals (Mutate)
description: >-
Allowed to mutate and query global settings. Global settings include:
1. Create/Update of alert rules with `is_for_clinic = true`
2. Create/Update of reminders with `is_for_clinic = true`
3. Attaching/Detaching of any alert rules / reminders to monitoring formset.
const: mutate_globals
- title: Clinicians (Mutate)
description: Allowed to mutate and query all clinicians within the clinic.
const: mutate_clinicians
- title: Clinicians (Query)
description: Allowed to query all clinicians within the clinic.
const: query_clinicians
- title: Monitoring Forms (Mutate)
description: Allowed to mutate and query all monitoring forms (and formsets) within the clinic.
const: mutate_monitoringforms
- title: Monitoring Forms (Query)
description: Allowed to query all monitoring forms (and formsets) within the clinic.
const: query_monitoringforms
- title: Parameters (Mutate)
description: Allowed to mutate and query all parameters within the clinic.
const: mutate_parameters
- title: Parameters (Query)
description: Allowed to query all parameters within the clinic.
const: query_parameters
- title: Alert Rules (Mutate)
description: Allowed to mutate and query all alert rules within the clinic.
const: mutate_alertrules
- title: Alert Rules (Query)
description: Allowed to query all alert rules within the clinic.
const: query_alertrules
- title: Reminders (Mutate)
description: Allowed to mutate and query all reminders within the clinic.
const: mutate_reminders
- title: Reminders (Query)
description: Allowed to query all reminders within the clinic.
const: query_reminders
- title: All Patient Forms (Mutate)
description: Allowed to mutate and query all patient forms within the clinic.
const: mutate_all_patientforms
- title: All Patient Forms (Query)
description: Allowed to query all patient forms within the clinic.
const: query_all_patientforms
- title: All Patient Programs (Mutate)
description: Allowed to mutate and query all patient programs within the clinic.
const: mutate_all_patientprograms
- title: All Patient Programs (Query)
description: Allowed to query all patient programs within the clinic.
const: query_all_patientprograms
- title: All Patient Events (Mutate)
description: Allowed to mutate and query all patient events within the clinic.
const: mutate_all_patientevents
- title: All Patient Events (Query)
description: Allowed to query all patient events within the clinic.
const: query_all_patientevents
- title: Clinic Programs (Mutate)
description: Allowed to mutate and query all clinic programs within the clinic.
const: mutate_clinicprograms
- title: Clinic Programs (Query)
description: Allowed to query all clinic programs within the clinic.
const: query_clinicprograms
- title: IC Patient Forms (Mutate)
description: Allowed to mutate and query all patient forms that a clinician is in-charge of within the clinic.
const: mutate_ic_patientforms
- title: IC Patient Forms (Query)
description: Allowed to query all patient forms that a clinician is in-charge of within the clinic.
const: query_ic_patientforms
- title: Alertee Patient Forms (Mutate)
description: Allowed to mutate and query all patient forms that a clinician is an alertee of within the clinic.
const: mutate_alertee_patientforms
- title: Alertee Patient Forms (Query)
description: Allowed to query all patient forms that a clinician is an alertee of within the clinic.
const: query_alertee_patientforms
- title: Caregiver Patient Forms (Mutate)
description: Allowed to mutate and query all patient forms that a clinician is an caregiver of within the clinic.
const: mutate_caregiver_patientforms
- title: Caregiver Patient Forms (Query)
description: Allowed to query all patient forms that a clinician is an caregiver of within the clinic.
const: query_caregiver_patientforms
- title: IC Patient Program Forms (Mutate)
description: Allowed to mutate and query all patient program forms that a clinician is in-charge of within the clinic.
const: mutate_ic_patientprogramforms
- title: IC Patient Program Forms (Query)
description: Allowed to query all patient program forms that a clinician is in-charge of within the clinic.
const: query_ic_patientprogramforms
- title: Alertee Patient Program Forms (Mutate)
description: Allowed to mutate and query all patient program forms that a clinician is an alertee of within the clinic.
const: mutate_alertee_patientprogramforms
- title: Alertee Patient Program Forms (Query)
description: Allowed to query all patient program forms that a clinician is an alertee of within the clinic.
const: query_alertee_patientprogramforms
- title: Caregiver Patient Program Forms (Mutate)
description: Allowed to mutate and query all patient program forms that a clinician is an caregiver of within the clinic.
const: mutate_caregiver_patientprogramforms
- title: Caregiver Patient Program Forms (Query)
description: Allowed to query all patient program forms that a clinician is an caregiver of within the clinic.
const: query_caregiver_patientprogramforms
- title: Submission Comments (Query)
description: Allowed to mutate submission comments (e.g., create) of submissions where clinician already has access to the patient-form. Note that having `MUTATE_*_PATIENTFORMS` does not imply this permission.
const: mutate_submission_comments
#end properties