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
Detailed Descriptions for the elements in the ModuleDefinition resource.
ModuleDefinition | |
Definition | The ModuleDefinition resource defines the data requirements for a quality artifact. |
Control | 1..1 |
ModuleDefinition.identifier | |
Definition | A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
ModuleDefinition.model | |
Definition | A model reference used by the content. |
Control | 0..* |
ModuleDefinition.model.name | |
Definition | The name of the model. |
Control | 0..1 |
Type | string |
ModuleDefinition.model.identifier | |
Definition | The identifier of the model. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | string |
ModuleDefinition.model.version | |
Definition | The version of the model. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
ModuleDefinition.library | |
Definition | A library referenced by the module. The reference must consist of either an id, or a document reference. |
Control | 0..* |
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. |
Control | 0..1 |
Type | string |
ModuleDefinition.library.identifier | |
Definition | The identifier of the library. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | string |
ModuleDefinition.library.version | |
Definition | The version of the library. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
ModuleDefinition.library.document[x] | |
Definition | A reference to the library. |
Control | 0..1 |
Type | Attachment|Reference(ModuleDefinition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ModuleDefinition.codeSystem | |
Definition | A code system definition used within the knowledge module. |
Control | 0..* |
ModuleDefinition.codeSystem.name | |
Definition | The local name for the code system. |
Control | 1..1 |
Type | string |
ModuleDefinition.codeSystem.identifier | |
Definition | The code system uri. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | string |
ModuleDefinition.codeSystem.version | |
Definition | The code system version, if any. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
ModuleDefinition.valueSet | |
Definition | A value set definition used by the knowledge module. |
Control | 0..* |
ModuleDefinition.valueSet.name | |
Definition | The local name for the value set. |
Control | 1..1 |
Type | string |
ModuleDefinition.valueSet.identifier | |
Definition | The value set uri. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | string |
ModuleDefinition.valueSet.version | |
Definition | The version of the value set, if any. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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. |
Control | 0..* |
Type | string |
ModuleDefinition.parameter | |
Definition | Parameters to the module. |
Control | 0..* |
ModuleDefinition.parameter.name | |
Definition | The name of the parameter. |
Control | 1..1 |
Type | code |
ModuleDefinition.parameter.use | |
Definition | Whether the parameter is input or output for the module. |
Control | 1..1 |
Binding | OperationParameterUse: Whether the parameter is input or output (Required) |
Type | code |
ModuleDefinition.parameter.documentation | |
Definition | A brief description of the parameter. |
Control | 0..1 |
Type | string |
ModuleDefinition.parameter.type | |
Definition | The type of the parameter. |
Control | 1..1 |
Binding | FHIRDefinedType: Any defined Resource or Data Type name |
Type | code |
ModuleDefinition.parameter.profile | |
Definition | The profile of the parameter, if any. |
Control | 0..1 |
Type | Reference(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. |
Control | 0..* |
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. |
Control | 1..1 |
Binding | FHIRDefinedType: Any defined Resource or Data Type name |
Type | code |
ModuleDefinition.data.profile | |
Definition | The profile of the required data, specified as the uri of the profile definition. |
Control | 0..1 |
Type | Reference(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. |
Control | 0..* |
Type | string |
ModuleDefinition.data.codeFilter | |
Definition | Code filters for the required data, if any. |
Control | 0..* |
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. |
Control | 1..1 |
Type | string |
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. |
Control | 0..1 |
Type | string|Reference(ValueSet) |
[x] Note | See 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. |
Control | 0..* |
Type | CodeableConcept |
ModuleDefinition.data.dateFilter | |
Definition | Date filters for the required data, if any. |
Control | 0..* |
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. |
Control | 1..1 |
Type | string |
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. |
Control | 0..1 |
Type | dateTime|Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |