Home Schema Example JSON Schema

Directory Entry

Type: object

This is the content encoded in the Entry object for Directory data flow.

No Additional Properties

Display Name

Type: string

Name to use for display. This is some times different from the entry's name which is also searchable.

Department

Type: string

Department of the entry.

Designation

Type: string

Designation aka job title.

Identifiable Information

Type: object

A object with type and value of II.

No Additional Properties

Type: object

The following properties are required:

  • type
  • value
Type: object

The following properties are required:

  • phone
Type: object

The following properties are required:

  • email
Type: object

The following properties are required:

  • whatsapp
Type: object

The following properties are required:

  • governess_user_uid
Type: object

The following properties are required:

  • hospital_profile_uid

Type

Type: enum (of string)

The identifiable information type.

Must be one of:

  • "phone"
  • "email"
  • "whatsapp"
  • "governess_user_uid"
  • "hospital_profile_uid"

Value

Type: string

The identifiable information value.

Must be at least 1 characters long

Phone

Type: string

Phone number in E.164 format.

Must match regular expression: ^\+\d{5,}$

Email


Email address.

Type: objectFormat: email
Type: objectFormat: idn-email

WhatsApp

Type: string

WhatsApp phone number in E.164 format.

Must match regular expression: ^\+\d{5,}$

Governess User UID

Type: string

UID of Governess user.

Must match regular expression: ^[a-zA-Z0-9]{16,}$

Hospital Profile UID

Type: string

UID of Hospital profile.

Must match regular expression: ^[a-zA-Z0-9]{16,}$

Hospital Profile UID

Type: string

Profile UID for Hospital app.

Must be at least 1 characters long

NUHS

Type: object

NUHS specific content.

No Additional Properties

Institute

Type: string

Institute within the NUHS healthcare cluster.

Must be at least 1 characters long

TTSH

Type: object

TTSH specific content.

No Additional Properties

Office No.

Type: string

Used by TTSH ED because they dont want other people to see their numbers (TBD).

Must be at least 1 characters long