Quality Measure Implementation Guide (STU4)
4.0.0-ballot - ballot US

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v4.0.0-ballot: STU 4 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

: MeasureReport Packaging - XML Representation

Draft as of 2019-11-01

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="MeasureReport-package"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</div></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/cqfmeasures/OperationDefinition/MeasureReport-package"/>
  <version value="3.0.0"/>
  <name value="MeasureReportPackaging"/>
  <title value="MeasureReport Packaging"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2019-11-01T09:29:23+11:00"/>
  <publisher value="Clinical Quality Information WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cqi"/>
    </telecom>
  </contact>
  <description
               value="Packages a measure report test case artifact for a target environment, optionally including artifact components and dependencies."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="package"/>
  <comment
           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."/>
  <resource value="MeasureReport"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="id"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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)"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="identifier"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="capability"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   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."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="offset"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)"/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="count"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   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"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="check-system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   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"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="force-system-version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   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"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="manifest"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="include-dependencies"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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)"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="include-components"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   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)"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   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."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>