STU 3 Candidate

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

4.17.4 Resource ModuleDefinition - Detailed Descriptions

Detailed Descriptions for the elements in the ModuleDefinition resource.

ModuleDefinition
Definition

The ModuleDefinition resource defines the data requirements for a quality artifact.

Control1..1
ModuleDefinition.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
ModuleDefinition.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 version id (see discussion)
Control0..1
Typestring
Summarytrue
ModuleDefinition.model
Definition

A model reference used by the content.

Control0..*
ModuleDefinition.model.name
Definition

The name of the model.

Control0..1
Typestring
ModuleDefinition.model.identifier
Definition

The identifier of the model.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
Typestring
ModuleDefinition.model.version
Definition

The version of the model.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
ModuleDefinition.library
Definition

A library referenced by the module. The reference must consist of either an id, or a document reference.

Control0..*
ModuleDefinition.library.name
Definition

The local name for the library reference. If no local name is provided, the name of the referenced library is assumed.

Control0..1
Typestring
ModuleDefinition.library.identifier
Definition

The identifier of the library.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
Typestring
ModuleDefinition.library.version
Definition

The version of the library.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
ModuleDefinition.library.document[x]
Definition

A reference to the library.

Control0..1
TypeAttachment|Reference(ModuleDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ModuleDefinition.codeSystem
Definition

A code system definition used within the knowledge module.

Control0..*
ModuleDefinition.codeSystem.name
Definition

The local name for the code system.

Control1..1
Typestring
ModuleDefinition.codeSystem.identifier
Definition

The code system uri.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
Typestring
ModuleDefinition.codeSystem.version
Definition

The code system version, if any.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
ModuleDefinition.valueSet
Definition

A value set definition used by the knowledge module.

Control0..*
ModuleDefinition.valueSet.name
Definition

The local name for the value set.

Control1..1
Typestring
ModuleDefinition.valueSet.identifier
Definition

The value set uri.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
Typestring
ModuleDefinition.valueSet.version
Definition

The version of the value set, if any.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
ModuleDefinition.valueSet.codeSystem
Definition

The code systems in use within the value set. These must refer to previously defined code systems within this knowledge module or a referenced library.

Control0..*
Typestring
ModuleDefinition.parameter
Definition

Parameters to the module.

Control0..*
ModuleDefinition.parameter.name
Definition

The name of the parameter.

Control1..1
Typecode
ModuleDefinition.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
ModuleDefinition.parameter.documentation
Definition

A brief description of the parameter.

Control0..1
Typestring
ModuleDefinition.parameter.type
Definition

The type of the parameter.

Control1..1
BindingFHIRDefinedType: Any defined Resource or Data Type name
Typecode
ModuleDefinition.parameter.profile
Definition

The profile of the parameter, if any.

Control0..1
TypeReference(StructureDefinition)
ModuleDefinition.data
Definition

Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.

Control0..*
ModuleDefinition.data.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

Control1..1
BindingFHIRDefinedType: Any defined Resource or Data Type name
Typecode
ModuleDefinition.data.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

Control0..1
TypeReference(StructureDefinition)
ModuleDefinition.data.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
ModuleDefinition.data.codeFilter
Definition

Code filters for the required data, if any.

Control0..*
ModuleDefinition.data.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
ModuleDefinition.data.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
Typestring|Reference(ValueSet)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ModuleDefinition.data.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
ModuleDefinition.data.dateFilter
Definition

Date filters for the required data, if any.

Control0..*
ModuleDefinition.data.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
ModuleDefinition.data.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]