Generated Narrative: StructureDefinition CDSHookServicesExtensionConfiguration

NameFlagsCard.TypeDescription & Constraintsdoco
.. CDSHookServicesExtensionConfiguration 0..*BaseAn allowed configuration option
JSON Property Name for Type: davinci-crd.configuration-options
... code 1..1codeIdentifies the setting configuration when hook is invoked
Binding: CRD Response Types Value Set (required)
... type 1..1codeboolean | integer (JSON types)
Binding: CRD Configuration Code Data Types Value Set (extensible)
... name 1..1stringA display name for the configuration option
... description 1..1string1-2 sentences - the effect of the configuration option
... default 0..1integer, booleanShows users what to expect when an override is not specified
JSON: The type of this element is inferred from the JSON type in the instance

doco Documentation for this format
 <status value="active"/> <experimental value="false"/> <date value="2026-03-27T11:45:27+11:00"/> <publisher value="HL7 International / Financial Management"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fm"/> </telecom> </contact> <description value="An extension for the CDS Hooks 'services' object that indicates configuration options supported by the CDS server"/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> </coding> </jurisdiction> <fhirVersion value="4.0.1"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <context> <type value="element"/> <expression value="CDSHooksServices.services.extension"/> </context> <type value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CDSHookServicesExtensionConfiguration"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> <derivation value="specialization"/> <snapshot> <extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version"> <valueString value="4.0.1"/> </extension> <element id="CDSHookServicesExtensionConfiguration"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-name"> <valueString value="davinci-crd.configuration-options"/> </extension> <path value="CDSHookServicesExtensionConfiguration"/> <short value="An allowed configuration option"/> <definition value="A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service"/> <min value="0"/> <max value="*"/> <base> <path value="Base"/> <min value="0"/> <max value="*"/> </base> <isModifier value="false"/> </element> <element id="CDSHookServicesExtensionConfiguration.code"> <path value="CDSHookServicesExtensionConfiguration.code"/> <short value="Identifies the setting configuration when hook is invoked"/> <definition value="A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHookServicesExtensionConfiguration.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <valueSet value="http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"/> </binding> </element> <element id="CDSHookServicesExtensionConfiguration.type"> <path value="CDSHookServicesExtensionConfiguration.type"/> <short value="boolean | integer (JSON types)"/> <definition value="A data type for the parameter."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHookServicesExtensionConfiguration.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes"/> </binding> </element> <element id="CDSHookServicesExtensionConfiguration.name"> <path value="CDSHookServicesExtensionConfiguration.name"/> <short value="A display name for the configuration option"/> <definition value="A display name for the configuration option to appear in the client’s user interface when performing configuration"/> <min value="1"/> <max value="1"/> <base> <path value="CDSHookServicesExtensionConfiguration.name"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="CDSHookServicesExtensionConfiguration.description"> <path value="CDSHookServicesExtensionConfiguration.description"/> <short value="1-2 sentences - the effect of the configuration option"/> <definition value="A description providing a 1-2 sentence description of the effect of the configuration option"/> <min value="1"/> <max value="1"/> <base> <path value="CDSHookServicesExtensionConfiguration.description"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="CDSHookServicesExtensionConfiguration.default"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice"> <valueBoolean value="true"/> </extension> <path value="CDSHookServicesExtensionConfiguration.default"/> <short value="Shows users what to expect when an override is not specified"/> <definition value="A default value SHOULD also be provided to show users what to expect when an override is not specified"/> <min value="0"/> <max value="1"/> <base> <path value="CDSHookServicesExtensionConfiguration.default"/> <min value="0"/> <max value="1"/> </base> <type> <code value="integer"/> </type> <type> <code value="boolean"/> </type> </element> </snapshot> <differential> <element id="CDSHookServicesExtensionConfiguration"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-name"> <valueString value="davinci-crd.configuration-options"/> </extension> <path value="CDSHookServicesExtensionConfiguration"/> <short value="An allowed configuration option"/> <definition value="A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service"/> </element> <element id="CDSHookServicesExtensionConfiguration.code"> <path value="CDSHookServicesExtensionConfiguration.code"/> <short value="Identifies the setting configuration when hook is invoked"/> <definition value="A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <strength value="required"/> <valueSet value="http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"/> </binding> </element> <element id="CDSHookServicesExtensionConfiguration.type"> <path value="CDSHookServicesExtensionConfiguration.type"/> <short value="boolean | integer (JSON types)"/> <definition value="A data type for the parameter."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes"/> </binding> </element> <element id="CDSHookServicesExtensionConfiguration.name"> <path value="CDSHookServicesExtensionConfiguration.name"/> <short value="A display name for the configuration option"/> <definition value="A display name for the configuration option to appear in the client’s user interface when performing configuration"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="CDSHookServicesExtensionConfiguration.description"> <path value="CDSHookServicesExtensionConfiguration.description"/> <short value="1-2 sentences - the effect of the configuration option"/> <definition value="A description providing a 1-2 sentence description of the effect of the configuration option"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="CDSHookServicesExtensionConfiguration.default"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice"> <valueBoolean value="true"/> </extension> <path value="CDSHookServicesExtensionConfiguration.default"/> <short value="Shows users what to expect when an override is not specified"/> <definition value="A default value SHOULD also be provided to show users what to expect when an override is not specified"/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <type> <code value="boolean"/> </type> </element> </differential> </StructureDefinition>