Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot
Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot
This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (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
| Active as of 2020-07-05 |
{
"resourceType" : "CapabilityStatement",
"id" : "consumer-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement consumer-server</b></p><a name=\"consumer-server\"> </a><a name=\"hcconsumer-server\"> </a><a name=\"consumer-server-en-US\"> </a><h2 id=\"title\">Consumer Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 5.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2020-07-05 </li><li>Published by: HL7 International / Clinical Quality Information </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><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm</a></li><li><a href=\"http://hl7.org/fhir/us/qicore/STU6/ImplementationGuide-hl7.fhir.us.qicore.html\">http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore</a></li><li><a href=\"http://hl7.org/fhir/us/cqfmeasures/2024May/index.html\">http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Da Vinci DEQM Consumer Server <strong>SHALL</strong></p>\n<ol>\n<li>Support the Submit Data transaction defined in the <em>Framework</em> Section of this Implementation Guide.</li>\n<li>Declare a CapabilityStatement identifying the list of supported profiles and operations.\n<ul>\n<li>Use the <a href=\"StructureDefinition-extension-submitDataUpdateType.html\">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange.</li>\n</ul>\n</li>\n<li>Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for <a href=\"http://hl7.org/fhir/R4/operations.html\">Extended Operations on the RESTful API </a>.</li>\n<li>Support both xml and json resource formats for all interactions.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>For general security consideration refer to the <a href=\"http://hl7.org/fhir/R4/secpriv-module.html\">Security and Privacy Considerations</a>.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>MAY</strong>Supports the <code>transaction</code>interaction.</li><li><strong>MAY</strong>Supports the <code>batch</code>interaction.</li><li><strong>MAY</strong>Supports the <code>search-system</code>interaction.</li><li><strong>MAY</strong>Supports the <code>history-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><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=\"#Measure1-1\">Measure</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/uv/crmi/1.0.0-snapshot/StructureDefinition-crmi-shareablemeasure.html\">CRMI Shareable Measure</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td><code>$data-requirements</code>, <code>$submit-data</code>, <code>$bulk-submit-data</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Measure1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Measure</h4></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/measure.html\">Measure</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><strong>SHOULD</strong>support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/uv/crmi/1.0.0-snapshot/StructureDefinition-crmi-shareablemeasure.html\">http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemeasure</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended 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>$data-requirements</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$submit-data</td><td><div><p><strong>SHALL</strong> Use the <a href=\"StructureDefinition-extension-submitDataUpdateType.html\">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange. <strong>SHALL</strong> reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome <strong>SHOULD</strong> be returned stating that the [snapshot/incremental] update is not supported .</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"OperationDefinition-bulk-submit-data.html\">$bulk-submit-data</a></td><td><div><p><strong>SHALL</strong> Use the <a href=\"StructureDefinition-extension-submitDataUpdateType.html\">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange. <strong>SHALL</strong> reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome <strong>SHOULD</strong> be returned stating that the [snapshot/incremental] update is not supported .</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cqi"
}
],
"url" : "http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/consumer-server",
"version" : "5.0.0-ballot",
"name" : "ConsumerServerCapabilityStatement",
"title" : "Consumer Server CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2020-07-05",
"publisher" : "HL7 International / Clinical Quality Information",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description" : "This profile defines the expected capabilities of a Da Vinci DEQM Consumer Server when conforming to the Da Vinci DEQM Implementation Guide. Consumers include systems that are primary consumers of patient healthcare information and systems that consume data from Producers. This CapabilityStatement resource includes the complete list of the *recommended* Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Consumer Server could support. Servers have the option of choosing from this list based on their local use cases and other contextual requirements.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"patchFormat" : [
"application/json-patch+json"
],
"implementationGuide" : [
🔗 "http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm"🔗 ,
"http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore"🔗 ,
"http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures"
],
"rest" : [
{
"mode" : "server",
"documentation" : "Da Vinci DEQM Consumer Server **SHALL**\n\n1. Support the Submit Data transaction defined in the *Framework* Section of this Implementation Guide.\n1. Declare a CapabilityStatement identifying the list of supported profiles and operations.\n - Use the [DEQM Submit Data Update Type Extension](StructureDefinition-extension-submitDataUpdateType.html) to indicate whether it whether it supports snapshot or incremental data exchange.\n1. Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for [Extended Operations on the RESTful API ](http://hl7.org/fhir/R4/operations.html).\n1. Support both xml and json resource formats for all interactions.",
"security" : {
"description" : "For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Measure",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemeasure"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType",
"valueCode" : "incremental"
}
],
"name" : "submit-data",
"definition" : "http://hl7.org/fhir/OperationDefinition/Measure-submit-data",
"documentation" : "**SHALL** Use the [DEQM Submit Data Update Type Extension](StructureDefinition-extension-submitDataUpdateType.html) to indicate whether it whether it supports snapshot or incremental data exchange. **SHALL** reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome **SHOULD** be returned stating that the [snapshot/incremental] update is not supported ."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType",
"valueCode" : "incremental"
}
],
"name" : "bulk-submit-data",
"definition" : "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data",
"documentation" : "**SHALL** Use the [DEQM Submit Data Update Type Extension](StructureDefinition-extension-submitDataUpdateType.html) to indicate whether it whether it supports snapshot or incremental data exchange. **SHALL** reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome **SHOULD** be returned stating that the [snapshot/incremental] update is not supported ."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}
IG © 2020+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.davinci-deqm#5.0.0-ballot based on FHIR 4.0.1. Generated 2024-08-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change