{ "description": "An extension for the CDS Hooks 'services' object that indicates configuration options supported by the CDS server", "_filename": "StructureDefinition-CDSHookServicesExtensionConfiguration.json", "package_name": "hl7.fhir.us.davinci-crd", "date": "2024-09-26T14:59:51-04:00", "derivation": "specialization", "publisher": "HL7 International / Financial Management", "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] } ], "name": "CDSHookServicesExtensionConfiguration", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "type": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CDSHookServicesExtensionConfiguration", "experimental": "false", "resourceType": "StructureDefinition", "title": "CDS Hooks Services Configuration Extension", "package_version": "2.1.0-preview", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fm" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2, "_valueInteger": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd" } ] } }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd" } ] } } ], "snapshot": { "element": [ { "path": "CDSHookServicesExtensionConfiguration", "min": 0, "definition": "A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service", "isModifier": false, "short": "An allowed configuration option", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name", "valueString": "davinci-crd.configuration-options" } ], "max": "*", "id": "CDSHookServicesExtensionConfiguration", "base": { "max": "*", "min": 0, "path": "Base" } }, { "path": "CDSHookServicesExtensionConfiguration.code", "min": 1, "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", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType" }, "max": "1", "id": "CDSHookServicesExtensionConfiguration.code", "base": { "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.code" } }, { "path": "CDSHookServicesExtensionConfiguration.type", "min": 1, "definition": "A data type for the parameter.", "short": "boolean | integer (JSON types)", "type": [ { "code": "code" } ], "binding": { "strength": "extensible", "valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes" }, "max": "1", "id": "CDSHookServicesExtensionConfiguration.type", "base": { "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.type" } }, { "id": "CDSHookServicesExtensionConfiguration.name", "max": "1", "min": 1, "base": { "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.name" }, "path": "CDSHookServicesExtensionConfiguration.name", "type": [ { "code": "string" } ], "short": "A display name for the configuration option", "definition": "A display name for the configuration option to appear in the client’s user interface when performing configuration" }, { "id": "CDSHookServicesExtensionConfiguration.description", "max": "1", "min": 1, "base": { "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.description" }, "path": "CDSHookServicesExtensionConfiguration.description", "type": [ { "code": "string" } ], "short": "1-2 sentences - the effect of the configuration option", "definition": "A description providing a 1-2 sentence description of the effect of the configuration option" }, { "path": "CDSHookServicesExtensionConfiguration.default", "min": 0, "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", "type": [ { "code": "integer" }, { "code": "boolean" } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice", "valueBoolean": true } ], "max": "1", "id": "CDSHookServicesExtensionConfiguration.default", "base": { "max": "1", "min": 0, "path": "CDSHookServicesExtensionConfiguration.default" } } ] }, "status": "active", "id": "75b31415-e293-41e6-bd44-a74e1e1e221d", "kind": "logical", "url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CDSHookServicesExtensionConfiguration", "version": "2.1.0-preview", "differential": { "element": [ { "id": "CDSHookServicesExtensionConfiguration", "path": "CDSHookServicesExtensionConfiguration", "short": "An allowed configuration option", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name", "valueString": "davinci-crd.configuration-options" } ], "definition": "A specific configuration option that is supported by the server and can be transmitted when invoking a hooks service" }, { "id": "CDSHookServicesExtensionConfiguration.code", "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.code", "type": [ { "code": "code" } ], "short": "Identifies the setting configuration when hook is invoked", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType" }, "definition": "A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet." }, { "id": "CDSHookServicesExtensionConfiguration.type", "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.type", "type": [ { "code": "code" } ], "short": "boolean | integer (JSON types)", "binding": { "strength": "extensible", "valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/configTypes" }, "definition": "A data type for the parameter." }, { "id": "CDSHookServicesExtensionConfiguration.name", "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.name", "type": [ { "code": "string" } ], "short": "A display name for the configuration option", "definition": "A display name for the configuration option to appear in the client’s user interface when performing configuration" }, { "id": "CDSHookServicesExtensionConfiguration.description", "max": "1", "min": 1, "path": "CDSHookServicesExtensionConfiguration.description", "type": [ { "code": "string" } ], "short": "1-2 sentences - the effect of the configuration option", "definition": "A description providing a 1-2 sentence description of the effect of the configuration option" }, { "id": "CDSHookServicesExtensionConfiguration.default", "max": "1", "min": 0, "path": "CDSHookServicesExtensionConfiguration.default", "type": [ { "code": "integer" }, { "code": "boolean" } ], "short": "Shows users what to expect when an override is not specified", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice", "valueBoolean": true } ], "definition": "A default value SHOULD also be provided to show users what to expect when an override is not specified" } ] }, "contact": [ { "telecom": [ { "value": "http://www.hl7.org/Special/committees/fm", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base" }