InstrumentDetails

InstrumentDetails<TLanguage> = object

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:53

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

TLanguage extends InstrumentLanguage = InstrumentLanguage

the language(s) of the instrument

Properties

authors?

optional authors?: null | string[]

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:55

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

---

description

description: InstrumentUIOption<TLanguage, string>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:57

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

---

estimatedDuration?

optional estimatedDuration?: number

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:62

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

Deprecated

This API is no longer supported and may be removed in a future release.

---

instructions?

optional instructions?: InstrumentUIOption<TLanguage, string[]>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:67

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

Deprecated

This API is no longer supported and may be removed in a future release.

---

license

license: LicenseIdentifier

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:69

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

---

referenceUrl?

optional referenceUrl?: null | string

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:71

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

---

sourceUrl?

optional sourceUrl?: null | string

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:73

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

---

title

title: InstrumentUIOption<TLanguage, string>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:75

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