Home Schema Example JSON Schema

Settings

Type: object

Settings related to the einstein are stored in the respective Hospital.settings under the einstein field. This field will be exposed to the Frontend.

 No Additional Properties

root activation_email_reminder_intervals_days
Type: object

root activation_email_reminder_intervals_days designations

Designations

Type: array of integer

List of day intervals to send the activation email notifications to users (ie. 7 days after activation, 14 days, etc.)

All items must be unique

No Additional Items

Each item of this array must be:

root activation_email_reminder_intervals_days designations designations items
Type: integer

Value must be greater or equal to 1

root usage_report_recipient_emails

List of emails to send Usage Reports to

Type: array of string

List of emails to send regular Usage Reports to. If empty or missing, then we will not send any usage reports.

All items must be unique

No Additional Items

Each item of this array must be:

root usage_report_recipient_emails usage_report_recipient_emails items
Type: string

Must be at least 1 characters long

root deactivation_task_report_recipient_emails

List of emails to send Deactivation task report emails to

Type: array of string

List of emails to send regular task Deactivation Reports to. If empty or missing, then we will not send any deactivation task reports.

All items must be unique

No Additional Items

Each item of this array must be:

root deactivation_task_report_recipient_emails deactivation_task_report_recipient_emails items
Type: string

Must be at least 1 characters long

root hospital_go_live_date

Hospital Go-Live Date

Type: string

To be of format 'YYYY-mm-dd'. Marks the official go-live date of this hospital. Important for metrics (ie. all data-points before this date are ignored for metrics purposes)

Must be at least 1 characters long

root directoryprofile_provision_limit

DirectoryProfile Provision Limit

Type: integer Default: 5

The maximum allowed active/provisioned DirectoryProfile users for this Hospital.

root administrator_provision_limit

Administrator Provision Limit

Type: integer Default: 1

The maximum allowed active Administrators for this Hospital.

root billing_start_date

Billing Start Date

Type: string

First Day of the hospital's subscription plan. To be of format 'YYYY-mm-dd'

Must be at least 1 characters long

root billing_end_date

Billing End Date

Type: string

Last Day of the hospital's subscription plan. To be of format 'YYYY-mm-dd'

Must be at least 1 characters long

root user_contact_fields

User Contact Fields

Type: array of enum (of string)

Contact Fields that the DirectoryProfiles of this hospital will use. Choices limited to - email, phone

All items must be unique

No Additional Items

Each item of this array must be:

root user_contact_fields user_contact_fields items
Type: enum (of string)

Must be one of:

  • "email"
  • "phone"

root admin_contact_fields

Admin Contact Fields

Type: array of enum (of string)

Contact Fields that the Administrators of this hospital will use. Choices limited to - email, phone

All items must be unique

No Additional Items

Each item of this array must be:

root admin_contact_fields admin_contact_fields items
Type: enum (of string)

Must be one of:

  • "email"
  • "phone"

root profile_filter_options

Profile Filter Options

Type: object

Filter options for frontend when displaying Hospital profiles.

 No Additional Properties

root profile_filter_options designations

Designations

Type: array of string

List of designations for filtering. Defaults to [Associate Consultant, Consultant, House Officer, Senior Associate, Staff Nurse].

All items must be unique

No Additional Items

Each item of this array must be:

root profile_filter_options designations designations items
Type: string

Must be at least 1 characters long

root profile_filter_options include_existing_designations

Include Existing Designations

Type: boolean

If true, existing designations of profiles will be appended to the above designations list. The results are unique-fied case-insensitively. Defaults to true.

root profile_filter_options departments

Departments

Type: array of string

List of departments for filtering. Defaults to [].

All items must be unique

No Additional Items

Each item of this array must be:

root profile_filter_options departments departments items
Type: string

Must be at least 1 characters long

root profile_filter_options include_existing_departments

Include Existing Departments

Type: boolean

If true, existing departments of profiles will be appended to the above departments list. The results are unique-fied case-insensitively. Defaults to true.

root custom_modules
Type: object

Additional Properties of any type are allowed.

root custom_modules additionalProperties
Type: object