Home Schema Example JSON Schema

Application Input


Application inputs are used by Heimdall login frontends for application specific input values.

Empty non-null object/array/string

Type: object

Convenience schema for validating non-null empty data.

Empty array

Type: array

Must contain a maximum of 0 items

No Additional Items

Empty string

Type: const
Specific value: ""

Cleo

Type: object

Application input needed by Cleo heimdall application

No Additional Properties

Type: object

The following properties are required:

  • domain
Type: object

The following properties are required:

  • domain
  • patient_verification_fields
Type: object

The following properties are required:

  • patient_verification_fields

Domain

Type: string

Domain of the clinic. This is used to identify the clinic to create the session for during authorization flow. This is currently used with clinician authorization flows only (i.e., Auth0, Session exchange).

Must be at least 1 characters long

Verification Fields

Type: array of object

An array of verification fields containing key, value pairs of the user's input during patient login.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Key

Type: enum (of string)

Key representing the verification type. See cleo/ClinicSettings.schema for more information.

Must be one of:

  • "identifier"
  • "identifier_last_4"
  • "verification_token"
  • "verification_token_last_4"
  • "phone_e164"
  • "phone_without_country_code"
  • "phone_last_4"

Value

Type: string

Patient input for the corresponding key. When validating on the backend, it is case insensitive and "space" insensitive.

Must be at least 1 characters long

HospitalHeimdallApplication

Type: object

Application input for HospitalHeimdallApplication

No Additional Properties

Allow Guest

Type: boolean Default: false

Boolean that indicates whether guest login is allowed or not.

Organization key

Type: object

If specified, the authorization flow will only check the user’s identifiable information against the specific hospital’s DirectoryProfile and API. Note that this refers to the Hospital.settings['organization_key'].

Alexandra

Type: const

Alexandra Hospital

Specific value: "alexandra"

AHI

Type: const

Association of Healthtech Indonesia

Specific value: "ahi"

Digihealth

Type: const

Digihealth

Specific value: "digihealth"

Bot MD Demo Hospital

Type: const

Bot MD Demo Hospital for our internal testing purposes.

Specific value: "bdh"

CGH

Type: const

Changi General Hospital

Specific value: "cgh"

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"

Dharmais

Type: const

Rumah Sakit Kanker Dharmais

Specific value: "dharmais"

Fleming Hospital

Type: const

Fleming Hospital is our hospital for public users.

Specific value: "fleminghospital"

Bot MD

Type: const

Bot MD.

Specific value: "botmd"

Bot MD ID Web

Type: const

Bot MD ID Demo Web

Specific value: "botmd_id_web"

EB Medicine Demo

Type: const

EB Medicine Demo

Specific value: "eb_medicine"

Faithful Empire

Type: const

Faithful Empire Webbot

Specific value: "faithful_empire_web"

Harapan Kita

Type: const

Pusat Jantung Nasional Harapan Kita

Specific value: "pjnhk"

ICC

Type: const

Icon Cancer Centre

Specific value: "icc"

IDI

Type: const

Indonesian Medical Association

Specific value: "idi"

IDI Web

Type: const

Indonesian Medical Association Web

Specific value: "idi_web"

IDI Whatsapp

Type: const

Indonesian Medical Association Whatsapp

Specific value: "idi_whatsapp"

Iskandar Demo

Type: enum (of string)

Iskandar demo project.

Must be one of:

  • "iskandar_demo"
  • "iskandar"

Indonesia Care

Type: const

Indonesia care

Specific value: "indonesia_care"

Indonesia Hospital

Type: const

Indonesia hospital

Specific value: "indonesia_hospital"

Klinik In Harmony

Type: const

Klinik In Harmony

Specific value: "inharmony"

KONSULTAMD

Type: const

Konsulta MD

Specific value: "konsultamd"

KKWCH

Type: const

KK Women's and Children's Hospital

Specific value: "kkwch"

KTPH

Type: const

Khoo Teck Puat Hospital

Specific value: "ktph"

MOH Singapore

Type: const

Ministry of Health (Singapore)

Specific value: "moh_sg"

National Hospital

Type: const

National Hospital

Specific value: "nationalhospital"

NCCS

Type: const

National Cancer Centre Singapore

Specific value: "nccs"

NCIS

Type: const

National University Cancer Institute Singapore

Specific value: "ncis"

NCIS Engage

Type: const

NCIS Engage

Specific value: "ncis_engage"

NCIS Engage Web

Type: const

NCIS Engage Web

Specific value: "ncis_engage_web"

NEMG

Type: const

Northeast Medical Group

Specific value: "nemg"

NEMG WEB

Type: const

NEMG WEB

Specific value: "nemg_web"

NKTI

Type: const

National Kidney Transplant Institute

Specific value: "nkti"

NTFGH

Type: const

Ng Teng Fong General Hospital

Specific value: "ntfgh"

NUHS

Type: const

National University Health System

Specific value: "nuhs"

NUH

Type: const

National University Hospital

Specific value: "nuh"

NUS Med

Type: const

NUS School of Medicine

Specific value: "nus_med"

Parkway Radiology

Type: const

Parkway Radiology

Specific value: "parkwayradio"

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "pgh"

Prodia Demo

Type: const

Prodia Demo

Specific value: "prodia_demo"

PPhA

Type: const

Philippine Pharmacists Association, Inc

Specific value: "ppha"

Roche Singapore

Type: const

Roche Singapore

Specific value: "roche"

Roche Brunei

Type: const

Roche Brunei

Specific value: "roche_brunei"

Roche HCP

Type: const

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

Specific value: "roche_hcp"

Roche HCP Private

Type: const

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

Specific value: "roche_hcp_private"

Philippine General Hospital

Type: const

Philippine General Hospital

Specific value: "upcm"

Sanglah

Type: const

Sanglah General Hospital

Specific value: "sanglah"

SGH

Type: const

Singapore General Hospital

Specific value: "sgh"

SKH

Type: const

Sengkang General Hospital

Specific value: "skh"

SingHealth

Type: const

SingHealth

Specific value: "singhealth"

Siloam Hospitals

Type: const

Siloam Hospitals

Specific value: "siloam"

Speedoc

Type: const

Speedoc

Specific value: "speedoc"

Stanford

Type: const

Stanford Health Care

Specific value: "stanford"

Sunway

Type: const

Sunway

Specific value: "sunway"

TTSH

Type: const

Tan Tock Seng Hospital

Specific value: "ttsh"

Ultravioleta

Type: const

Ultravioleta hospital

Specific value: "ultravioleta"

UPCM

Type: object

College of Medicine - University of the Philippines Manila

Device UID

Type: string

Device UID for public session. If specified, backend will send message to device during authorization flow.

MaxwellApplication

Type: object

Application input for MaxwellApplication

No Additional Properties

User Role

Type: enum (of string)

User Role assumed by a clinician user of maxwell application

Must be one of:

  • "doctor"
  • "assistant"