Home Schema Example JSON Schema

Settings

Type: object

Hospital.settings are used to store settings related to the hospital. This field will be exposed to the Frontend.

 No Additional Properties

root beta_programs

Beta Programs

Type: array of string

Beta Programs that this hospital is running

 No Additional Items

Each item of this array must be:

root beta_programs beta_programs items
Type: string

Must be at least 1 characters long

root organization_key

Organization key

Type: object

This is to denote the organization key used on Chatterbox and by legacy Hippocrates. This key will be included in the ProfileTags.schema as well.

root organization_key anyOf Alexandra

Alexandra

Type: const

Alexandra Hospital

Specific value: "alexandra"
root organization_key anyOf AHI

AHI

Type: const

Association of Healthtech Indonesia

Specific value: "ahi"
root organization_key anyOf Digihealth

Digihealth

Type: const

Digihealth

Specific value: "digihealth"
root organization_key anyOf Bot MD Demo Hospital

Bot MD Demo Hospital

Type: const

Bot MD Demo Hospital for our internal testing purposes.

Specific value: "bdh"
root organization_key anyOf CGH

CGH

Type: const

Changi General Hospital

Specific value: "cgh"
root organization_key anyOf Cleo

Cleo

Type: const

All cleo dialogues are nested under this hospital. Permissions to different clinics are separated by tags of the form cleo:<domain>.

Specific value: "cleo"
root organization_key anyOf Dharmais

Dharmais

Type: const

Rumah Sakit Kanker Dharmais

Specific value: "dharmais"
root organization_key anyOf Fleming Hospital

Fleming Hospital

Type: const

Fleming Hospital is our hospital for public users.

Specific value: "fleminghospital"
root organization_key anyOf Bot MD

Bot MD

Type: const

Bot MD.

Specific value: "botmd"
root organization_key anyOf Bot MD ID Web

Bot MD ID Web

Type: const

Bot MD ID Demo Web

Specific value: "botmd_id_web"
root organization_key anyOf EB Medicine Demo

EB Medicine Demo

Type: const

EB Medicine Demo

Specific value: "eb_medicine"
root organization_key anyOf Faithful Empire

Faithful Empire

Type: const

Faithful Empire Webbot

Specific value: "faithful_empire_web"
root organization_key anyOf Harapan Kita

Harapan Kita

Type: const

Pusat Jantung Nasional Harapan Kita

Specific value: "pjnhk"
root organization_key anyOf ICC

ICC

Type: const

Icon Cancer Centre

Specific value: "icc"
root organization_key anyOf IDI

IDI

Type: const

Indonesian Medical Association

Specific value: "idi"
root organization_key anyOf IDI Web

IDI Web

Type: const

Indonesian Medical Association Web

Specific value: "idi_web"
root organization_key anyOf IDI Whatsapp

IDI Whatsapp

Type: const

Indonesian Medical Association Whatsapp

Specific value: "idi_whatsapp"
root organization_key anyOf Iskandar Demo

Iskandar Demo

Type: enum (of string)

Iskandar demo project.

Must be one of:

  • "iskandar_demo"
  • "iskandar"
root organization_key anyOf Indonesia Care

Indonesia Care

Type: const

Indonesia care

Specific value: "indonesia_care"
root organization_key anyOf Indonesia Hospital

Indonesia Hospital

Type: const

Indonesia hospital

Specific value: "indonesia_hospital"
root organization_key anyOf Klinik In Harmony

Klinik In Harmony

Type: const

Klinik In Harmony

Specific value: "inharmony"
root organization_key anyOf KONSULTAMD

KONSULTAMD

Type: const

Konsulta MD

Specific value: "konsultamd"
root organization_key anyOf KKWCH

KKWCH

Type: const

KK Women's and Children's Hospital

Specific value: "kkwch"
root organization_key anyOf KTPH

KTPH

Type: const

Khoo Teck Puat Hospital

Specific value: "ktph"
root organization_key anyOf MOH Singapore

MOH Singapore

Type: const

Ministry of Health (Singapore)

Specific value: "moh_sg"
root organization_key anyOf National Hospital

National Hospital

Type: const

National Hospital

Specific value: "nationalhospital"
root organization_key anyOf NCCS

NCCS

Type: const

National Cancer Centre Singapore

Specific value: "nccs"
root organization_key anyOf NCIS

NCIS

Type: const

National University Cancer Institute Singapore

Specific value: "ncis"
root organization_key anyOf NCIS Engage

NCIS Engage

Type: const

NCIS Engage

Specific value: "ncis_engage"
root organization_key anyOf NCIS Engage Web

NCIS Engage Web

Type: const

NCIS Engage Web

Specific value: "ncis_engage_web"
root organization_key anyOf NEMG

NEMG

Type: const

Northeast Medical Group

Specific value: "nemg"
root organization_key anyOf NEMG WEB

NEMG WEB

Type: const

NEMG WEB

Specific value: "nemg_web"
root organization_key anyOf NKTI

NKTI

Type: const

National Kidney Transplant Institute

Specific value: "nkti"
root organization_key anyOf NTFGH

NTFGH

Type: const

Ng Teng Fong General Hospital

Specific value: "ntfgh"
root organization_key anyOf NUHS

NUHS

Type: const

National University Health System

Specific value: "nuhs"
root organization_key anyOf NUH

NUH

Type: const

National University Hospital

Specific value: "nuh"
root organization_key anyOf NUS Med

NUS Med

Type: const

NUS School of Medicine

Specific value: "nus_med"
root organization_key anyOf Parkway Radiology

Parkway Radiology

Type: const

Parkway Radiology

Specific value: "parkwayradio"
root organization_key anyOf Philippine General Hospital

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "pgh"
root organization_key anyOf Prodia Demo

Prodia Demo

Type: const

Prodia Demo

Specific value: "prodia_demo"
root organization_key anyOf PPhA

PPhA

Type: const

Philippine Pharmacists Association, Inc

Specific value: "ppha"
root organization_key anyOf Roche Singapore

Roche Singapore

Type: const

Roche Singapore

Specific value: "roche"
root organization_key anyOf Roche Brunei

Roche Brunei

Type: const

Roche Brunei

Specific value: "roche_brunei"
root organization_key anyOf Roche HCP

Roche HCP

Type: const

Roche HCP is the public bot hosted on https://roche.com.sg

Specific value: "roche_hcp"
root organization_key anyOf Roche HCP Private

Roche HCP Private

Type: const

Roche HCP Private is the private bot hosted on https://roche.com.sg

Specific value: "roche_hcp_private"
root organization_key anyOf Philippine General Hospital

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "upcm"
root organization_key anyOf Sanglah

Sanglah

Type: const

Sanglah General Hospital

Specific value: "sanglah"
root organization_key anyOf SGH

SGH

Type: const

Singapore General Hospital

Specific value: "sgh"
root organization_key anyOf SKH

SKH

Type: const

Sengkang General Hospital

Specific value: "skh"
root organization_key anyOf SingHealth

SingHealth

Type: const

SingHealth

Specific value: "singhealth"
root organization_key anyOf Siloam Hospitals

Siloam Hospitals

Type: const

Siloam Hospitals

Specific value: "siloam"
root organization_key anyOf Speedoc

Speedoc

Type: const

Speedoc

Specific value: "speedoc"
root organization_key anyOf Stanford

Stanford

Type: const

Stanford Health Care

Specific value: "stanford"
root organization_key anyOf Sunway

Sunway

Type: const

Sunway

Specific value: "sunway"
root organization_key anyOf TTSH

TTSH

Type: const

Tan Tock Seng Hospital

Specific value: "ttsh"
root organization_key anyOf Ultravioleta

Ultravioleta

Type: const

Ultravioleta hospital

Specific value: "ultravioleta"
root organization_key anyOf UPCM

UPCM

Type: object

College of Medicine - University of the Philippines Manila

root active_heimdall_provider

Active Heimdall Provider

Type: string

Heimdall Provider UID that this hospital will login using

Must be at least 1 characters long

root datetime_format

Datetime Format

Type: string

Format date/time using this Python strftime style format. Defaults to ISO-8601 format.

Must be at least 1 characters long

root domain_root

Domain Root

Type: string

The domain rppt (eg. botmd.io, botmd.sg) of the hospital. Used to alter all API endpoints for the specified hospital. Defaults to botmd.io.

Must be at least 1 characters long

root timezone

Timezone

Type: string

Default timezone to assume for patients, clinicians in this clinic. This is publicly available to frontend via cleoClinicPublicSettings endpoint. Defaults to UTC.

Must be at least 1 characters long

root einstein

Einstein

Type: object

Einstein specific settings.

 No Additional Properties

root einstein activation_email_reminder_intervals_days
Type: object

root einstein 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 einstein activation_email_reminder_intervals_days designations designations items
Type: integer

Value must be greater or equal to 1

root einstein 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 einstein usage_report_recipient_emails usage_report_recipient_emails items
Type: string

Must be at least 1 characters long

root einstein 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 einstein deactivation_task_report_recipient_emails deactivation_task_report_recipient_emails items
Type: string

Must be at least 1 characters long

root einstein 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 einstein directoryprofile_provision_limit

DirectoryProfile Provision Limit

Type: integer Default: 5

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

root einstein administrator_provision_limit

Administrator Provision Limit

Type: integer Default: 1

The maximum allowed active Administrators for this Hospital.

root einstein 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 einstein 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 einstein 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 einstein user_contact_fields user_contact_fields items
Type: enum (of string)

Must be one of:

  • "email"
  • "phone"

root einstein 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 einstein admin_contact_fields admin_contact_fields items
Type: enum (of string)

Must be one of:

  • "email"
  • "phone"

root einstein profile_filter_options

Profile Filter Options

Type: object

Filter options for frontend when displaying Hospital profiles.

 No Additional Properties

root einstein 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 einstein profile_filter_options designations designations items
Type: string

Must be at least 1 characters long

root einstein 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 einstein 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 einstein profile_filter_options departments departments items
Type: string

Must be at least 1 characters long

root einstein 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 einstein custom_modules
Type: object

Additional Properties of any type are allowed.

root einstein custom_modules additionalProperties
Type: object

root jarvis_v2_assistants

Jarvis V2 Assistant settings

Type: object

Hospital assistant-specific configs are stored here. If hospital has J2 enabled and this is not provided, default values will be used

root jarvis_v2_assistants @documents

Jarvis V2 Assistant

Type: object

Jarvis V2 Assistant metadata

root jarvis_v2_assistants @documents enabled

Is enabled

Type: boolean Default: true

True iff this assistant is available for use. True by default

root jarvis_v2_assistants @documents query_engine_settings_path

LLM Query Engine Settings YAML path

Type: string

Kondo Resources path to LLM Query Engine Settings YAML. Backend should have hardcoded defaults if not provided

Must be at least 1 characters long

root jarvis_v2_assistants @directory

Jarvis V2 Assistant

Type: object

Jarvis V2 Assistant metadata

Same definition as @documents

root jarvis_v2_assistants @trials

Jarvis V2 Assistant

Type: object

Jarvis V2 Assistant metadata

Same definition as @documents

root guest_hospital

Is Guest Hospital?

Type: boolean

Mark this hospital as a guest hospital. There can only be one.

root max_web_devices

Maximum active devices per profile for a web channel

Type: number

Only the number of most recent active web devices will be kept upon registering new web device

Value must be greater or equal to 1

root public_profile_uid

Public Profile UID

Type: string

Default hospital profile uid for public session. Setting this will also allow this hospital to be used with PublicServiceProvider for authorization flow.

root legacy

Legacy Account User Config (Deprecated)

Type: object

Config in JSON to store modules config such as reminder times.

Additional Properties of any type are allowed.

root legacy additionalProperties
Type: object

root notifications

Notifications

Type: object

Notifications related hospital settings.

 No Additional Properties

root notifications available

Available Notifications.

Type: array of object

A list of notification types that are available in the hospital.

All items must be unique

No Additional Items

Each item of this array must be:

root notifications available available items
Type: object

root notifications available available items key

Key

Type: object

These keys uniquely identify the notification type. When storing in Profile.settings.notifications.deactivated[], these keys should be used.

root notifications available available items key anyOf Bot

Bot

Type: const

Messages from Bot. This is the default is no delivery_by is specified.

Specific value: "bot"
root notifications available available items key anyOf Alert

Alert

Type: const

Alerts

Specific value: "alert"
root notifications available available items key anyOf Email Notification

Email Notification

Type: const

Email Notification to Admin / User (eg. User License limit, activation, expiry, etc.)

Specific value: "email_notification"
root notifications available available items key anyOf Broadcast

Broadcast

Type: const

Broadcast to hospital

Specific value: "broadcast"
root notifications available available items key anyOf Profile Reminder

Profile Reminder

Type: const

Profile related reminder (eg. profile creation, activation, expiry, etc).

Specific value: "profile_reminder"
root notifications available available items key anyOf Temperature Reminder

Temperature Reminder

Type: const

Temperature reminder for Singapore hospitals.

Specific value: "temperature_reminder"
root notifications available available items key anyOf ART Reminder

ART Reminder

Type: const

ART reminder for Singapore hospitals.

Specific value: "art_reminder"
root notifications available available items key anyOf ED

ED

Type: const

ED Roster Updates used by TTSH Emergency Department.

Specific value: "ed_roster"
root notifications available available items key anyOf Mental Health

Mental Health

Type: const

Mental Health bot for TTSH.

Specific value: "emobot"
root notifications available available items key anyOf Mood Log Reminder

Mood Log Reminder

Type: const

Mood Log Reminder for TTSH Mental Health Module (2024)

Specific value: "moodlog_reminder"
root notifications available available items key anyOf ECG

ECG

Type: const

ECG Updates used by TTSH Emergency Department.

Specific value: "ecg"
root notifications available available items key anyOf Arise

Arise

Type: const

Arise/PSP used by Roche.

Specific value: "arise_psp"

root notifications available available items name

Name

Type: string

This notification name will be displayed in the notifications screen on the frontend.

Must be at least 1 characters long