This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 Reasoning module.
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 Clinical Decision Support topic in the Clinical Reasoning module.
The DecisionSupportServiceModule is similar in structure and purpose to OperationDefinition. However, DecisionSupportServiceModule also represents more information about what service is being described than an operation definition supports. This information is critical to the effective use of the resource as part of a decision support service repository, as it enables searching and selection of functionality based on this additional information.
In addition, the way the $evaluate operation of the DecisionSupportServiceModule resource is defined enables all decision support services to share a common set of parameters without having to redeclare them for every module, while still supporting service-specific paramters on each module.
Ballot Note: Because of the overlap with OperationDefinition, this resource is being considered for decomposition into a ServiceDefinition resource that would support a more general description of service functionality, and a possible profile or modification of OperationDefinition to support the requirements for decision support use of an operation.
This resource is referenced by guidanceresponse
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DecisionSupportServiceModule | DomainResource | A description of decision support service functionality | ||
url | Σ | 0..1 | uri | Logical URL to reference this module |
identifier | Σ | 0..* | Identifier | Logical identifier(s) for the module |
version | Σ | 0..1 | string | The version of the module, if any |
name | Σ | 0..1 | string | A machine-friendly name for the module |
title | Σ | 0..1 | string | A user-friendly title for the module |
status | ?!Σ | 1..1 | code | draft | active | inactive LibraryStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
description | 0..1 | string | Natural language description of the module | |
purpose | 0..1 | string | Describes the purpose of the module | |
usage | 0..1 | string | Describes the clinical usage of the module | |
publicationDate | 0..1 | date | Publication date for this version of the module | |
lastReviewDate | 0..1 | date | Last review date for the module | |
effectivePeriod | 0..1 | Period | The effective date range for the module | |
coverage | 0..* | UsageContext | Describes the context of use for this module | |
topic | 0..* | CodeableConcept | Descriptional topics for the module | |
contributor | 0..* | Contributor | A content contributor | |
publisher | 0..1 | string | Name of the publisher (Organization or individual) | |
contact | 0..* | ContactDetail | Contact details of the publisher | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
relatedResource | 0..* | RelatedResource | Related resources for the 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 (Legend)
XML Template
<DecisionSupportServiceModule xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URL to reference this module --> <identifier><!-- 0..* Identifier Logical identifier(s) for the module --></identifier> <version value="[string]"/><!-- 0..1 The version of the module, if any --> <name value="[string]"/><!-- 0..1 A machine-friendly name for the module --> <title value="[string]"/><!-- 0..1 A user-friendly title for the module --> <status value="[code]"/><!-- 1..1 draft | active | inactive --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <description value="[string]"/><!-- 0..1 Natural language description of the module --> <purpose value="[string]"/><!-- 0..1 Describes the purpose of the module --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module --> <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the module --> <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the module --> <effectivePeriod><!-- 0..1 Period The effective date range for the module --></effectivePeriod> <coverage><!-- 0..* UsageContext Describes the context of use for this module --></coverage> <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact><!-- 0..* ContactDetail Contact details of the publisher --></contact> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedResource><!-- 0..* RelatedResource Related resources for the module --></relatedResource> <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 "url" : "<uri>", // Logical URL to reference this module "identifier" : [{ Identifier }], // Logical identifier(s) for the module "version" : "<string>", // The version of the module, if any "name" : "<string>", // A machine-friendly name for the module "title" : "<string>", // A user-friendly title for the module "status" : "<code>", // R! draft | active | inactive "experimental" : <boolean>, // If for testing purposes, not real usage "description" : "<string>", // Natural language description of the module "purpose" : "<string>", // Describes the purpose of the module "usage" : "<string>", // Describes the clinical usage of the module "publicationDate" : "<date>", // Publication date for this version of the module "lastReviewDate" : "<date>", // Last review date for the module "effectivePeriod" : { Period }, // The effective date range for the module "coverage" : [{ UsageContext }], // Describes the context of use for this module "topic" : [{ CodeableConcept }], // Descriptional topics for the module "contributor" : [{ Contributor }], // A content contributor "publisher" : "<string>", // Name of the publisher (Organization or individual) "contact" : [{ ContactDetail }], // Contact details of the publisher "copyright" : "<string>", // Use and/or publishing restrictions "relatedResource" : [{ RelatedResource }], // Related resources for the module "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked "parameter" : [{ ParameterDefinition }], // Parameters to the module "dataRequirement" : [{ DataRequirement }] // Data requirements for the module }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:DecisionSupportServiceModule; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:DecisionSupportServiceModule.url [ uri ]; # 0..1 Logical URL to reference this module fhir:DecisionSupportServiceModule.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the module fhir:DecisionSupportServiceModule.version [ string ]; # 0..1 The version of the module, if any fhir:DecisionSupportServiceModule.name [ string ]; # 0..1 A machine-friendly name for the module fhir:DecisionSupportServiceModule.title [ string ]; # 0..1 A user-friendly title for the module fhir:DecisionSupportServiceModule.status [ code ]; # 1..1 draft | active | inactive fhir:DecisionSupportServiceModule.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage fhir:DecisionSupportServiceModule.description [ string ]; # 0..1 Natural language description of the module fhir:DecisionSupportServiceModule.purpose [ string ]; # 0..1 Describes the purpose of the module fhir:DecisionSupportServiceModule.usage [ string ]; # 0..1 Describes the clinical usage of the module fhir:DecisionSupportServiceModule.publicationDate [ date ]; # 0..1 Publication date for this version of the module fhir:DecisionSupportServiceModule.lastReviewDate [ date ]; # 0..1 Last review date for the module fhir:DecisionSupportServiceModule.effectivePeriod [ Period ]; # 0..1 The effective date range for the module fhir:DecisionSupportServiceModule.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this module fhir:DecisionSupportServiceModule.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the module fhir:DecisionSupportServiceModule.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:DecisionSupportServiceModule.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual) fhir:DecisionSupportServiceModule.contact [ ContactDetail ], ... ; # 0..* Contact details of the publisher fhir:DecisionSupportServiceModule.copyright [ string ]; # 0..1 Use and/or publishing restrictions fhir:DecisionSupportServiceModule.relatedResource [ RelatedResource ], ... ; # 0..* Related resources for the module fhir:DecisionSupportServiceModule.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked fhir:DecisionSupportServiceModule.parameter [ ParameterDefinition ], ... ; # 0..* Parameters to the module fhir:DecisionSupportServiceModule.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements for the module ]
Changes since DSTU2
This resource did not exist in Release 2
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DecisionSupportServiceModule | DomainResource | A description of decision support service functionality | ||
url | Σ | 0..1 | uri | Logical URL to reference this module |
identifier | Σ | 0..* | Identifier | Logical identifier(s) for the module |
version | Σ | 0..1 | string | The version of the module, if any |
name | Σ | 0..1 | string | A machine-friendly name for the module |
title | Σ | 0..1 | string | A user-friendly title for the module |
status | ?!Σ | 1..1 | code | draft | active | inactive LibraryStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | If for testing purposes, not real usage |
description | 0..1 | string | Natural language description of the module | |
purpose | 0..1 | string | Describes the purpose of the module | |
usage | 0..1 | string | Describes the clinical usage of the module | |
publicationDate | 0..1 | date | Publication date for this version of the module | |
lastReviewDate | 0..1 | date | Last review date for the module | |
effectivePeriod | 0..1 | Period | The effective date range for the module | |
coverage | 0..* | UsageContext | Describes the context of use for this module | |
topic | 0..* | CodeableConcept | Descriptional topics for the module | |
contributor | 0..* | Contributor | A content contributor | |
publisher | 0..1 | string | Name of the publisher (Organization or individual) | |
contact | 0..* | ContactDetail | Contact details of the publisher | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
relatedResource | 0..* | RelatedResource | Related resources for the 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 --> <url value="[uri]"/><!-- 0..1 Logical URL to reference this module --> <identifier><!-- 0..* Identifier Logical identifier(s) for the module --></identifier> <version value="[string]"/><!-- 0..1 The version of the module, if any --> <name value="[string]"/><!-- 0..1 A machine-friendly name for the module --> <title value="[string]"/><!-- 0..1 A user-friendly title for the module --> <status value="[code]"/><!-- 1..1 draft | active | inactive --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <description value="[string]"/><!-- 0..1 Natural language description of the module --> <purpose value="[string]"/><!-- 0..1 Describes the purpose of the module --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module --> <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the module --> <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the module --> <effectivePeriod><!-- 0..1 Period The effective date range for the module --></effectivePeriod> <coverage><!-- 0..* UsageContext Describes the context of use for this module --></coverage> <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) --> <contact><!-- 0..* ContactDetail Contact details of the publisher --></contact> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedResource><!-- 0..* RelatedResource Related resources for the module --></relatedResource> <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 "url" : "<uri>", // Logical URL to reference this module "identifier" : [{ Identifier }], // Logical identifier(s) for the module "version" : "<string>", // The version of the module, if any "name" : "<string>", // A machine-friendly name for the module "title" : "<string>", // A user-friendly title for the module "status" : "<code>", // R! draft | active | inactive "experimental" : <boolean>, // If for testing purposes, not real usage "description" : "<string>", // Natural language description of the module "purpose" : "<string>", // Describes the purpose of the module "usage" : "<string>", // Describes the clinical usage of the module "publicationDate" : "<date>", // Publication date for this version of the module "lastReviewDate" : "<date>", // Last review date for the module "effectivePeriod" : { Period }, // The effective date range for the module "coverage" : [{ UsageContext }], // Describes the context of use for this module "topic" : [{ CodeableConcept }], // Descriptional topics for the module "contributor" : [{ Contributor }], // A content contributor "publisher" : "<string>", // Name of the publisher (Organization or individual) "contact" : [{ ContactDetail }], // Contact details of the publisher "copyright" : "<string>", // Use and/or publishing restrictions "relatedResource" : [{ RelatedResource }], // Related resources for the module "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked "parameter" : [{ ParameterDefinition }], // Parameters to the module "dataRequirement" : [{ DataRequirement }] // Data requirements for the module }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:DecisionSupportServiceModule; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:DecisionSupportServiceModule.url [ uri ]; # 0..1 Logical URL to reference this module fhir:DecisionSupportServiceModule.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the module fhir:DecisionSupportServiceModule.version [ string ]; # 0..1 The version of the module, if any fhir:DecisionSupportServiceModule.name [ string ]; # 0..1 A machine-friendly name for the module fhir:DecisionSupportServiceModule.title [ string ]; # 0..1 A user-friendly title for the module fhir:DecisionSupportServiceModule.status [ code ]; # 1..1 draft | active | inactive fhir:DecisionSupportServiceModule.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage fhir:DecisionSupportServiceModule.description [ string ]; # 0..1 Natural language description of the module fhir:DecisionSupportServiceModule.purpose [ string ]; # 0..1 Describes the purpose of the module fhir:DecisionSupportServiceModule.usage [ string ]; # 0..1 Describes the clinical usage of the module fhir:DecisionSupportServiceModule.publicationDate [ date ]; # 0..1 Publication date for this version of the module fhir:DecisionSupportServiceModule.lastReviewDate [ date ]; # 0..1 Last review date for the module fhir:DecisionSupportServiceModule.effectivePeriod [ Period ]; # 0..1 The effective date range for the module fhir:DecisionSupportServiceModule.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this module fhir:DecisionSupportServiceModule.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the module fhir:DecisionSupportServiceModule.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:DecisionSupportServiceModule.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual) fhir:DecisionSupportServiceModule.contact [ ContactDetail ], ... ; # 0..* Contact details of the publisher fhir:DecisionSupportServiceModule.copyright [ string ]; # 0..1 Use and/or publishing restrictions fhir:DecisionSupportServiceModule.relatedResource [ RelatedResource ], ... ; # 0..* Related resources for the module fhir:DecisionSupportServiceModule.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked fhir:DecisionSupportServiceModule.parameter [ ParameterDefinition ], ... ; # 0..* Parameters to the module fhir:DecisionSupportServiceModule.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements for the module ]
Changes since DSTU2
This resource did not exist in Release 2
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
DecisionSupportServiceModule.status | The status of the decision support service module | Required | LibraryStatus |
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.description |
identifier | token | Logical identifier for the module (e.g. CMS-143) | DecisionSupportServiceModule.identifier |
status | token | Status of the module | DecisionSupportServiceModule.status |
title | string | Text search against the title | DecisionSupportServiceModule.title |
topic | token | Topics associated with the module | DecisionSupportServiceModule.topic |
version | string | Version of the module (e.g. 1.0.0) | DecisionSupportServiceModule.version |