Schema for Hospital Profile Tags

From ProfileTags.schema.yaml (hospital/ProfileTags.schema)

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

title: Profile Tags
description: >-
  Profile `tags` are used to identify certain properties of users and control their access to data.

type: array
uniqueItems: true

items:
  anyOf:
    - $ref: "#/definitions/Accessible Tags"
    - $ref: "#/definitions/Bot MD Tags"
    - $ref: "#/definitions/Organization Keys"
    - $ref: "#/definitions/Department Tags"
#end items

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

    anyOf:
      - title: AHFS
        description: Profile can access AHFS DI monographs.
        const: AHFS_accessible

      - title: Calculators
        description: Profile can access calculators.
        const: calculators_accessible

      - title: EB Medicine
        description: Profile can access EB medicine module.
        const: ebmedicine_accessible

      - title: Guidelines
        description: Profile can access guidelines module.
        const: guidelines_accessible

      - title: Sanford
        description: Profile can access Sanford module.
        const: Sanford_accessible

      - title: NCIS ChemoCalc
        description: Profile can access NCIS chemocalc module.
        const: ncis_chemocalc_accessible

      - title: UpToDate
        description: Profile can access Uptodate module.
        const: Uptodate_accessible

      - title: Mediview
        description: Profile can access Mediview module.
        const: Mediview_accessible

      - title: MIMS
        description: Profile can access MIMS monographs.
        const: MIMS_accessible
  #end Accessible Tags

  Bot MD Tags:
    title: Bot MD Tags
    description: Our internal tags for managing users. Usually used for testing and billing purposes.

    anyOf:
      - title: Internal User
        description: This profile belongs to an internal user.
        const: "botmd:internal"
      - title: Jarvis
        description: Users with this tag will be redirected to Jarvis instead.
        const: "botmd:jarvis"
      - title: Jarvis V2
        description: Users with this tag will be redirected to Jarvis v2 for certain queries.
        const: "botmd:jarvisv2"
      - title: Test
        description: This tag is used for testing purpose (e.g., unit tests).
        const: "botmd:testtag"
      - title: Documents Beta
        description: This profile is on the waitlist for the documents Beta programme
        const: "botmd:beta-documents-waitlist"
      - title: Documents Beta
        description: This profile is enrolled onto the documents Beta programme
        const: "botmd:beta-documents"
      - title: Directory Assistant
        description: This profile has access to the directory Jarvis V2 assistant
        const: "botmd:assistant-directory"
  #end Bot MD Tags

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

    anyOf:
      - title: Alexandra
        description: Alexandra Hospital
        const: alexandra

      - title: AHI
        description: Association of Healthtech Indonesia
        const: ahi

      - title: Digihealth
        description: Digihealth
        const: digihealth

      - title: Bot MD Demo Hospital
        description: Bot MD Demo Hospital for our internal testing purposes.
        const: bdh

      - title: CGH
        description: Changi General Hospital
        const: cgh

      - title: Cleo
        description: All cleo dialogues are nested under this hospital. Permissions to different clinics are separated by tags of the form `cleo:<domain>`.
        const: cleo

      - title: Dharmais
        description: Rumah Sakit Kanker Dharmais
        const: dharmais

      - title: Fleming Hospital
        description: Fleming Hospital is our hospital for public users.
        const: fleminghospital

      - title: Bot MD
        description: Bot MD.
        const: botmd

      - title: Bot MD ID Web
        description: Bot MD ID Demo Web
        const: botmd_id_web

      - title: EB Medicine Demo
        description: EB Medicine Demo
        const: eb_medicine

      - title: Faithful Empire
        description: Faithful Empire Webbot
        const: faithful_empire_web

      - title: Harapan Kita
        description: Pusat Jantung Nasional Harapan Kita
        const: pjnhk

      - title: ICC
        description: Icon Cancer Centre
        const: icc

      - title: IDI
        description: Indonesian Medical Association
        const: idi

      - title: IDI Web
        description: Indonesian Medical Association Web
        const: idi_web

      - title: IDI Whatsapp
        description: Indonesian Medical Association Whatsapp
        const: idi_whatsapp

      - title: Iskandar Demo
        description: Iskandar demo project.
        enum: [iskandar_demo, iskandar]

      - title: Indonesia Care
        description: Indonesia care
        const: indonesia_care

      - title: Indonesia Hospital
        description: Indonesia hospital
        const: indonesia_hospital

      - title: Klinik In Harmony
        description: Klinik In Harmony
        const: inharmony

      - title: KONSULTAMD
        description: Konsulta MD
        const: konsultamd

      - title: KKWCH
        description: KK Women's and Children's Hospital
        const: kkwch

      - title: KTPH
        description: Khoo Teck Puat Hospital
        const: ktph

      - title: MOH Singapore
        description: Ministry of Health (Singapore)
        const: moh_sg

      - title: National Hospital
        description: National Hospital
        const: nationalhospital

      - title: NCCS
        description: National Cancer Centre Singapore
        const: nccs

      - title: NCIS
        description: National University Cancer Institute Singapore
        const: ncis

      - title: NCIS Engage
        description: NCIS Engage
        const: ncis_engage

      - title: NCIS Engage Web
        description: NCIS Engage Web
        const: ncis_engage_web

      - title: NEMG
        description: Northeast Medical Group
        const: nemg

      - title: NEMG WEB
        description: NEMG WEB
        const: nemg_web

      - title: NKTI
        description: National Kidney Transplant Institute
        const: nkti

      - title: NTFGH
        description: Ng Teng Fong General Hospital
        const: ntfgh

      - title: NUHS
        description: National University Health System
        const: nuhs

      - title: NUH
        description: National University Hospital
        const: nuh

      - title: NUS Med
        description: NUS School of Medicine
        const: nus_med

      - title: Parkway Radiology
        description: Parkway Radiology
        const: parkwayradio

      - title: Philippine General Hospital
        description: Philippine General Hospital
        const: pgh

      - title: Prodia Demo
        description: Prodia Demo
        const: prodia_demo

      - title: PPhA
        description: Philippine Pharmacists Association, Inc
        const: ppha

      - title: Roche Singapore
        description: Roche Singapore
        const: roche

      - title: Roche Brunei
        description: Roche Brunei
        const: roche_brunei

      - title: Roche HCP
        description: Roche HCP is the public bot hosted on https://roche.com.sg
        const: roche_hcp

      - title: Roche HCP Private
        description: Roche HCP Private is the private bot hosted on https://roche.com.sg
        const: roche_hcp_private

      - title: Philippine General Hospital
        description: Philippine General Hospital
        const: upcm

      - title: Sanglah
        description: Sanglah General Hospital
        const: sanglah

      - title: SGH
        description: Singapore General Hospital
        const: sgh

      - title: SKH
        description: Sengkang General Hospital
        const: skh

      - title: SingHealth
        description: SingHealth
        const: singhealth

      - title: Siloam Hospitals
        description: Siloam Hospitals
        const: siloam

      - title: Speedoc
        description: Speedoc
        const: speedoc

      - title: Stanford
        description: Stanford Health Care
        const: stanford

      - title: Sunway
        description: Sunway
        const: sunway

      - title: TTSH
        description: Tan Tock Seng Hospital
        const: ttsh

      - title: Ultravioleta
        description: Ultravioleta hospital
        const: ultravioleta

      - title: UPCM
        description: College of Medicine - University of the Philippines Manila
        org_key: upcm
  #end Organization Keys

  Department Tags:
    title: Department Tags
    description: List of departments we count as tags.

    anyOf:
      - title: BDH
        description: This represents demo-groups within BDH (e.g. `bdh_upcn`, `bdh_healthway`, etc)
        type: string
        pattern: '^bdh\_\w+$'

      - title: CGH
        description: This represents departments, services, or content-groups within CGH (e.g. `cgh_rccm`, `cgh_edgeri`, etc)
        type: string
        pattern: '^cgh\_\w+$'

      - title: Cleo
        description: This separates various clinics within Cleo using their `domain`.
        type: string
        pattern: '^cleo\:\w+$'

      - title: KKWCH
        description: This represents departments, services, or content-groups within KKWCH (e.g. `kkwch_rccm`, `kkwch_edgeri`, etc)
        type: string
        pattern: '^kkwch\_\w+$'

      - title: NCIS
        description: This represents departments, services, or content-groups within NCIS (e.g. `ncis_rccm` etc)
        type: string
        pattern: '^ncis\_\w+$'

      - title: NTFGH
        description: This represents departments, services, or content-groups within NTFGH (e.g. `ntfgh_rccm`, `ntfgh_edgeri`, etc)
        type: string
        pattern: '^ntfgh\_\w+$'

      - title: NUHS
        description: This represents departments, services, or content-groups within NUHS (e.g. `nuhs_rccm`, `nuhs_edgeri`, etc)
        type: string
        pattern: '^nuhs\_\w+$'

      - title: NUH
        description: This represents departments, services, or content-groups within NUH (e.g. `nuh_rccm`, `nuh_edgeri`, etc)
        type: string
        pattern: '^nuh\_\w+$'

      - title: Alexandra
        description: This represents departments, services, or content-groups within AH (e.g. `alexandra_rccm`, `alexandra_edgeri`, etc)
        type: string
        pattern: '^alexandra\_\w+$'

      - title: SKH
        description: This represents departments, services, or content-groups within SKH (e.g. `skh_rccm`, `skh_edgeri`, etc)
        type: string
        pattern: '^skh\_\w+$'

      - title: TTSH
        description: This represents departments, services, or content-groups within TTSH (e.g. `ttsh_rccm`, `ttsh_edgeri`, etc)
        type: string
        pattern: '^ttsh\_\w+$'

      - title: National University Polyclinics (Deprecated)
        description: NUHS polyclinics
        const: nupoly

      - title: Bot MD Philippines
        description: For users in Philippines.
        const: botmdphilippines
  #end Department Tags
#end definitions

[Main Page] [Schema Documentation] [Examples]