Settings for configuring miscellaneous clinic settings. This field is exposed to Frontend for Cleo users.
No Additional PropertiesAPI key to verify incoming API calls
Must be at least 1 characters long
Clinician sessions will be deactivated after this number of seconds of idling. Defaults to no idle timeout.
Format date/time using this Python strftime style format. Defaults to ISO-8601 format.
Must be at least 1 characters long
Module that is enabled in the clinic.
Whether the clinic is using V3 or not. Defaults to false.
Settings for patient module in frontend.
No Additional PropertiesThe type of gql in module.
Tabs in modules.
No Additional ItemsName of the tab.
Must be at least 1 characters long
Filter used in GQL for this tab.
Additional Properties of any type are allowed.
Type: objectFilter used in GQL for this tab.(Deprecated)
No Additional PropertiesThe type of this element.
Specific value:"expression"
Expression of filter.
No Additional PropertiesOperator of expressions.
The type of this element.
The type of this element.
Specific value:"at_least"
An operator that filters any data where at least N of the conditions are true
Number of data where condition is true.
Value must be greater or equal to 1
Expressions of data
No Additional ItemsThe type of this element.
Specific value:"condition"
The type of this element.
Specific value:"Q"
Django ORM query
No Additional PropertiesMust be at least 1 characters long
Must be at least 1 characters long
Value must be greater or equal to 0
Must contain a minimum of 1 items
Settings for table columns in this tab.
No Additional ItemsColumn type for rendering in frontend.
Label for column.
Must be at least 1 characters long
Whether to allow sorting in this columns.
Key to retrieve data for this column.
Must be at least 1 characters long
Settings for monitoring module in frontend.
No Additional PropertiesThe type of gql in module.
Tabs in modules.
No Additional ItemsName of the tab.
Must be at least 1 characters long
Filter used in GQL for this tab.
Additional Properties of any type are allowed.
Type: objectFilter used in GQL for this tab.(Deprecated)
No Additional PropertiesThe type of this element.
Specific value:"expression"
Expression of filter.
No Additional PropertiesOperator of expressions.
The type of this element.
The type of this element.
Specific value:"at_least"
An operator that filters any data where at least N of the conditions are true
Number of data where condition is true.
Value must be greater or equal to 1
Expressions of data
No Additional ItemsThe type of this element.
Specific value:"condition"
The type of this element.
Specific value:"Q"
Django ORM query
No Additional PropertiesMust be at least 1 characters long
Must be at least 1 characters long
Value must be greater or equal to 0
Must contain a minimum of 1 items
Settings for table columns in this tab.
No Additional ItemsColumn type for rendering in frontend.
Label for column.
Must be at least 1 characters long
Whether to allow sorting in this columns.
Key to retrieve data for this column.
Must be at least 1 characters long
Settings for appointment module in frontend.
No Additional PropertiesThe type of gql in module.
Tabs in modules.
No Additional ItemsName of the tab.
Must be at least 1 characters long
Filter used in GQL for this tab.
Additional Properties of any type are allowed.
Type: objectFilter used in GQL for this tab.(Deprecated)
No Additional PropertiesThe type of this element.
Specific value:"expression"
Expression of filter.
No Additional PropertiesOperator of expressions.
The type of this element.
The type of this element.
Specific value:"at_least"
An operator that filters any data where at least N of the conditions are true
Number of data where condition is true.
Value must be greater or equal to 1
Expressions of data
No Additional ItemsThe type of this element.
Specific value:"condition"
The type of this element.
Specific value:"Q"
Django ORM query
No Additional PropertiesMust be at least 1 characters long
Must be at least 1 characters long
Value must be greater or equal to 0
Must contain a minimum of 1 items
Settings for table columns in this tab.
No Additional ItemsColumn type for rendering in frontend.
Label for column.
Must be at least 1 characters long
Whether to allow sorting in this columns.
Key to retrieve data for this column.
Must be at least 1 characters long
Describes the first/last name style. Defaults to eastern.
Patient sessions will be deactivated after this number of seconds of idling. Defaults to no idle timeout.
Show full identifiers everywhere on the dashboard for this clinic. Defaults to true.
Settings related to billing for this clinic.
No Additional PropertiesThe maximum number of users allowed to be registered in the clinic. Optional.
Value must be greater or equal to 1
First Day of the clinic's subscription plan. To be of format 'YYYY-mm-dd'
Last Day of the hospital's subscription plan. To be of format 'YYYY-mm-dd'
Type of Package chosen
Type of Plan chosen
Settings related to Cleo integration with Chatterbox for this clinic.
No Additional PropertiesWhether to allow users who are not enrolled to talk to the Bot. Defaults to false. The PATIENT_NOT_ENROLLED template will be sent for patients that are not enrolled when this value is false.
Settings related to Cleo integration with Jarvis for this clinic.
No Additional PropertiesNumber of seconds to wait before it sent a new disclaimer. Defaults to 3600.
Value must be greater or equal to 0
Identifier to use for LLM responses. Defaults to *.
Must be at least 1 characters long
Array of allowed login methods. If not set, defaults to [phone].
Must contain a minimum of 1 items
List of clinician designations to complement/override the auto-generated list. This will be reflected in the cleoClinicianDesignations GQL object type.
Replace the auto-generated list instead of adding on to it. Defaults to true.
A mapping from canonical clinical designations to possible instantiations when searching and filtering. Filtering/searching should be case insensitive.
Each additional property must conform to the following schema
List of designations to use for filtering. The canonical designation is always part of the list (i.e., empty list is okay).
No Additional ItemsMust be at least 1 characters long
Describes how the patient should be verified when accessing their own dashboard. If patient_dashboard_verification is not set or verification_fields is empty, it means no verification is necessary.
Message to display as the on the secondary verification page. Defaults to "".
Must be at least 1 characters long
An array of verification fields displayed to the user for verification purposes before accessing their personal dashboard.
No Additional ItemsUse this verification key as secondary verification of the patient. A limited number of options are currently supported:
- none: No verification is required
- identifier and identifier_last_4: Based on the Patient model's identifier field.
- verification_token and verification_token_last_4: Based on the Patient model's verification_token field.
- phone, phone_e164, and phone_without_country_code: Based on the Patient model's phone field.
Note that all comparisons are case-insensitive.
Show this text as the label of the associated text input.
Table settings for configuring the look and feel of "Discharged Patients" table.
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Table settings for configuring the look and feel of "Active Patients" table.
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Table settings for configuring the look and feel of "Active Patients" table.
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Table settings for patient monitoring "All" tab
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Table settings for configuring the look and feel of "Discharged Patients" table.
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Patient monitoring table settings "Non-Compliant" tab
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Patient monitoring table settings "Unread comments" tab
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Single patient submissions view table settings
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Patient monitoring table settings "Unresolved Alerts" tab
No Additional PropertiesTitle of the table for display to the user. Will be passed through i18n.
Must be at least 1 characters long
This is used to decide the default sorting for the result set.
Must be at least 1 characters long
Result is order in descending order based on the default sort field is set to true.
Settings for each column in the table. This is an ordered array of columns from left to right.
Must contain a minimum of 1 items
Column unique identifier. This is used for sorting purposes.
Must be at least 1 characters long
The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").
Accessor value to use to retrieve the data
Must be at least 1 characters long
Make column sticky either to left or right
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
background color of the column
Must be at least 3 characters long
Define child columns within a header column. The properties of this column are similar to its parent
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectThe component to render. Defaults to Text.
Width of the column. Defaults to browser math.
Must be at least 1 characters long
Styling props to pass to the component.
Additional Properties of any type are allowed.
Type: objectMake this column un-sortable. Defaults to false.
Describes how data is being formatted and rendered to the user.
No Additional PropertiesTemplate string (include ${x} variables) to define how cells are rendered.
The following variables are available for patient-form tables:
${clinic[name]}: Name of clinic.${clinic[uid]}: UID of clinic.${clinic[domain]}: Domain for clinic login.${clinic[effective_logo]}: URL to clinic logo.${profile[uid]}: UID of clinician/patient profile.${profile[name]}: Name of clinician/patient.${profile[phone]}: Phone number of clinician/patient.${profile[language]}: ISO language code of clinician/patient's preferred language.${profile[communication_method]}: Preferred communication method of clinician/patient.${clinician[designation]}: Designation of clinician (currently not used).${patient[identifier]}: Masked identifier for patient.${monitoring_formset[uid]}: UID of monitoring formset.${monitoring_formset[name]}: Name of monitoring formset.${monitoring_formset[alert_rules]}: Comma-separated names of alert rules of monitoring formset.${monitoring_formset[reminders]}: Comma-separated names of effective reminders of monitoring formset.${monitoring_formset[reminder_descriptions]}: Comma-separated description of effective reminders of monitoring formset. Descriptions are human readable representation of the reminder schedule.${monitoring_formset[clinical_parameters]}: Comma-separated names of clinical parameters of monitoring formset.${monitoring_form[uid]}: UID of monitoring form.${monitoring_form[effective_name]}: Name of monitoring form.${monitoring_form[language]}: Language of monitoring form.${monitoring_form[url]}: URL of monitoring form.${patient_form[uid]}: UID of patient-form.${patient_form[language]}: Language of patient-form.${patient_form[alert_rules]}: Comma-separated names of effective alert rules of patient-form.${patient_form[reminders]}: Comma-separated names of effective reminders of patient-form.${patient_form[reminder_descriptions]}: Comma-separated description of effective reminders of patient-form. Descriptions are human readable representation of the reminder schedule.${patient_form[alertees]}: Comma-separated values of patient-form's clinicians alertees' names.${patient_form[ics]}: Comma-separated values of patient-form's clinicians in-charges' names.${patient_form[created_on]}: Enrollment date of patient-form. Formatted using clinic datetime format string.${patient_form[deactivated_on]}: Discharge date of patient-form. Formatted using clinic datetime format string.${patient_form[last_submitted_on]}: Date of most recent submission form. Formatted using clinic datetime format string; N/A if not available.The following variables are available for submission tables (in addition to the variables ☝️)
${submission[uid]}: UID of submission.${submission[created_on]}: Submission date of submission.${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.Template string for href of Link component. The same variables set as valueTemplate is supported.
Charts settings for displaying individual patient's charts. Charts will be displayed in the same order as this array of settings.
Must contain a minimum of 1 items
Schema for configuring the look and feel of a patient chart.
No Additional PropertiesTitle of the chart for display to the user. Will be passed through i18n.
Must be at least 1 characters long
subtitle of the chart for display to the user. Will be passed through i18n.
Must be at least 1 characters long
Type of the chart, either scatter, singleLine or multiLine.
key identifying which chart is being display. i.e HR, BP
Must be at least 1 characters long
For example in the case of Alexandra, we combine the BG data Reading values with time taken (i.e After Meal, before Meal, etc...)
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
Props for configuring the legend of the series. It will be passed to VictoryLegend. If not specified, legends will not be used for the chart.
Unit associated with the average result. i.e %, °C.
Must be at least 1 characters long
How many decimal places to show after each entry. ie. 1
Value must be greater or equal to 0
Clinical parameters that will be displayed on this chart. This will be used to filter submission values in GQL (and reduce network traffic). It can be either name or uid of parameter. Defaults to returning all parameter values.
Must contain a minimum of 1 items
Must be at least 1 characters long
Representation of the graph in table view, columns definition. The properties of these columns are similar to the table config
Must contain a minimum of 1 items
Additional Properties of any type are allowed.
Type: objectSettings for each series to display in the chart.
Must contain a minimum of 1 items
Title of the line / series. This will be used for default in legends, etc.
Must be at least 1 characters long
Props for configuring the symbols/data points of the series. It will be passed to the chart as style.data.
Props for configuring the line of the series. It will be passed to the chart as style.data. This is only applicable for line charts.
Template string defining how tooltips for data points are shown. Supported variables are:
- ${submission[uid]}: UID of submission.
- ${submission[created_on]}: Submission date of submission.
- ${submission_value[<name_with_group>]}: Submission value for clinical parameter name_with_group. Example: ${submission_value[BP Systolic]}.
- ${submission_value[<uid>]}: Submission value for clinical parameter with UID uid. Example: ${submission_value[xxxxx123456789012345678901234567]}.
Must be at least 1 characters long
Engage clinic settings.
No Additional PropertiesWhether to allow an already enrolled patient to re-enroll, thereby resetting their state. Defaults to false.
MOH CDMP settings.
No Additional PropertiesWhether to allow the fancy Excel file export format for MOH CDMP users. Defaults to false.
NEMG scheduling settings
No Additional PropertiesScheduling confirmation settings
No Additional PropertiesUID of message template set to use for confirmation message
Scheduling cancellation settings
No Additional PropertiesUID of message template set to use for cancellation message
Rescheduling settings
No Additional PropertiesUID of message template set to use for rescheduling message
List of reminders settings
No Additional ItemsReminder interval in seconds, use negative value for reminding before the event and positive for reminding after
Callback data for event reminder Kronos callback
UID of message template set to use for reminder message
Additional Properties of any type are allowed.
Type: objectSettings for the LLM model during query flow.
Prompt for the embedding.
Dimension of the embedding
Where is the model from?
HNSW settings
Defines settings for HNSW graph. See
https://github.com/run-llama/llamaindex/blob/977d60a058c691957dae3eb3c66c1894faea24ac/llama-index-integrations/vectorstores/llama-index-vector-stores-postgres/llamaindex/vectorstores/postgres/base.py#L570
Distance metric to use. Note that by default PGVectorStore.buildquery calls cosine_distance
Size of the dynamic candidate list for constructing the graph. Higher value provides better recall at the cost of speed
Size of the dynamic candidate list for search. Higher value provides better recall at the cost of speed.
Max number of connections per layer.
Name of embedding model to use.
Must be at least 1 characters long
Instruction for the query.
Context size of the embedding model