This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Compartments: Not linked to any defined compartments |
The DecisionSupportServiceModule describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.
This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Quality Improvement Framework Implementation Guide.
The DecisionSupportServiceModule defines a module of clinical decision support functionality made available by a decision support service. For example, a service may provide immunization modules, drug-drug interaction checking, or appropriate use assessment.
Each module defines three main features related to its functionality:
Input and output parameters are used to specify any named parameters used by the module. These are typically patient-independent configuration parameters such as an A1C threshold for a diabetes control module, but they may also be used to return calculations performed by the module.
Data requirements are used to specify the set of data that must be provided (or available) to the module in order to achieve a successful evaluation. For example, if the module requires A1C lab results within the last 6 months, or information on bilateral or both left and right amputation at or below the knee.
Triggers are used to advertise when the module should be invoked. On encountering a specific trigger, a clinical application can invoke the modules associated with the trigger using the $evaluate operation. Any data required by the module can be sent as part of the request, and any suggested actions and other output data are returned via the GuidanceResponse resource.
For a more detailed discussion of the evaluation process, refer to the Integrating Decision Support in a Clinical Workflow topic in the CQIF IG.
The DecisionSupportServiceModule is similar in structure to the DecisionSupportRule, and supports an identical $evaluate operation. The difference between the two is that the DecisionSupportRule is designed to enable the sharing of the rule definition, as opposed to the DecisionSupportServiceModule, which only supports evaluation of the module; the internal functionality is opaque.
This resource is referenced by guidanceresponse
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DecisionSupportServiceModule | Σ | DomainResource | A description of decision support service functionality | |
moduleMetadata | Σ | 0..1 | ModuleMetadata | Metadata for the service module |
trigger | Σ | 0..* | TriggerDefinition | "when" the module should be invoked |
parameter | Σ | 0..* | ParameterDefinition | Parameters to the module |
dataRequirement | Σ | 0..* | DataRequirement | Data requirements for the module |
Documentation for this format |
UML Diagram
XML Template
<DecisionSupportServiceModule xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <moduleMetadata><!-- 0..1 ModuleMetadata Metadata for the service module --></moduleMetadata> <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger> <parameter><!-- 0..* ParameterDefinition Parameters to the module --></parameter> <dataRequirement><!-- 0..* DataRequirement Data requirements for the module --></dataRequirement> </DecisionSupportServiceModule>
JSON Template
{ "resourceType" : "DecisionSupportServiceModule", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "moduleMetadata" : { ModuleMetadata }, // Metadata for the service module "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked "parameter" : [{ ParameterDefinition }], // Parameters to the module "dataRequirement" : [{ DataRequirement }] // Data requirements for the module }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DecisionSupportServiceModule | Σ | DomainResource | A description of decision support service functionality | |
moduleMetadata | Σ | 0..1 | ModuleMetadata | Metadata for the service module |
trigger | Σ | 0..* | TriggerDefinition | "when" the module should be invoked |
parameter | Σ | 0..* | ParameterDefinition | Parameters to the module |
dataRequirement | Σ | 0..* | DataRequirement | Data requirements for the module |
Documentation for this format |
XML Template
<DecisionSupportServiceModule xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <moduleMetadata><!-- 0..1 ModuleMetadata Metadata for the service module --></moduleMetadata> <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger> <parameter><!-- 0..* ParameterDefinition Parameters to the module --></parameter> <dataRequirement><!-- 0..* DataRequirement Data requirements for the module --></dataRequirement> </DecisionSupportServiceModule>
JSON Template
{ "resourceType" : "DecisionSupportServiceModule", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "moduleMetadata" : { ModuleMetadata }, // Metadata for the service module "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked "parameter" : [{ ParameterDefinition }], // Parameters to the module "dataRequirement" : [{ DataRequirement }] // Data requirements for the module }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
description | string | Text search against the description | DecisionSupportServiceModule.moduleMetadata.description |
identifier | token | Logical identifier for the module (e.g. CMS-143) | DecisionSupportServiceModule.moduleMetadata.identifier |
status | token | Status of the module | DecisionSupportServiceModule.moduleMetadata.status |
title | string | Text search against the title | DecisionSupportServiceModule.moduleMetadata.title |
topic | token | Topics associated with the module | DecisionSupportServiceModule.moduleMetadata.topic |
version | string | Version of the module (e.g. 1.0.0) | DecisionSupportServiceModule.moduleMetadata.version |