Quality Measure Implementation Guide (STU3 Ballot)
2.1.0 - ballot

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.1.0: STU3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: Measure Packaging

MeasurePackaging

OPERATION: MeasurePackaging

The official URL for this operation definition is:

http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/Measure-package

Packages a measure artifact for a target environment and optionally including artifact components and dependencies.

URL: [base]/Measure/$package

URL: [base]/Measure/[id]/$package

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..1string

The logical id of the measure to package. The server must know the measure (e.g. it is defined explicitly in the server's measures)

INurl0..1uri

A canonical reference to a measure. The server must know the measure (e.g. it is defined explicitly in the server's measures)

INversion0..1string

The version of the measure to be used for packaging

INidentifier0..1string
(token)

A business identifier of the measure to be packaged. The server must know the measure and the identifier must resolve unambiguously to a single measure on the server.

INcapability0..*string

A desired capability of the resulting package. computable to include computable elements in packaged content, executable to include executable elements in packaged content, publishable to include publishable elements in packaged content.

INoffset0..1integer

Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)

INcount0..1integer

Paging support - how many resources should be provided in a partial page view. If count = 0, the client is asking how large the package is.

INsystem-version0..*canonical

Specifies a version to use for a system, if the manifest, measure, or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56

INcheck-system-version0..*canonical

Edge Case: Specifies a version to use for a system. If a manifest, measure, or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56

INforce-system-version0..*canonical

Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the manfiest, measure, and value sets (and any they depend 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 value is override, the version used SHALL explicitly be represented in the expansion parameters

INmanifest0..1canonical

Specifies an asset-collection library that defines version bindings for artifacts, including code systems, referenced by the value set(s) being expanded. When specified, code systems identified as depends-on related artifacts in the library have the same meaning as specifying that code system version in the system-version parameter.

INinclude-dependencies0..1boolean

Specifies whether to include known (i.e. present on the server) dependencies of the measure in the resulting package, recursively (default = true)

INinclude-components0..1boolean

Specifies whether to include known (i.e. present on the server) components of the measure in the resulting package, recursively (default = true)

OUTreturn1..1Bundle

The result of the packaging. Servers generating packages SHALL include all the dependency resources referenced by the measure that are known to the server (if include-dependencies is true), and all the component resources referenced by the measure that are known to the server (if include-components is true). For example, a measure repository SHALL include all the required library resources, but would not necessarily have the ValueSet resources referenced by the measure.

This operation is used to package the contents associated with a specific measure artifact, including component and dependent required artifacts, test cases, and terminology if available. The mantifest parameter allows a specific version manifest to be used as a binding parameters specification to identify code system and value set versions that should be used for expansion of value sets used by the measure or its components and dependencies.