Quality Measure Implementation Guide (STU5)
5.0.0-ballot - ballot
Quality Measure Implementation Guide (STU5)
5.0.0-ballot - ballot
This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions
| Draft as of 2019-11-01 |
{
"resourceType" : "OperationDefinition",
"id" : "cqfm-package",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/$cqfm.package</p><p>URL: [base]/Library/$cqfm.package</p><p>URL: [base]/Library/[id]/$cqfm.package</p><p>URL: [base]/Measure/$cqfm.package</p><p>URL: [base]/Measure/[id]/$cqfm.package</p><p>URL: [base]/MeasureReport/$cqfm.package</p><p>URL: [base]/MeasureReport/[id]/$cqfm.package</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The logical id of an existing Resource to package on the server.</p>\n</div></td></tr><tr><td>IN</td><td>url</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>A canonical reference to a Resource to package on the server.</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The version of the Resource</p>\n</div></td></tr><tr><td>IN</td><td>identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>A business identifier of the Resource.</p>\n</div></td></tr><tr><td>IN</td><td>capability</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A desired capability of the resulting package. <code>computable</code> to include computable elements in packaged content; <code>executable</code> to include executable elements in packaged content; <code>publishable</code> to include publishable elements in packaged content.</p>\n</div></td></tr><tr><td>IN</td><td>canonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Specifies a version to use for a canonical 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 <code>system-version</code> parameter to the $expand operation to apply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>checkCanonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical 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 <code>check-system-version</code> parameter to the $expand operation to apply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>forceCanonicalVersion</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a canonical 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 overriden, the version used SHALL explicitly be represented in the expansion parameters. Note that this is a generalization of the <code>force-system-version</code> parameter to the $expand operation to apply to any canonical resource, including code systems.</p>\n</div></td></tr><tr><td>IN</td><td>manifest</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>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, code systems and other canonical resources identified as <code>depends-on</code> related artifacts in the manifest library have the same meaning as specifying that code system or other canonical version in the <code>system-version</code> parameter of an expand or the <code>canonicalVersion</code> parameter.</p>\n</div></td></tr><tr><td>IN</td><td>offset</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)</p>\n</div></td></tr><tr><td>IN</td><td>count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>IN</td><td>include</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible values are: * all (default) - all resource types * artifact - the specified artifact * canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension) * terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap) * conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition) * profiles - profile definitions (i.e. StructureDefinition resources that define profiles) * extensions - extension definitions (i.e. StructureDefinition resources that define extensions) * knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire) * tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide) * examples - example resources (i.e. resources identified as examples in the implementation guide)</p>\n</div></td></tr><tr><td>IN</td><td>packageOnly</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>True to indicate that the resulting package should only include resources that are defined in the implementation guide or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should include resources regardless of what implementation guide or specification they are defined in.</p>\n</div></td></tr><tr><td>IN</td><td>contentEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the artifact. If no content endpoint is supplied the evaluation will attempt to retrieve content from the server on which the operation is being performed.</p>\n</div></td></tr><tr><td>IN</td><td>terminologyEndpoint</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/endpoint.html\">Endpoint</a></td><td/><td><div><p>An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and membership testing) referenced by the Resource. If no terminology endpoint is supplied, the evaluation will attempt to use the server on which the operation is being performed as the terminology server.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The result of the packaging. Servers generating packages SHALL include all the dependency resources referenced by the artifact that are known to the server and specified by the include parameters. For example, a measure repository SHALL include all the required library resources, but would not necessarily have the ValueSet resources referenced by the measure.</p>\n</div></td></tr></table><div><p>This operation is used to package the contents associated with a specific measure artifact, measure test case or library (such as a quality program, including the use of the quality program).</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cqi"
}
],
"url" : "http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/cqfm-package",
"version" : "5.0.0-ballot",
"name" : "CQFMPackage",
"title" : "CQFM Package",
"status" : "draft",
"kind" : "operation",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "HL7 International / Clinical Quality Information",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description" : "Packages a specified canonical resource with dependencies.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"code" : "cqfm.package",
"comment" : "This operation is used to package the contents associated with a specific measure artifact, measure test case or library (such as a quality program, including the use of the quality program).",
"resource" : [
"Library",
"Measure",
"MeasureReport"
],
"system" : true,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "id",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The logical id of an existing Resource to package on the server.",
"type" : "string"
},
{
"name" : "url",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A canonical reference to a Resource to package on the server.",
"type" : "uri"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the Resource",
"type" : "string"
},
{
"name" : "identifier",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A business identifier of the Resource.",
"type" : "string",
"searchType" : "token"
},
{
"name" : "capability",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "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.",
"type" : "string"
},
{
"name" : "canonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies a version to use for a canonical 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 `system-version` parameter to the $expand operation to apply to any canonical resource, including code systems.",
"type" : "canonical"
},
{
"name" : "checkCanonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical 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 `check-system-version` parameter to the $expand operation to apply to any canonical resource, including code systems.",
"type" : "canonical"
},
{
"name" : "forceCanonicalVersion",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Edge Case: Specifies a version to use for a canonical 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 overriden, the version used SHALL explicitly be represented in the expansion parameters. Note that this is a generalization of the `force-system-version` parameter to the $expand operation to apply to any canonical resource, including code systems.",
"type" : "canonical"
},
{
"name" : "manifest",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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, code systems and other canonical resources identified as `depends-on` related artifacts in the manifest library have the same meaning as specifying that code system or other canonical version in the `system-version` parameter of an expand or the `canonicalVersion` parameter.",
"type" : "canonical"
},
{
"name" : "offset",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)",
"type" : "integer"
},
{
"name" : "count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "integer"
},
{
"name" : "include",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Specifies what contents should be included in the resulting package. The codes indicate which types of resources should be included, but note that the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts. Possible values are: * all (default) - all resource types * artifact - the specified artifact * canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension) * terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap) * conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition) * profiles - profile definitions (i.e. StructureDefinition resources that define profiles) * extensions - extension definitions (i.e. StructureDefinition resources that define extensions) * knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire) * tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide) * examples - example resources (i.e. resources identified as examples in the implementation guide)",
"type" : "string"
},
{
"name" : "packageOnly",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "True to indicate that the resulting package should only include resources that are defined in the implementation guide or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should include resources regardless of what implementation guide or specification they are defined in.",
"type" : "boolean"
},
{
"name" : "contentEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access content (i.e. libraries, activities, measures, questionnaires, and plans) referenced by the artifact. If no content endpoint is supplied the evaluation will attempt to retrieve content from the server on which the operation is being performed.",
"type" : "Endpoint"
},
{
"name" : "terminologyEndpoint",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and membership testing) referenced by the Resource. If no terminology endpoint is supplied, the evaluation will attempt to use the server on which the operation is being performed as the terminology server.",
"type" : "Endpoint"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The result of the packaging. Servers generating packages SHALL include all the dependency resources referenced by the artifact that are known to the server and specified by the include parameters. For example, a measure repository SHALL include all the required library resources, but would not necessarily have the ValueSet resources referenced by the measure.",
"type" : "Bundle"
}
]
}
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.cqfmeasures#5.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change