Quality Measure Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-cqm/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cqm/OperationDefinition/cqm-data-requirements | Version: 2.0.0 | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: DataRequirements | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.61.33.2 | |||||
The data-requirements operation aggregates and returns the parameters and data requirements for a measure or set of measures and all dependencies as a single module definition
Language: en
URL: [base]/$data-requirements
URL: [base]/Measure/$data-requirements
URL: [base]/Measure/[id]/$data-requirements
URL: [base]/Library/$data-requirements
URL: [base]/Library/[id]/$data-requirements
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | 0..* | uri | Identifies a measure or other artifact for which data requirements will be determined (specified as an optionally-versioned canonical reference). The server must know the measure or artifact (i.e. it is defined explicitly in the server's measures or artifacts). It is an error to use this parameter when the operation is invoked on an instance. Note that for backwards compatibility, canonical references in artifact operation parameters are represented using the | ||
| IN | parameters | 0..1 | Parameters | Any input parameters for the artifact(s). If the artifact is a logic library, or references logic libraries, parameters defined in this input will be bound by name to parameters defined in the logic library (or referenced libraries). If the logic library is a CQL library, parameter types are mapped to CQL as specified in the Using CQL with FHIR implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL. | ||
| IN | periodStart | 0..1 | date | The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive | ||
| IN | periodEnd | 0..1 | date | The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive | ||
| IN | defaultArtifactVersion | 0..* | uri | Specifies a version to use for a canonical or artifact resource if the artifact referencing the resource does not already specify a version. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 Note that this is a generalization of the | ||
| IN | checkArtifactVersion | 0..* | uri | Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing the resource specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 Note that this is a generalization of the | ||
| IN | forceArtifactVersion | 0..* | uri | Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any specified version in the artifact (and any artifacts it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the version of a canonical is overridden, the version used SHALL explicitly be represented in the expansion parameters. Note that this is a generalization of the | ||
| IN | manifest | 0..1 | canonical (CRMI Manifest Library) | Specifies an asset-collection library that defines version bindings for code systems and other canonical resources referenced by the value set(s) being expanded and other canonical resources referenced by the artifact. When specified, the expansion parameters of the manifest are used to provide expansion behavior and canonical resolution for dependencies encountered while processing the operation. | ||
| IN | artifactEndpointConfiguration | 0..* | Configuration information to resolve canonical artifacts
Processing semantics: Create a canonical-like reference (e.g.
Rank each
NOTE: For evenly ranked | |||
| IN | artifactEndpointConfiguration.artifactRoute | 0..1 | uri | |||
| IN | artifactEndpointConfiguration.endpointUri | 0..1 | uri | |||
| IN | artifactEndpointConfiguration.endpoint | 0..1 | Endpoint | |||
| OUT | return | 1..1 | Library | The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure(s). |
The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure or set of measures. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements). This operation defines what resources are subsequently referenced in the evaluatedResources element of the MeasureReport when submitting measure data