Schema for Directory Directory Entry

From Entry.schema.yaml (directory/Entry.schema)

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

title: Directory Entry
description: >-
  This is the `content` encoded in the `Entry` object for Directory data flow.

type: object
additionalProperties: false
required: []

properties:
  display_name:
    title: Display Name
    description: Name to use for display. This is some times different from the entry's name which is also searchable.
    type: string
  #end display_name

  department:
    title: Department
    description: Department of the entry.
    type: string
  #end department

  designation:
    title: Designation
    description: Designation aka job title.
    type: string
  #end designation

  identifiable_information:
    title: Identifiable Information
    description: A object with `type` and `value` of II.

    $ref: "/governess/IdentifiableInformation.schema"
  #end identifiable_information

  hospital_profile_uid:
    title: Hospital Profile UID
    description: Profile UID for Hospital app.
    type: string
    minLength: 1

  nuhs:
    title: NUHS
    description: NUHS specific content.

    type: object
    additionalProperties: false
    required: []

    properties:
      institute:
        title: Institute
        description: Institute within the NUHS healthcare cluster.
        type: string
        minLength: 1
    #end properties
  #end nuhs

  ttsh:
    title: TTSH
    description: TTSH specific content.

    type: object
    additionalProperties: false
    required: []

    properties:
      office_no:
        title: Office No.
        description: Used by TTSH ED because they dont want other people to see their numbers (TBD).
        type: string
        minLength: 1
    #end properties
  #end ttsh
#end properties

[Main Page] [Schema Documentation] [Examples]