Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.10 Resource DecisionSupportServiceModule - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

The DecisionSupportServiceModule resource describes decision support functionality that is available as a service.

4.10.1 Scope and Usage

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. Future updates to this resource will incorporate documentation from that guide.

This resource is referenced by guidanceresponse

4.10.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DecisionSupportServiceModule DomainResourceA description of decision support service functionality
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... moduleMetadata 0..1Reference(ModuleMetadata)Metadata for the service module
... parameter 0..*BackboneElementParameters to the module
.... name 0..1codeParameter name
.... use 1..1code
OperationParameterUse (Required)
.... documentation 0..1stringA brief description of the parameter
.... type 1..1code
Parameter Types used in Operation Definitions (Required)
.... profile 0..1Reference(StructureDefinition)The profile of the parameter, any
.... mustSupport 0..*stringIndicates that specific structure elements are referenced by the knowledge module
.... codeFilter 0..*BackboneElementCode filters for the required data, if any
..... path 1..1stringThe code-valued attribute of the filter
..... valueSet[x] 0..1The valueset for the code filter
...... valueSetUriuri
...... valueSetReferenceReference(ValueSet)
..... codeableConcept 0..*CodeableConceptThe codeableConcepts for the filter
.... dateFilter 0..*BackboneElementDate filters for the required data, if any
..... path 1..1stringThe date-valued attribute of the filter
..... value[x] 0..1The value of the filter, as a Period or dateTime value
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

UML Diagram

DecisionSupportServiceModule (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource describing the metadata for the decision support service modulemoduleMetadata : Reference [0..1] « ModuleMetadata »ParameterThe name of the parametername : code [0..1]Whether the parameter is input or output for the moduleuse : code [1..1] « Whether the parameter is input or output (Strength=Required)OperationParameterUse! »A brief discussion of what the parameter is for and how it is used by the moduledocumentation : string [0..1]The type of the parametertype : code [1..1] « The type of the parameter (Strength=Required)Parameter Types used in Opera...! »If specified, this indicates a profile that the input data must conform to, or that the output data will conform toprofile : Reference [0..1] « StructureDefinition »Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are availablemustSupport : string [0..*]CodeFilterThe code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConceptpath : string [1..1]The valueset for the code filter. The valueSet or codeableConcept elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valuesetvalueSet[x] : Type [0..1] « uri|Reference(ValueSet) »The codeable concept for the code filter. Only one of valueSet or codeableConcept may be specified. If codeableConcepts are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codeable conceptscodeableConcept : CodeableConcept [0..*]DateFilterThe date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timingpath : string [1..1]The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTimevalue[x] : Type [0..1] « dateTime|Period »Indicates that incoming data for this parameter is expected to match the given code filter. In other words, every instance should have a value for the path element that comes from the specified value set (or list of concepts)codeFilter[0..*]Indicates that incoming data for this parameter is expected to match the given date filter. In other words, every instance should have a value for the path element that is equal to the given datetime (or within the given Period)dateFilter[0..*]The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponseparameter[0..*]

XML Template

<DecisionSupportServiceModule xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) Metadata for the service module --></moduleMetadata>
 <parameter>  <!-- 0..* Parameters to the module -->
  <name value="[code]"/><!-- 0..1 Parameter name -->
  <use value="[code]"/><!-- 1..1  -->
  <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
  <type value="[code]"/><!-- 1..1  -->
  <profile><!-- 0..1 Reference(StructureDefinition) The profile of the parameter, any --></profile>
  <mustSupport value="[string]"/><!-- 0..* Indicates that specific structure elements are referenced by the knowledge module -->
  <codeFilter>  <!-- 0..* Code filters for the required data, if any -->
   <path value="[string]"/><!-- 1..1 The code-valued attribute of the filter -->
   <valueSet[x]><!-- 0..1 uri|Reference(ValueSet) The valueset for the code filter --></valueSet[x]>
   <codeableConcept><!-- 0..* CodeableConcept The codeableConcepts for the filter --></codeableConcept>
  </codeFilter>
  <dateFilter>  <!-- 0..* Date filters for the required data, if any -->
   <path value="[string]"/><!-- 1..1 The date-valued attribute of the filter -->
   <value[x]><!-- 0..1 dateTime|Period The value of the filter, as a Period or dateTime value --></value[x]>
  </dateFilter>
 </parameter>
</DecisionSupportServiceModule>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DecisionSupportServiceModule DomainResourceA description of decision support service functionality
... identifier Σ0..*IdentifierLogical identifier
... version Σ0..1stringThe version of the module, if any
... moduleMetadata 0..1Reference(ModuleMetadata)Metadata for the service module
... parameter 0..*BackboneElementParameters to the module
.... name 0..1codeParameter name
.... use 1..1code
OperationParameterUse (Required)
.... documentation 0..1stringA brief description of the parameter
.... type 1..1code
Parameter Types used in Operation Definitions (Required)
.... profile 0..1Reference(StructureDefinition)The profile of the parameter, any
.... mustSupport 0..*stringIndicates that specific structure elements are referenced by the knowledge module
.... codeFilter 0..*BackboneElementCode filters for the required data, if any
..... path 1..1stringThe code-valued attribute of the filter
..... valueSet[x] 0..1The valueset for the code filter
...... valueSetUriuri
...... valueSetReferenceReference(ValueSet)
..... codeableConcept 0..*CodeableConceptThe codeableConcepts for the filter
.... dateFilter 0..*BackboneElementDate filters for the required data, if any
..... path 1..1stringThe date-valued attribute of the filter
..... value[x] 0..1The value of the filter, as a Period or dateTime value
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

UML Diagram

DecisionSupportServiceModule (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource describing the metadata for the decision support service modulemoduleMetadata : Reference [0..1] « ModuleMetadata »ParameterThe name of the parametername : code [0..1]Whether the parameter is input or output for the moduleuse : code [1..1] « Whether the parameter is input or output (Strength=Required)OperationParameterUse! »A brief discussion of what the parameter is for and how it is used by the moduledocumentation : string [0..1]The type of the parametertype : code [1..1] « The type of the parameter (Strength=Required)Parameter Types used in Opera...! »If specified, this indicates a profile that the input data must conform to, or that the output data will conform toprofile : Reference [0..1] « StructureDefinition »Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are availablemustSupport : string [0..*]CodeFilterThe code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConceptpath : string [1..1]The valueset for the code filter. The valueSet or codeableConcept elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valuesetvalueSet[x] : Type [0..1] « uri|Reference(ValueSet) »The codeable concept for the code filter. Only one of valueSet or codeableConcept may be specified. If codeableConcepts are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codeable conceptscodeableConcept : CodeableConcept [0..*]DateFilterThe date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timingpath : string [1..1]The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTimevalue[x] : Type [0..1] « dateTime|Period »Indicates that incoming data for this parameter is expected to match the given code filter. In other words, every instance should have a value for the path element that comes from the specified value set (or list of concepts)codeFilter[0..*]Indicates that incoming data for this parameter is expected to match the given date filter. In other words, every instance should have a value for the path element that is equal to the given datetime (or within the given Period)dateFilter[0..*]The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponseparameter[0..*]

XML Template

<DecisionSupportServiceModule xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) Metadata for the service module --></moduleMetadata>
 <parameter>  <!-- 0..* Parameters to the module -->
  <name value="[code]"/><!-- 0..1 Parameter name -->
  <use value="[code]"/><!-- 1..1  -->
  <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
  <type value="[code]"/><!-- 1..1  -->
  <profile><!-- 0..1 Reference(StructureDefinition) The profile of the parameter, any --></profile>
  <mustSupport value="[string]"/><!-- 0..* Indicates that specific structure elements are referenced by the knowledge module -->
  <codeFilter>  <!-- 0..* Code filters for the required data, if any -->
   <path value="[string]"/><!-- 1..1 The code-valued attribute of the filter -->
   <valueSet[x]><!-- 0..1 uri|Reference(ValueSet) The valueset for the code filter --></valueSet[x]>
   <codeableConcept><!-- 0..* CodeableConcept The codeableConcepts for the filter --></codeableConcept>
  </codeFilter>
  <dateFilter>  <!-- 0..* Date filters for the required data, if any -->
   <path value="[string]"/><!-- 1..1 The date-valued attribute of the filter -->
   <value[x]><!-- 0..1 dateTime|Period The value of the filter, as a Period or dateTime value --></value[x]>
  </dateFilter>
 </parameter>
</DecisionSupportServiceModule>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.10.2.1 Terminology Bindings

PathDefinitionTypeReference
DecisionSupportServiceModule.parameter.use Whether the parameter is input or outputRequiredOperationParameterUse
DecisionSupportServiceModule.parameter.type The type of the parameterRequiredParameter Types used in Operation Definitions