Home Schema Example JSON Schema

Permissions

Type: object

Cleo application specific permissions.

Stream Response

Type: boolean

Allow the content to be streamed directly from Hippocrates instead of a redirect. Use sparingly and with care. Defaults to false.

Profile

Type: string

The cleo patient or clinician profile with access to this link.

Must match regular expression: ^(clinician|patient)\:\w{16,}$

Permissions

Type: array of string

Permission required for clinician to acess this link.

No Additional Items

Each item of this array must be:


Clinic (Mutate)

Type: const

Allowed to mutate and query clinic. This is currently unused.

Specific value: "mutate_clinics"

Globals (Mutate)

Type: const

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.

Specific value: "mutate_globals"

Clinicians (Mutate)

Type: const

Allowed to mutate and query all clinicians within the clinic.

Specific value: "mutate_clinicians"

Clinicians (Query)

Type: const

Allowed to query all clinicians within the clinic.

Specific value: "query_clinicians"

Monitoring Forms (Mutate)

Type: const

Allowed to mutate and query all monitoring forms (and formsets) within the clinic.

Specific value: "mutate_monitoringforms"

Monitoring Forms (Query)

Type: const

Allowed to query all monitoring forms (and formsets) within the clinic.

Specific value: "query_monitoringforms"

Parameters (Mutate)

Type: const

Allowed to mutate and query all parameters within the clinic.

Specific value: "mutate_parameters"

Parameters (Query)

Type: const

Allowed to query all parameters within the clinic.

Specific value: "query_parameters"

Alert Rules (Mutate)

Type: const

Allowed to mutate and query all alert rules within the clinic.

Specific value: "mutate_alertrules"

Alert Rules (Query)

Type: const

Allowed to query all alert rules within the clinic.

Specific value: "query_alertrules"

Reminders (Mutate)

Type: const

Allowed to mutate and query all reminders within the clinic.

Specific value: "mutate_reminders"

Reminders (Query)

Type: const

Allowed to query all reminders within the clinic.

Specific value: "query_reminders"

All Patient Forms (Mutate)

Type: const

Allowed to mutate and query all patient forms within the clinic.

Specific value: "mutate_all_patientforms"

All Patient Forms (Query)

Type: const

Allowed to query all patient forms within the clinic.

Specific value: "query_all_patientforms"

All Patient Programs (Mutate)

Type: const

Allowed to mutate and query all patient programs within the clinic.

Specific value: "mutate_all_patientprograms"

All Patient Programs (Query)

Type: const

Allowed to query all patient programs within the clinic.

Specific value: "query_all_patientprograms"

All Patient Events (Mutate)

Type: const

Allowed to mutate and query all patient events within the clinic.

Specific value: "mutate_all_patientevents"

All Patient Events (Query)

Type: const

Allowed to query all patient events within the clinic.

Specific value: "query_all_patientevents"

Clinic Programs (Mutate)

Type: const

Allowed to mutate and query all clinic programs within the clinic.

Specific value: "mutate_clinicprograms"

Clinic Programs (Query)

Type: const

Allowed to query all clinic programs within the clinic.

Specific value: "query_clinicprograms"

IC Patient Forms (Mutate)

Type: const

Allowed to mutate and query all patient forms that a clinician is in-charge of within the clinic.

Specific value: "mutate_ic_patientforms"

IC Patient Forms (Query)

Type: const

Allowed to query all patient forms that a clinician is in-charge of within the clinic.

Specific value: "query_ic_patientforms"

Alertee Patient Forms (Mutate)

Type: const

Allowed to mutate and query all patient forms that a clinician is an alertee of within the clinic.

Specific value: "mutate_alertee_patientforms"

Alertee Patient Forms (Query)

Type: const

Allowed to query all patient forms that a clinician is an alertee of within the clinic.

Specific value: "query_alertee_patientforms"

Caregiver Patient Forms (Mutate)

Type: const

Allowed to mutate and query all patient forms that a clinician is an caregiver of within the clinic.

Specific value: "mutate_caregiver_patientforms"

Caregiver Patient Forms (Query)

Type: const

Allowed to query all patient forms that a clinician is an caregiver of within the clinic.

Specific value: "query_caregiver_patientforms"

IC Patient Program Forms (Mutate)

Type: const

Allowed to mutate and query all patient program forms that a clinician is in-charge of within the clinic.

Specific value: "mutate_ic_patientprogramforms"

IC Patient Program Forms (Query)

Type: const

Allowed to query all patient program forms that a clinician is in-charge of within the clinic.

Specific value: "query_ic_patientprogramforms"

Alertee Patient Program Forms (Mutate)

Type: const

Allowed to mutate and query all patient program forms that a clinician is an alertee of within the clinic.

Specific value: "mutate_alertee_patientprogramforms"

Alertee Patient Program Forms (Query)

Type: const

Allowed to query all patient program forms that a clinician is an alertee of within the clinic.

Specific value: "query_alertee_patientprogramforms"

Caregiver Patient Program Forms (Mutate)

Type: const

Allowed to mutate and query all patient program forms that a clinician is an caregiver of within the clinic.

Specific value: "mutate_caregiver_patientprogramforms"

Caregiver Patient Program Forms (Query)

Type: const

Allowed to query all patient program forms that a clinician is an caregiver of within the clinic.

Specific value: "query_caregiver_patientprogramforms"

Submission Comments (Query)

Type: const

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.

Specific value: "mutate_submission_comments"

Additional Properties of any type are allowed.

Type: object