Da Vinci - Coverage Requirements Discovery
2.1.0 - STU 2.1
Da Vinci - Coverage Requirements Discovery
2.1.0 - STU 2.1
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.1.0: STU 2.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 3 |
Definitions for the CDSHookServicesExtensionConfiguration logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. CDSHookServicesExtensionConfiguration | |
| Definition | A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service |
| Short | An allowed configuration option |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| JSON Format | This type can appear in JSON with the property namedavinci-crd.configuration-options (in elements using named extensions) |
| 2. CDSHookServicesExtensionConfiguration.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. |
| Short | Identifies the setting configuration when hook is invoked |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CRD Card Types Value Set (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookServicesExtensionConfiguration.type | |
| Definition | A data type for the parameter. |
| Short | boolean | integer (JSON types) |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CRD Configuration Code Data Types Value Set (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookServicesExtensionConfiguration.name | |
| Definition | A display name for the configuration option to appear in the client’s user interface when performing configuration |
| Short | A display name for the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookServicesExtensionConfiguration.description | |
| Definition | A description providing a 1-2 sentence description of the effect of the configuration option |
| Short | 1-2 sentences - the effect of the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHookServicesExtensionConfiguration.default | |
| Definition | A default value SHOULD also be provided to show users what to expect when an override is not specified |
| Short | Shows users what to expect when an override is not specified |
| Control | 0..1 |
| Type | Choice of: integer, boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| JSON Format | The 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. CDSHookServicesExtensionConfiguration | |
| Definition | A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service |
| Short | An allowed configuration option |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| JSON Format | This type can appear in JSON with the property namedavinci-crd.configuration-options (in elements using named extensions) |
| 2. CDSHookServicesExtensionConfiguration.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. |
| Short | Identifies the setting configuration when hook is invoked |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CRD Card Types Value Set (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookServicesExtensionConfiguration.type | |
| Definition | A data type for the parameter. |
| Short | boolean | integer (JSON types) |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CRD Configuration Code Data Types Value Set (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookServicesExtensionConfiguration.name | |
| Definition | A display name for the configuration option to appear in the client’s user interface when performing configuration |
| Short | A display name for the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookServicesExtensionConfiguration.description | |
| Definition | A description providing a 1-2 sentence description of the effect of the configuration option |
| Short | 1-2 sentences - the effect of the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHookServicesExtensionConfiguration.default | |
| Definition | A default value SHOULD also be provided to show users what to expect when an override is not specified |
| Short | Shows users what to expect when an override is not specified |
| Control | 0..1 |
| Type | Choice of: integer, boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| JSON Format | The 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. CDSHookServicesExtensionConfiguration | |
| Definition | A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service |
| Short | An allowed configuration option |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| JSON Format | This type can appear in JSON with the property namedavinci-crd.configuration-options (in elements using named extensions) |
| 2. CDSHookServicesExtensionConfiguration.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. |
| Short | Identifies the setting configuration when hook is invoked |
| Control | 1..1 |
| Binding | The codes SHALL be taken from CRD Card Types Value Set (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CDSHookServicesExtensionConfiguration.type | |
| Definition | A data type for the parameter. |
| Short | boolean | integer (JSON types) |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CRD Configuration Code Data Types Value Set (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CDSHookServicesExtensionConfiguration.name | |
| Definition | A display name for the configuration option to appear in the client’s user interface when performing configuration |
| Short | A display name for the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CDSHookServicesExtensionConfiguration.description | |
| Definition | A description providing a 1-2 sentence description of the effect of the configuration option |
| Short | 1-2 sentences - the effect of the configuration option |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CDSHookServicesExtensionConfiguration.default | |
| Definition | A default value SHOULD also be provided to show users what to expect when an override is not specified |
| Short | Shows users what to expect when an override is not specified |
| Control | 0..1 |
| Type | Choice of: integer, boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| JSON Format | The type of this element is inferred from the JSON type in the instance |
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.1.0 based on FHIR 4.0.1. Generated 2024-12-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change