InstrumentDetails
InstrumentDetails<
TLanguage>:object
Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:51
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
Section titled “Type Parameters”• TLanguage extends InstrumentLanguage = InstrumentLanguage
the language(s) of the instrument
Type declaration
Section titled “Type declaration”authors?
Section titled “authors?”
optionalauthors:null|string[]
The legal person(s) that created the instrument and hold copyright to the instrument
description
Section titled “description”description:
InstrumentUIOption<TLanguage,string>
A brief description of the instrument, such as the purpose and history of the instrument
estimatedDuration?
Section titled “estimatedDuration?”
optionalestimatedDuration:number
An integer representing the estimated number of minutes for the average target subject to complete the instrument.
instructions?
Section titled “instructions?”
optionalinstructions:InstrumentUIOption<TLanguage,string[]>
Brief sequential instructions for how the subject should complete the instrument.
license
Section titled “license”license:
LicenseIdentifier
An identifier corresponding to the SPDX license list version d2709ad (released on 2024-01-30)
referenceUrl?
Section titled “referenceUrl?”
optionalreferenceUrl:null|string
An reference link where the user can learn more about the instrument
sourceUrl?
Section titled “sourceUrl?”
optionalsourceUrl:null|string
A URL where the user can find the source code for the instrument
title:
InstrumentUIOption<TLanguage,string>
The title of the instrument in the language it is written, omitting the definite article.