Hospital.api_settings stores the credentials and information required to communicate with Hospital API (via the HospitalAPI class). This is not exposed to the frontend and is dependent on the hospital.
Settings for connecting to NUHS API. This is managed by GCTO.
No Additional PropertiesURL for the API.
API key for authorization
Must be at least 1 characters long
Whether to include internal users.
Settings to user xlsx file as API provider.
No Additional PropertiesURL for xlsx file
Sheet number to parse
No Additional ItemsSchema of the API provider
Whether to include internal users.
Settings for using any Airtable as a directory API.
No Additional Propertiesairtable:// URL.
^airtable\:\/\/[a-zA-Z0-9]+\/.+$
Airtable column name for identifiable information. Example: Phone, E-mail
Must be at least 1 characters long
Type of identifiable information. Defaults to phone.
Additional settings that can be added to users authorized via this API.
Additional Properties of any type are allowed.
Type: objectSettings for Google Sheet as API provider.
No Additional PropertiesURL for Google Sheet
Schema of the API provider
Type of identifiable information. It can be set as email or phone
Whether to include internal users.
Settings for the InternalUsersAPI.
airtable:// URL.
^airtable\:\/\/[a-zA-Z0-9]+\/.+$
Airtable column name for identifiable information. Example: Phone, E-mail
Must be at least 1 characters long
Type of identifiable information. Defaults to phone.
Additional settings that can be added to users authorized via this API.
No Additional PropertiesConfig in JSON to store modules config such as reminder times.
Additional Properties of any type are allowed.
Type: objectNotifications related profile settings.
No Additional PropertiesA unique list of notification keys that the user opted out from.
All items must be unique
No Additional ItemsThese types are unique throughout the Bot MD ecosystem. These keys are used in the user's Profile.settings.notifications.deactivated[] to identify the notifications that they have deactivated.
Messages from Bot. This is the default is no delivery_by is specified.
"bot"
Alerts
Specific value:"alert"
Email Notification to Admin / User (eg. User License limit, activation, expiry, etc.)
Specific value:"email_notification"
Broadcast to hospital
Specific value:"broadcast"
Profile related reminder (eg. profile creation, activation, expiry, etc).
Specific value:"profile_reminder"
Temperature reminder for Singapore hospitals.
Specific value:"temperature_reminder"
ART reminder for Singapore hospitals.
Specific value:"art_reminder"
ED Roster Updates used by TTSH Emergency Department.
Specific value:"ed_roster"
Mental Health bot for TTSH.
Specific value:"emobot"
Mood Log Reminder for TTSH Mental Health Module (2024)
Specific value:"moodlog_reminder"
ECG Updates used by TTSH Emergency Department.
Specific value:"ecg"
Arise/PSP used by Roche.
Specific value:"arise_psp"
Emobot related profile settings.
No Additional PropertiesHow would you like EmoBot to address you?
Must be at least 1 characters long
Frequency of reminder. E.g. "Weekly", "Twice Weekly" etc.
Time the reminder will be sent, e.g., "09:00", "18:00" etc.
Must match regular expression:^[0-2]\d\:[0-5]\d$
Used internally to determine when the user was last sent a reminder. This is a Posix timestamp.
Value must be greater or equal to 0
Where does the user derive their emotional sources of strengths.
No Additional ItemsPretty human readable label for this source of strength
Whether this source is selected.
Used internally to keep track of the state of a user's chat with emobot. Backend use only.
The current chat state ID.
User's emotion based on what they say.
No. of venting messages we've received.
Current "Thinking trap" as part of the CBT flow.
Array of feelings of user when going through the CBT flow.
No Additional ItemsISO formatted datetime of when the state was last updated.
Additional Properties of any type are allowed.
Type: objectMetadata related to CGH 2FA
No Additional PropertiesThe user has verified his/her 2FA code.
Encrypted phone number of user.
The user received the notification for expiry
Sync user list
No Additional PropertiesSync hospital profiles using HospitalAPI. Enabling this flag will sync user's hospital profile with hospital API as well as log user out if user no longer found in the API.
Sync directory profiles using latest file in s3. Enabling this flag will add/update/expire directory profile based on the information in file.
URL for file. This file will be sync against directory profiles daily.
URL for S3 Bucket. All the file uploaded from mastermind will be store in the s3 bucket. Lastest file in the bucket will be sync against directory profiles daily.