FHIR Tooling Extensions IG
0.1.0 - Release International flag

This page is part of the HL7 Tools Extension IG (v0.1.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: CDSHooksExtensionDaVinciConfigOptionsTest - Detailed Descriptions

Draft as of 2023-12-19 Maturity Level: 2

Definitions for the CDSHooksExtension-DaVinci-configoptions logical model.

Guidance on how to interpret the contents of this table can be found here

0. DaVinciConfigOptions
Definition

The context for the patient-view hook

ShortThe context for the patient-view hook
Control0..*
Logical ModelInstances of this logical model are not marked to be the target of a Reference
JSON FormatThis type can appear in JSON with the property name davinci-crd.configuration-options-test (in elements using named extensions)
2. DaVinciConfigOptions.code
Definition

A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet.

ShortIdentifies the setting configuration when hook is invoked
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DaVinciConfigOptions.type
Definition

A data type for the parameter. At present, allowed values are “boolean” and “integer”

Shortboolean | integer (JSON types)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DaVinciConfigOptions.name
Definition

A display name for the configuration option to appear in the client’s user interface when performing configuration

ShortA display name for the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DaVinciConfigOptions.description
Definition

A description providing a 1-2 sentence description of the effect of the configuration option

Short1-2 sentences - the effect of the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DaVinciConfigOptions.default
Definition

A default value SHOULD also be provided to show users what to expect when an override is not specified

ShortShows users what to expect when an override is not specified
Control0..1
TypeChoice of: integer, boolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
JSON FormatThe type of this element is inferred from the JSON type in the instance

Guidance on how to interpret the contents of this table can be found here

0. DaVinciConfigOptions
Definition

The context for the patient-view hook


Base definition for all types defined in FHIR type system.

ShortThe context for the patient-view hookBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
JSON FormatThis type can appear in JSON with the property name davinci-crd.configuration-options-test (in elements using named extensions)
2. DaVinciConfigOptions.code
Definition

A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet.

ShortIdentifies the setting configuration when hook is invoked
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DaVinciConfigOptions.type
Definition

A data type for the parameter. At present, allowed values are “boolean” and “integer”

Shortboolean | integer (JSON types)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DaVinciConfigOptions.name
Definition

A display name for the configuration option to appear in the client’s user interface when performing configuration

ShortA display name for the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DaVinciConfigOptions.description
Definition

A description providing a 1-2 sentence description of the effect of the configuration option

Short1-2 sentences - the effect of the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DaVinciConfigOptions.default
Definition

A default value SHOULD also be provided to show users what to expect when an override is not specified

ShortShows users what to expect when an override is not specified
Control0..1
TypeChoice of: integer, boolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
JSON FormatThe type of this element is inferred from the JSON type in the instance

Guidance on how to interpret the contents of this table can be found here

0. DaVinciConfigOptions
Definition

The context for the patient-view hook

ShortThe context for the patient-view hook
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
JSON FormatThis type can appear in JSON with the property name davinci-crd.configuration-options-test (in elements using named extensions)
2. DaVinciConfigOptions.code
Definition

A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet.

ShortIdentifies the setting configuration when hook is invoked
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DaVinciConfigOptions.type
Definition

A data type for the parameter. At present, allowed values are “boolean” and “integer”

Shortboolean | integer (JSON types)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. DaVinciConfigOptions.name
Definition

A display name for the configuration option to appear in the client’s user interface when performing configuration

ShortA display name for the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DaVinciConfigOptions.description
Definition

A description providing a 1-2 sentence description of the effect of the configuration option

Short1-2 sentences - the effect of the configuration option
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DaVinciConfigOptions.default
Definition

A default value SHOULD also be provided to show users what to expect when an override is not specified

ShortShows users what to expect when an override is not specified
Control0..1
TypeChoice of: integer, boolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
JSON FormatThe type of this element is inferred from the JSON type in the instance