Quality Measure Implementation Guide (STU3)
3.0.0 - STU 3
US
Quality Measure Implementation Guide (STU3)
3.0.0 - STU 3
US
This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v3.0.0: STU3) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Draft as of 2019-11-01 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "MeasureReport-package"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ];
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>MeasureReportPackaging</h2><p>OPERATION: MeasureReportPackaging</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/MeasureReport-package</pre><div><p>Packages a measure report test case artifact for a target environment, optionally including artifact components and dependencies.</p>\n</div><p>URL: [base]/MeasureReport/$package</p><p>URL: [base]/MeasureReport/[id]/$package</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>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 the measure test case to package. The server must know the MeasureReport (e.g. it is defined explicitly in the server's test cases)</p>\n</div></td></tr><tr><td>IN</td><td>identifier</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 measure test case to be packaged. The server must know the measure test case and the identifier must resolve unambiguously to a single measure test case on the server.</p>\n</div></td></tr><tr><td>IN</td><td>capability</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>offset</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>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>system-version</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 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</p>\n</div></td></tr><tr><td>IN</td><td>check-system-version</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 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</p>\n</div></td></tr><tr><td>IN</td><td>force-system-version</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 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</p>\n</div></td></tr><tr><td>IN</td><td>manifest</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 artifacts, including code systems, referenced by the value set(s) being expanded. When specified, code systems identified as <code>depends-on</code> related artifacts in the library have the same meaning as specifying that code system version in the <code>system-version</code> parameter.</p>\n</div></td></tr><tr><td>IN</td><td>include-dependencies</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Specifies whether to include known (i.e. present on the server) dependencies of the measure test case in the resulting package, recursively (default = true)</p>\n</div></td></tr><tr><td>IN</td><td>include-components</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Specifies whether to include known (i.e. present on the server) components of the measure test case in the resulting package, recursively (default = true)</p>\n</div></td></tr><tr><td>OUT</td><td>return</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 measure test case that are known to the server (if include-dependencies is true), and all the component resources referenced by the measure test case 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.</p>\n</div></td></tr></table><div><p>This operation is used to package the contents associated with a specific measure test case, including component and dependent required artifacts, 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.</p>\n</div></div>"
];
fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/MeasureReport-package"];
fhir:OperationDefinition.version [ fhir:value "3.0.0"];
fhir:OperationDefinition.name [ fhir:value "MeasureReportPackaging"];
fhir:OperationDefinition.title [ fhir:value "MeasureReport Packaging"];
fhir:OperationDefinition.status [ fhir:value "draft"];
fhir:OperationDefinition.kind [ fhir:value "operation"];
fhir:OperationDefinition.date [ fhir:value "2019-11-01T09:29:23+11:00"^^xsd:dateTime];
fhir:OperationDefinition.publisher [ fhir:value "Clinical Quality Information WG"];
fhir:OperationDefinition.contact [
fhir:index 0;
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/cqi" ] ]
];
fhir:OperationDefinition.description [ fhir:value "Packages a measure report test case artifact for a target environment, optionally including artifact components and dependencies."];
fhir:OperationDefinition.jurisdiction [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
fhir:Coding.code [ fhir:value "US" ] ]
];
fhir:OperationDefinition.code [ fhir:value "package"];
fhir:OperationDefinition.comment [ fhir:value "This operation is used to package the contents associated with a specific measure test case, including component and dependent required artifacts, 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."];
fhir:OperationDefinition.resource [
fhir:value "MeasureReport";
fhir:index 0
];
fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean];
fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean];
fhir:OperationDefinition.instance [ fhir:value "true"^^xsd:boolean];
fhir:OperationDefinition.parameter [
fhir:index 0;
fhir:OperationDefinition.parameter.name [ fhir:value "id" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "The logical id of the measure test case to package. The server must know the MeasureReport (e.g. it is defined explicitly in the server's test cases)" ];
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 1;
fhir:OperationDefinition.parameter.name [ fhir:value "identifier" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "A business identifier of the measure test case to be packaged. The server must know the measure test case and the identifier must resolve unambiguously to a single measure test case on the server." ];
fhir:OperationDefinition.parameter.type [ fhir:value "string" ];
fhir:OperationDefinition.parameter.searchType [ fhir:value "token" ]
], [
fhir:index 2;
fhir:OperationDefinition.parameter.name [ fhir:value "capability" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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." ];
fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
], [
fhir:index 3;
fhir:OperationDefinition.parameter.name [ fhir:value "offset" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)" ];
fhir:OperationDefinition.parameter.type [ fhir:value "integer" ]
], [
fhir:index 4;
fhir:OperationDefinition.parameter.name [ fhir:value "count" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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." ];
fhir:OperationDefinition.parameter.type [ fhir:value "integer" ]
], [
fhir:index 5;
fhir:OperationDefinition.parameter.name [ fhir:value "system-version" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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" ];
fhir:OperationDefinition.parameter.type [ fhir:value "canonical" ]
], [
fhir:index 6;
fhir:OperationDefinition.parameter.name [ fhir:value "check-system-version" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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" ];
fhir:OperationDefinition.parameter.type [ fhir:value "canonical" ]
], [
fhir:index 7;
fhir:OperationDefinition.parameter.name [ fhir:value "force-system-version" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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" ];
fhir:OperationDefinition.parameter.type [ fhir:value "canonical" ]
], [
fhir:index 8;
fhir:OperationDefinition.parameter.name [ fhir:value "manifest" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "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." ];
fhir:OperationDefinition.parameter.type [ fhir:value "canonical" ]
], [
fhir:index 9;
fhir:OperationDefinition.parameter.name [ fhir:value "include-dependencies" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "Specifies whether to include known (i.e. present on the server) dependencies of the measure test case in the resulting package, recursively (default = true)" ];
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 10;
fhir:OperationDefinition.parameter.name [ fhir:value "include-components" ];
fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "Specifies whether to include known (i.e. present on the server) components of the measure test case in the resulting package, recursively (default = true)" ];
fhir:OperationDefinition.parameter.type [ fhir:value "boolean" ]
], [
fhir:index 11;
fhir:OperationDefinition.parameter.name [ fhir:value "return" ];
fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ];
fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
fhir:OperationDefinition.parameter.documentation [ fhir:value "The result of the packaging. Servers generating packages SHALL include all the dependency resources referenced by the measure test case that are known to the server (if include-dependencies is true), and all the component resources referenced by the measure test case 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." ];
fhir:OperationDefinition.parameter.type [ fhir:value "Bundle" ]
].
# - ontology header ------------------------------------------------------------
a owl:Ontology;
owl:imports fhir:fhir.ttl.
IG © 2019+ Clinical Quality Information WG. Package hl7.fhir.us.cqfmeasures#3.0.0 based on FHIR 4.0.1. Generated 2022-04-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change