Home Schema Example JSON Schema

Permissions

Type: object

Hospital application specific permissions. This is also known as ACL in Jarvis.

root stream_response

Stream Response

Type: boolean

Allow the content to be streamed directly from Hippocrates instead of a redirect. Use sparingly and with care. Defaults to false.

root hospitals

Hospitals

Type: array

Array of Hospital keys that will have access to the resource. Defaults to allow any hospital if not specified. Empty array (i.e., []) will deny all access.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Tuple Validation

Item at 1 must be:
root hospitals Organization Keys

Organization Keys

Type: object

List of organization keys that double up as tags. These tags are for access control at the hospital and organizational level.

root hospitals Organization Keys anyOf Alexandra

Alexandra

Type: const

Alexandra Hospital

Specific value: "alexandra"
root hospitals Organization Keys anyOf AHI

AHI

Type: const

Association of Healthtech Indonesia

Specific value: "ahi"
root hospitals Organization Keys anyOf Digihealth

Digihealth

Type: const

Digihealth

Specific value: "digihealth"
root hospitals Organization Keys anyOf Bot MD Demo Hospital

Bot MD Demo Hospital

Type: const

Bot MD Demo Hospital for our internal testing purposes.

Specific value: "bdh"
root hospitals Organization Keys anyOf CGH

CGH

Type: const

Changi General Hospital

Specific value: "cgh"
root hospitals Organization Keys 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 hospitals Organization Keys anyOf Dharmais

Dharmais

Type: const

Rumah Sakit Kanker Dharmais

Specific value: "dharmais"
root hospitals Organization Keys anyOf Fleming Hospital

Fleming Hospital

Type: const

Fleming Hospital is our hospital for public users.

Specific value: "fleminghospital"
root hospitals Organization Keys anyOf Bot MD

Bot MD

Type: const

Bot MD.

Specific value: "botmd"
root hospitals Organization Keys anyOf Bot MD ID Web

Bot MD ID Web

Type: const

Bot MD ID Demo Web

Specific value: "botmd_id_web"
root hospitals Organization Keys anyOf EB Medicine Demo

EB Medicine Demo

Type: const

EB Medicine Demo

Specific value: "eb_medicine"
root hospitals Organization Keys anyOf Faithful Empire

Faithful Empire

Type: const

Faithful Empire Webbot

Specific value: "faithful_empire_web"
root hospitals Organization Keys anyOf Harapan Kita

Harapan Kita

Type: const

Pusat Jantung Nasional Harapan Kita

Specific value: "pjnhk"
root hospitals Organization Keys anyOf ICC

ICC

Type: const

Icon Cancer Centre

Specific value: "icc"
root hospitals Organization Keys anyOf IDI

IDI

Type: const

Indonesian Medical Association

Specific value: "idi"
root hospitals Organization Keys anyOf IDI Web

IDI Web

Type: const

Indonesian Medical Association Web

Specific value: "idi_web"
root hospitals Organization Keys anyOf IDI Whatsapp

IDI Whatsapp

Type: const

Indonesian Medical Association Whatsapp

Specific value: "idi_whatsapp"
root hospitals Organization Keys anyOf Iskandar Demo

Iskandar Demo

Type: enum (of string)

Iskandar demo project.

Must be one of:

  • "iskandar_demo"
  • "iskandar"
root hospitals Organization Keys anyOf Indonesia Care

Indonesia Care

Type: const

Indonesia care

Specific value: "indonesia_care"
root hospitals Organization Keys anyOf Indonesia Hospital

Indonesia Hospital

Type: const

Indonesia hospital

Specific value: "indonesia_hospital"
root hospitals Organization Keys anyOf Klinik In Harmony

Klinik In Harmony

Type: const

Klinik In Harmony

Specific value: "inharmony"
root hospitals Organization Keys anyOf KONSULTAMD

KONSULTAMD

Type: const

Konsulta MD

Specific value: "konsultamd"
root hospitals Organization Keys anyOf KKWCH

KKWCH

Type: const

KK Women's and Children's Hospital

Specific value: "kkwch"
root hospitals Organization Keys anyOf KTPH

KTPH

Type: const

Khoo Teck Puat Hospital

Specific value: "ktph"
root hospitals Organization Keys anyOf MOH Singapore

MOH Singapore

Type: const

Ministry of Health (Singapore)

Specific value: "moh_sg"
root hospitals Organization Keys anyOf National Hospital

National Hospital

Type: const

National Hospital

Specific value: "nationalhospital"
root hospitals Organization Keys anyOf NCCS

NCCS

Type: const

National Cancer Centre Singapore

Specific value: "nccs"
root hospitals Organization Keys anyOf NCIS

NCIS

Type: const

National University Cancer Institute Singapore

Specific value: "ncis"
root hospitals Organization Keys anyOf NCIS Engage

NCIS Engage

Type: const

NCIS Engage

Specific value: "ncis_engage"
root hospitals Organization Keys anyOf NCIS Engage Web

NCIS Engage Web

Type: const

NCIS Engage Web

Specific value: "ncis_engage_web"
root hospitals Organization Keys anyOf NEMG

NEMG

Type: const

Northeast Medical Group

Specific value: "nemg"
root hospitals Organization Keys anyOf NEMG WEB

NEMG WEB

Type: const

NEMG WEB

Specific value: "nemg_web"
root hospitals Organization Keys anyOf NKTI

NKTI

Type: const

National Kidney Transplant Institute

Specific value: "nkti"
root hospitals Organization Keys anyOf NTFGH

NTFGH

Type: const

Ng Teng Fong General Hospital

Specific value: "ntfgh"
root hospitals Organization Keys anyOf NUHS

NUHS

Type: const

National University Health System

Specific value: "nuhs"
root hospitals Organization Keys anyOf NUH

NUH

Type: const

National University Hospital

Specific value: "nuh"
root hospitals Organization Keys anyOf NUS Med

NUS Med

Type: const

NUS School of Medicine

Specific value: "nus_med"
root hospitals Organization Keys anyOf Parkway Radiology

Parkway Radiology

Type: const

Parkway Radiology

Specific value: "parkwayradio"
root hospitals Organization Keys anyOf Philippine General Hospital

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "pgh"
root hospitals Organization Keys anyOf Prodia Demo

Prodia Demo

Type: const

Prodia Demo

Specific value: "prodia_demo"
root hospitals Organization Keys anyOf PPhA

PPhA

Type: const

Philippine Pharmacists Association, Inc

Specific value: "ppha"
root hospitals Organization Keys anyOf Roche Singapore

Roche Singapore

Type: const

Roche Singapore

Specific value: "roche"
root hospitals Organization Keys anyOf Roche Brunei

Roche Brunei

Type: const

Roche Brunei

Specific value: "roche_brunei"
root hospitals Organization Keys anyOf Roche HCP

Roche HCP

Type: const

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

Specific value: "roche_hcp"
root hospitals Organization Keys 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 hospitals Organization Keys anyOf Philippine General Hospital

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "upcm"
root hospitals Organization Keys anyOf Sanglah

Sanglah

Type: const

Sanglah General Hospital

Specific value: "sanglah"
root hospitals Organization Keys anyOf SGH

SGH

Type: const

Singapore General Hospital

Specific value: "sgh"
root hospitals Organization Keys anyOf SKH

SKH

Type: const

Sengkang General Hospital

Specific value: "skh"
root hospitals Organization Keys anyOf SingHealth

SingHealth

Type: const

SingHealth

Specific value: "singhealth"
root hospitals Organization Keys anyOf Siloam Hospitals

Siloam Hospitals

Type: const

Siloam Hospitals

Specific value: "siloam"
root hospitals Organization Keys anyOf Speedoc

Speedoc

Type: const

Speedoc

Specific value: "speedoc"
root hospitals Organization Keys anyOf Stanford

Stanford

Type: const

Stanford Health Care

Specific value: "stanford"
root hospitals Organization Keys anyOf Sunway

Sunway

Type: const

Sunway

Specific value: "sunway"
root hospitals Organization Keys anyOf TTSH

TTSH

Type: const

Tan Tock Seng Hospital

Specific value: "ttsh"
root hospitals Organization Keys anyOf Ultravioleta

Ultravioleta

Type: const

Ultravioleta hospital

Specific value: "ultravioleta"
root hospitals Organization Keys anyOf UPCM

UPCM

Type: object

College of Medicine - University of the Philippines Manila

root tags

Tags

Type: array

Array of profile tags that will have access to the resource. Defaults to allow any tag if not specified. Empty array (i.e., []) will deny all access.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root tags tags items

root tags tags items anyOf Accessible Tags

Accessible Tags

Type: object

Tags for controlling access to information. These tags are for gating at the module level and unaffilated with any hospital or organizations.

root tags tags items anyOf Accessible Tags anyOf AHFS

AHFS

Type: const

Profile can access AHFS DI monographs.

Specific value: "AHFS_accessible"
root tags tags items anyOf Accessible Tags anyOf Calculators

Calculators

Type: const

Profile can access calculators.

Specific value: "calculators_accessible"
root tags tags items anyOf Accessible Tags anyOf EB Medicine

EB Medicine

Type: const

Profile can access EB medicine module.

Specific value: "ebmedicine_accessible"
root tags tags items anyOf Accessible Tags anyOf Guidelines

Guidelines

Type: const

Profile can access guidelines module.

Specific value: "guidelines_accessible"
root tags tags items anyOf Accessible Tags anyOf Sanford

Sanford

Type: const

Profile can access Sanford module.

Specific value: "Sanford_accessible"
root tags tags items anyOf Accessible Tags anyOf NCIS ChemoCalc

NCIS ChemoCalc

Type: const

Profile can access NCIS chemocalc module.

Specific value: "ncis_chemocalc_accessible"
root tags tags items anyOf Accessible Tags anyOf UpToDate

UpToDate

Type: const

Profile can access Uptodate module.

Specific value: "Uptodate_accessible"
root tags tags items anyOf Accessible Tags anyOf Mediview

Mediview

Type: const

Profile can access Mediview module.

Specific value: "Mediview_accessible"
root tags tags items anyOf Accessible Tags anyOf MIMS

MIMS

Type: const

Profile can access MIMS monographs.

Specific value: "MIMS_accessible"
root tags tags items anyOf Bot MD Tags

Bot MD Tags

Type: object

Our internal tags for managing users. Usually used for testing and billing purposes.

root tags tags items anyOf Bot MD Tags anyOf Internal User

Internal User

Type: const

This profile belongs to an internal user.

Specific value: "botmd:internal"
root tags tags items anyOf Bot MD Tags anyOf Jarvis

Jarvis

Type: const

Users with this tag will be redirected to Jarvis instead.

Specific value: "botmd:jarvis"
root tags tags items anyOf Bot MD Tags anyOf Jarvis V2

Jarvis V2

Type: const

Users with this tag will be redirected to Jarvis v2 for certain queries.

Specific value: "botmd:jarvisv2"
root tags tags items anyOf Bot MD Tags anyOf Test

Test

Type: const

This tag is used for testing purpose (e.g., unit tests).

Specific value: "botmd:testtag"
root tags tags items anyOf Bot MD Tags anyOf Documents Beta

Documents Beta

Type: const

This profile is on the waitlist for the documents Beta programme

Specific value: "botmd:beta-documents-waitlist"
root tags tags items anyOf Bot MD Tags anyOf Documents Beta

Documents Beta

Type: const

This profile is enrolled onto the documents Beta programme

Specific value: "botmd:beta-documents"
root tags tags items anyOf Bot MD Tags anyOf Directory Assistant

Directory Assistant

Type: const

This profile has access to the directory Jarvis V2 assistant

Specific value: "botmd:assistant-directory"
root tags tags items anyOf Organization Keys

Organization Keys

Type: object

List of organization keys that double up as tags. These tags are for access control at the hospital and organizational level.

Same definition as Organization Keys
root tags tags items anyOf Department Tags

Department Tags

Type: object

List of departments we count as tags.

root tags tags items anyOf Department Tags anyOf BDH

BDH

Type: string

This represents demo-groups within BDH (e.g. bdh_upcn, bdh_healthway, etc)

Must match regular expression: ^bdh\_\w+$
root tags tags items anyOf Department Tags anyOf CGH

CGH

Type: string

This represents departments, services, or content-groups within CGH (e.g. cgh_rccm, cgh_edgeri, etc)

Must match regular expression: ^cgh\_\w+$
root tags tags items anyOf Department Tags anyOf Cleo

Cleo

Type: string

This separates various clinics within Cleo using their domain.

Must match regular expression: ^cleo\:\w+$
root tags tags items anyOf Department Tags anyOf KKWCH

KKWCH

Type: string

This represents departments, services, or content-groups within KKWCH (e.g. kkwch_rccm, kkwch_edgeri, etc)

Must match regular expression: ^kkwch\_\w+$
root tags tags items anyOf Department Tags anyOf NCIS

NCIS

Type: string

This represents departments, services, or content-groups within NCIS (e.g. ncis_rccm etc)

Must match regular expression: ^ncis\_\w+$
root tags tags items anyOf Department Tags anyOf NTFGH

NTFGH

Type: string

This represents departments, services, or content-groups within NTFGH (e.g. ntfgh_rccm, ntfgh_edgeri, etc)

Must match regular expression: ^ntfgh\_\w+$
root tags tags items anyOf Department Tags anyOf NUHS

NUHS

Type: string

This represents departments, services, or content-groups within NUHS (e.g. nuhs_rccm, nuhs_edgeri, etc)

Must match regular expression: ^nuhs\_\w+$
root tags tags items anyOf Department Tags anyOf NUH

NUH

Type: string

This represents departments, services, or content-groups within NUH (e.g. nuh_rccm, nuh_edgeri, etc)

Must match regular expression: ^nuh\_\w+$
root tags tags items anyOf Department Tags anyOf Alexandra

Alexandra

Type: string

This represents departments, services, or content-groups within AH (e.g. alexandra_rccm, alexandra_edgeri, etc)

Must match regular expression: ^alexandra\_\w+$
root tags tags items anyOf Department Tags anyOf SKH

SKH

Type: string

This represents departments, services, or content-groups within SKH (e.g. skh_rccm, skh_edgeri, etc)

Must match regular expression: ^skh\_\w+$
root tags tags items anyOf Department Tags anyOf TTSH

TTSH

Type: string

This represents departments, services, or content-groups within TTSH (e.g. ttsh_rccm, ttsh_edgeri, etc)

Must match regular expression: ^ttsh\_\w+$
root tags tags items anyOf Department Tags anyOf National University Polyclinics (Deprecated)

National University Polyclinics (Deprecated)

Type: const

NUHS polyclinics

Specific value: "nupoly"
root tags tags items anyOf Department Tags anyOf Bot MD Philippines

Bot MD Philippines

Type: const

For users in Philippines.

Specific value: "botmdphilippines"

root acl_dnf

ACL DNF

Type: array of string

Array of ACLs in DNF format (OR of ANDs). Defaults to allow any acl_dnf if not specified. Empty array (i.e., []) will deny all access.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root acl_dnf acl_dnf items
Type: string

Must be at least 1 characters long

root restricted_organizations

Restricted Organizations

Type: array of string

For legacy use.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root restricted_organizations restricted_organizations items
Type: string

Must be at least 1 characters long

Additional Properties of any type are allowed.

root additionalProperties
Type: object