Home Schema Example JSON Schema

Clinical Parameter Value


Schema to describe how the clinical parameters values will look like.

No Additional Properties

Type: object

The following properties are required:

  • boolean
Type: object

The following properties are required:

  • number
Type: object

The following properties are required:

  • string
Type: object

The following properties are required:

  • string_array
Type: object

The following properties are required:

  • file
Type: object

The following properties are required:

  • datetime
Type: object

The following properties are required:

  • time

Boolean

Type: boolean

A boolean scalar (corresponds to bool in Python). Note that we are able to convert string values to boolean using the following rule: value.lower() in ['1', 'true', 'yes', 'ok']. Other types will be converted using bool(...).

Number

Type: number

A numerical scalar (corresponds to int or float in Python).

String

Type: string

A single string scalar (corresponds to str in Python). For convenience, we will use the first item of a sequence of strings containing exactly 1 item. Instances of str, int, bool, float will be converted to strings using str(...). Other types will raise a TypeError.

String (Array)

Type: array of string

Array of strings (corresponds to Sequence[str] in Python). For convenience, scalars of str, int, bool, float will be converted automatically to an array with 1 item using the list(str(...)).

No Additional Items

Each item of this array must be:

Type: string

File

Type: object

A file URL to the location containing the file.

No Additional Properties

URL

Type: stringFormat: uri

The original URL provided by the Onform provider. Can also be s3://, gs:// or Stitch stitch://upload_id.

Name

Type: string

The filename component from the url path.

Must be at least 1 characters long

Suffix

Type: string

The filename suffix component (i.e., file extension) from the url path.

Must match regular expression: ^(\.[a-z0-9]+)?$

Date-Time

Type: stringFormat: date-time

The date-time representation in ISO format.

Time

Type: stringFormat: time

A time representation in %H:%M ISO format.