Home Schema Example JSON Schema

Submission Comment


Content schema for submission comment.

root oneOf item 0
Type: object
No Additional Properties

root oneOf item 0 content

Content

Type: string

Content in markup language.

Must be at least 1 characters long

root oneOf item 0 entities

Entities

Type: array of object

Array of entities that are "tagged" in the submission.

 No Additional Items

Each item of this array must be:

root oneOf item 0 entities entities items
Type: object
No Additional Properties

root oneOf item 0 entities entities items type

Type

Type: enum (of string)

The entity type being tagged.

Must be one of:

  • "clinician"

root oneOf item 0 entities entities items start

Start

Type: integer

Start index of the entity in the content. Starts from 0.

Value must be greater or equal to 0

root oneOf item 0 entities entities items length

Length

Type: integer

Length of the entity in the content.

Value must be greater or equal to 1

root oneOf item 0 entities entities items clinician

Clinician

Type: object

Information about the clinician being tagged.

 No Additional Properties

root oneOf item 0 entities entities items clinician uid

UID

Type: string

UID of clinician.

Must be at least 1 characters long

root oneOf item 0 entities entities items clinician name

Name

Type: string

Name of clinician. Note that this is set by the client (i.e., frontend), it will not be updated by the backend and is thus not a trustworthy source of the most up-to-date name of the clinician. A reasonable alternative will be the taggedClinicians field on the cleoSubmissionComment GQL type. Thus, this field is optional and is used for display purposes only.

Must be at least 1 characters long

root oneOf Non-empty Strings

Non-empty Strings

Type: string

Convenience schema for validating non-empty strings.

Must be at least 1 characters long