CMS Hospital Quality Reporting FHIR Implementation Guide
0.1.0 - ci-build
CMS Hospital Quality Reporting FHIR Implementation Guide
0.1.0 - ci-build
CMS Hospital Quality Reporting FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-08-03 |
{
"resourceType" : "CapabilityStatement",
"id" : "HQRSubmitterCapabilityStatement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement HQRSubmitterCapabilityStatement</b></p><a name=\"HQRSubmitterCapabilityStatement\"> </a><a name=\"hcHQRSubmitterCapabilityStatement\"> </a><h2 id=\"title\">HQR Submitter CapabilityStatement (DRAFT 0.1.0)</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2026-08-03 </li><li>Published by: Centers for Medicare & Medicaid Services (CMS) </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><h3 id=\"rest1\">REST Configuration: 1 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"><div><p>Submitter invokes $submit-data / creates a MeasureReport on the Receiver, authenticated per the (still provisional) auth pattern, and receives an acceptance/status response.</p>\n</div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/us/davinci-deqm/STU5/OperationDefinition-submit-data.html\">$submit-data</a></td><td><div/></td></tr></tbody></table></div></div></div></div><h3 id=\"rest2\">REST Configuration: 2 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode2\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"><div><p>Results retrieval. Submitter reads/searches the Receiver for the submission's status and results after the fact, independent of the original synchronous response.</p>\n</div></div></div><h4 id=\"resourcesCap2\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary2\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#MeasureReport2-1\">MeasureReport</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"MeasureReport2-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MeasureReport</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/measurereport.html\">MeasureReport</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/></div></div></div><h3 id=\"rest3\">REST Configuration: 3 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode3\" class=\"panel-title\">Mode: <code>server</code></h4></div><div class=\"panel-body\"><div><p>Invited-pull concept, not yet a committed capability. If pursued, Submitter would expose a Bulk Data $export endpoint for the Receiver to pull from once invited.</p>\n</div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/bulkdata/STU3/OperationDefinition-export.html\">$export</a></td><td><div/></td></tr></tbody></table></div></div></div></div><h3 id=\"rest4\">REST Configuration: 4 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode4\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"><div><p>Invited-pull concept, not yet a committed capability. If pursued, Submitter would invoke $bulk-submit-data against the Receiver to indicate a dataset is ready and where to pull it from (the ping half of ping-and-pull).</p>\n</div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/us/davinci-deqm/STU5/OperationDefinition-bulk-submit-data.html\">$bulk-submit-data</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div>"
},
"url" : "http://example.org/fhir/us/hqr/CapabilityStatement/HQRSubmitterCapabilityStatement",
"version" : "0.1.0",
"title" : "HQR Submitter CapabilityStatement (DRAFT 0.1.0)",
"status" : "draft",
"date" : "2026-08-03",
"publisher" : "Centers for Medicare & Medicaid Services (CMS)",
"contact" : [
{
"name" : "Centers for Medicare & Medicaid Services (CMS)",
"telecom" : [
{
"system" : "url",
"value" : "https://www.cms.gov"
}
]
}
],
"description" : "DRAFT. Submitter pushes a MeasureReport via $submit-data / create, then retrieves status and results via read/search. Invited-pull entries below describe a second exchange pattern this guide is exploring, not yet a committed capability.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "Submitter invokes $submit-data / creates a MeasureReport on the Receiver, authenticated per the (still provisional) auth pattern, and receives an acceptance/status response.",
"operation" : [
{
"name" : "submit-data",
"definition" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/submit-data"
}
]
},
{
"mode" : "client",
"documentation" : "Results retrieval. Submitter reads/searches the Receiver for the submission's status and results after the fact, independent of the original synchronous response.",
"resource" : [
{
"type" : "MeasureReport",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
]
}
]
},
{
"mode" : "server",
"documentation" : "Invited-pull concept, not yet a committed capability. If pursued, Submitter would expose a Bulk Data $export endpoint for the Receiver to pull from once invited.",
"operation" : [
{
"name" : "export",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0"
}
]
},
{
"mode" : "client",
"documentation" : "Invited-pull concept, not yet a committed capability. If pursued, Submitter would invoke $bulk-submit-data against the Receiver to indicate a dataset is ready and where to pull it from (the ping half of ping-and-pull).",
"operation" : [
{
"name" : "bulk-submit-data",
"definition" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data"
}
]
}
]
}