Schema for Einstein Settings

From Settings.schema.yaml (einstein/Settings.schema)

---
$id: https://skeleton.botmd.io/einstein/Settings.schema
$schema: http://json-schema.org/draft-07/schema#

title: Settings
description: >-
  Settings related to the einstein are stored in the respective `Hospital.settings` under the `einstein` field.
  This field **will be exposed** to the Frontend.

type: object

required: []
additionalProperties: false

properties:
  activation_email_reminder_intervals_days:
    properties:
      designations:
        title: Designations
        description: List of day intervals to send the activation email notifications to users (ie. 7 days after activation, 14 days, etc.)
        type: array
        uniqueItems: true
        items:
          type: integer
          minimum: 1

  usage_report_recipient_emails:
    title: List of emails to send Usage Reports to
    description: List of emails to send regular Usage Reports to. If empty or missing, then we will not send any usage reports.
    type: array

    uniqueItems: true
    items:
      type: string
      minLength: 1

  deactivation_task_report_recipient_emails:
    title: List of emails to send Deactivation task report emails to
    description: List of emails to send regular task Deactivation Reports to. If empty or missing, then we will not send any deactivation task reports.
    type: array

    uniqueItems: true
    items:
      type: string
      minLength: 1

  hospital_go_live_date:
    title: Hospital Go-Live Date
    description: 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)
    type: string
    minLength: 1

  directoryprofile_provision_limit:
    title: DirectoryProfile Provision Limit
    description: The maximum allowed active/provisioned DirectoryProfile users for this Hospital.
    type: integer
    default: 5

  administrator_provision_limit:
    title: Administrator Provision Limit
    description: The maximum allowed active Administrators for this Hospital.
    type: integer
    default: 1

  billing_start_date:
    title: Billing Start Date
    description: First Day of the hospital's subscription plan. To be of format 'YYYY-mm-dd'
    type: string
    minLength: 1

  billing_end_date:
    title: Billing End Date
    description: Last Day of the hospital's subscription plan. To be of format 'YYYY-mm-dd'
    type: string
    minLength: 1

  user_contact_fields:
    title: User Contact Fields
    description: Contact Fields that the DirectoryProfiles of this hospital will use. Choices limited to - email, phone
    type: array

    uniqueItems: true
    items:
      enum: [email, phone]

  admin_contact_fields:
    title: Admin Contact Fields
    description: Contact Fields that the Administrators of this hospital will use. Choices limited to - email, phone
    type: array

    uniqueItems: true
    items:
      enum: [email, phone]

  profile_filter_options:
    title: Profile Filter Options
    description: Filter options for frontend when displaying Hospital profiles.
    type: object

    required: []
    additionalProperties: false
    properties:
      designations:
        title: Designations
        description: List of designations for filtering. Defaults to `[Associate Consultant, Consultant, House Officer, Senior Associate, Staff Nurse]`.
        type: array

        uniqueItems: true
        items:
          type: string
          minLength: 1
      #end designations

      include_existing_designations:
        title: Include Existing Designations
        description: If `true`, existing designations of profiles will be appended to the above `designations` list. The results are unique-fied case-insensitively. Defaults to `true`.
        type: boolean
      #end include_existing_designations

      departments:
        title: Departments
        description: List of departments for filtering. Defaults to `[]`.
        type: array

        uniqueItems: true
        items:
          type: string
          minLength: 1
      #end departments

      include_existing_departments:
        title: Include Existing Departments
        description: If `true`, existing departments of profiles will be appended to the above `departments` list. The results are unique-fied case-insensitively. Defaults to `true`.
        type: boolean
      #end include_existing_departments
    #end properties
  #end profile_filter_options
  custom_modules:
    type: object
    additionalProperties: true
  #end custom_modules
#end property

[Main Page] [Schema Documentation] [Examples]