Home Schema Example JSON Schema

Tenant Resource

Type: object

A resource file for defining tenant resources.

Description

Type: string Default: ""

A description of the resource file.

Tenant Stopwords

Type: array

Stopwords used by this tenant.

No Additional Items

Each item of this array must be:

Stopword Settings

Type: object

Configure stopwords on a per answer type/field level.

Answer Field

Type: string

The field in the answer where the object is used.

Answer Type

Type: enum (of string)

The answer type where the object is used.

Must be one of:

  • "clinical-trial"
  • "dialogue"
  • "directory"
  • "document"
  • "document-snippet"
  • "monograph"
  • "roster"
  • "test"

Stopwords


The stopwords for this answer type/field. It can be a list of phrases or a stopword set name.

Type: const
Specific value: "en-standard"
Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Syncer ID

Type: string

Unique name identifying this syncer.

Tenant Synonyms

Type: array

Synonyms used by this tenant.

No Additional Items

Each item of this array must be:

Synonym Settings

Type: object

Configure synonyms on a per answer type/field level.

Answer Field

Type: string

The field in the answer where the object is used.

Answer Type

Type: enum (of string)

The answer type where the object is used.

Must be one of:

  • "clinical-trial"
  • "dialogue"
  • "directory"
  • "document"
  • "document-snippet"
  • "monograph"
  • "roster"
  • "test"

Synonym Expansion Rounds

Type: integer Default: 3

The number of rounds to expand the synonyms. Each round will generate more candidate synonyms.

Value must be greater or equal to 0

Synonyms

Type: array

The synonyms for this answer type/field as a list of synonym groups.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Synonym Group


Describes how synonyms are generated

One Way Synonym Group

Type: object

In a one-way synonym group, all phrases are synonyms of the first phrase but not the other way round.

Each additional property must conform to the following schema

Type: array of string

Synonyms of the first phrase.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Two Way Synonym Group

Type: array of string

In a two-way synonym group, all pairs of phrases are synonyms of each other and can be used interchangeably.

Must contain a minimum of 2 items

No Additional Items

Each item of this array must be:

Synonym

Type: string

A Single synonym phrase.

Must be at least 1 characters long

Tenant


The tenant that this resource file is applicable to.

Cleo Tenant

Type: string

The cleo app tenant applicable to this object.

Must match regular expression: ^cleo\:[a-zA-Z0-9][\w\-\_]*$

Hospital Tenant

Type: string

The hospital app tenant applicable to this object.

Must match regular expression: ^hospital\:[a-zA-Z0-9][\w\-\_]*$