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.4 Resource DecisionSupportServiceModule - Detailed Descriptions

Detailed Descriptions for the elements in the DecisionSupportServiceModule resource.

DecisionSupportServiceModule
Definition

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

Control1..1
DecisionSupportServiceModule.identifier
Definition

A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
DecisionSupportServiceModule.version
Definition

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 specification.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Summarytrue
DecisionSupportServiceModule.moduleMetadata
Definition

A reference to a ModuleMetadata resource describing the metadata for the decision support service module.

Control0..1
TypeReference(ModuleMetadata)
DecisionSupportServiceModule.parameter
Definition

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 GuidanceResponse.

Control0..*
DecisionSupportServiceModule.parameter.name
Definition

The name of the parameter.

Control0..1
Typecode
DecisionSupportServiceModule.parameter.use
Definition

Whether the parameter is input or output for the module.

Control1..1
BindingOperationParameterUse: Whether the parameter is input or output (Required)
Typecode
DecisionSupportServiceModule.parameter.documentation
Definition

A brief discussion of what the parameter is for and how it is used by the module.

Control0..1
Typestring
DecisionSupportServiceModule.parameter.type
Definition

The type of the parameter.

Control1..1
BindingParameter Types used in Operation Definitions: The type of the parameter (Required)
Typecode
DecisionSupportServiceModule.parameter.profile
Definition

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Control0..1
TypeReference(StructureDefinition)
DecisionSupportServiceModule.parameter.mustSupport
Definition

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 available.

Control0..*
Typestring
DecisionSupportServiceModule.parameter.codeFilter
Definition

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).

Control0..*
DecisionSupportServiceModule.parameter.codeFilter.path
Definition

The 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 CodeableConcept.

Control1..1
Typestring
DecisionSupportServiceModule.parameter.codeFilter.valueSet[x]
Definition

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 valueset.

Control0..1
Typeuri|Reference(ValueSet)
[x] NoteSee Choice of Data Types for further information about how to use [x]
DecisionSupportServiceModule.parameter.codeFilter.codeableConcept
Definition

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 concepts.

Control0..*
TypeCodeableConcept
DecisionSupportServiceModule.parameter.dateFilter
Definition

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).

Control0..*
DecisionSupportServiceModule.parameter.dateFilter.path
Definition

The 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 Timing.

Control1..1
Typestring
DecisionSupportServiceModule.parameter.dateFilter.value[x]
Definition

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 dateTime.

Control0..1
TypedateTime|Period
[x] NoteSee Choice of Data Types for further information about how to use [x]