Aller au contenu

InstrumentDetails

Ce contenu n’est pas encore disponible dans votre langue.

InstrumentDetails<TLanguage>: object

An object containing the base details of any instrument to be displayed to the clinician/researcher. This may be augmented in specific kinds of instruments, if applicable.

Type Parameters

TLanguage extends InstrumentLanguage = InstrumentLanguage

the language(s) of the instrument

Type declaration

authors?

optional authors: null | string[]

The legal person(s) that created the instrument and hold copyright to the instrument

description

description: InstrumentUIOption<TLanguage, string>

A brief description of the instrument, such as the purpose and history of the instrument

estimatedDuration?

optional estimatedDuration: number

An integer representing the estimated number of minutes for the average target subject to complete the instrument.

instructions?

optional instructions: InstrumentUIOption<TLanguage, string[]>

Brief sequential instructions for how the subject should complete the instrument.

license

license: LicenseIdentifier

An identifier corresponding to the SPDX license list version d2709ad (released on 2024-01-30)

referenceUrl?

optional referenceUrl: null | string

An reference link where the user can learn more about the instrument

sourceUrl?

optional sourceUrl: null | string

A URL where the user can find the source code for the instrument

title

title: InstrumentUIOption<TLanguage, string>

The title of the instrument in the language it is written, omitting the definite article.

Defined in

packages/runtime-core/src/types/instrument.base.d.ts:61