Data Exchange For Quality Measures STU3 for FHIR R4
2.1.0 - Ballot

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v2.1.0: STU 3) based on FHIR R4. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

: Consumer Client CapabilityStatement - JSON Representation

Raw json | Download

{
  "resourceType" : "CapabilityStatement",
  "id" : "consumer-client",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">Consumer Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.1.0</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-07-05</li><li>Published by: HL7 International - Clinical Quality Information Work Group</li></ul><p><p>This profile defines the expected capabilities of a Da Vinci DEQM Consumer Client 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 <em>recommended</em>  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Consumer Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements.</p></p><h3 id=\"igs\" class=\"no_toc\">SHALL Support the Following Implementation Guides:</h3><ul><li><a href=\"http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore%7C4.0.0\">http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0</a></li></ul><ul><li><a href=\"http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures%7C2.0.0\">http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0</a></li></ul><h3 id=\"behavior\">FHIR RESTful Capabilities</h3><p>Da Vinci DEQM Consumer Client <strong>SHALL</strong> support the Collect Data  transaction defined in the <em>Framework</em> Section of  this  Implementation Guide.</p><p id=\"security\"><strong>Security:</strong></p><p>For general security consideration refer to the <a href=\"http://hl7.org/fhir/R4/secpriv-module.html\">Security and Privacy Considerations</a>.</p><p><strong>Summary of System Wide Interactions</strong></p><li><strong>MAY</strong> support the\t<code>transaction</code> interaction.</li><li><strong>MAY</strong> support the\t<code>batch</code> interaction.</li><li><strong>MAY</strong> support the\t<code>search-system</code> interaction.</li><li><strong>MAY</strong> support the\t<code>history-system</code> interaction.</li><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#measure\">Measure</a></td><td><a href=\"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm\">CQFM Measure</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\tcollect-data\n\t\t\t\t\t\t</td></tr><tr><td><a href=\"#measurereport\">MeasureReport</a></td><td><a href=\"StructureDefinition-datax-measurereport-deqm.html\">DEQM Data Exchange MeasureReport Profile</a></td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n              \n            </td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr></tbody></table><br/><h4 id=\"measure\" class=\"no_toc\">Measure</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm\">CQFM Measure</a>\n\t\t\t\t\n\t\t\t\t</p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li></ul><p>Operation  Summary:</p><ul><li><strong>SHOULD</strong> support the \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<a href=\"http://hl7.org/fhir/OperationDefinition/Measure-collect-data\">$collect-data</a> operation\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Client <strong>SHOULD</strong> be capable of fetching a Measure resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Measure/[id]</code>\n\t\t\t\t</li><br/>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id=\"measurereport\" class=\"no_toc\">MeasureReport</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:\n\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t<a href=\"StructureDefinition-datax-measurereport-deqm.html\">DEQM Data Exchange MeasureReport Profile</a>\n\t\t\t\t\n\t\t\t\t</p><p>Resource Specific Documentation:</p><blockquote><p>The DaVinci DEQM Consumer Client <strong>SHOULD</strong> be capable of supporting the DEQM MeasureReport Profile and all the DEQM, CQFM and QI Core Profiles they reference.</p></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA Client <strong>SHOULD</strong> be capable of fetching a MeasureReport resource using:\n\t\t\t\t\t<br/>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/MeasureReport/[id]</code>\n\t\t\t\t</li><br/>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><br/></div>"
  },
  "url" : "http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/consumer-client",
  "version" : "2.1.0",
  "name" : "ConsumerClientCapabilityStatement",
  "title" : "Consumer Client CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-07-05",
  "publisher" : "HL7 International - Clinical Quality Information Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cqi/index.cfm"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of a Da Vinci DEQM Consumer Client 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 Client could support. Clients 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|2.1.0",
    "http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0",
    "http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "Da Vinci DEQM Consumer Client **SHALL** support the Collect Data  transaction defined in the *Framework* Section of  this  Implementation Guide.\n",
      "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/us/cqfmeasures/StructureDefinition/measure-cqfm"
          ],
          "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" : "SHOULD"
                }
              ],
              "name" : "collect-data",
              "definition" : "http://hl7.org/fhir/OperationDefinition/Measure-collect-data"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "MeasureReport",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/datax-measurereport-deqm"
          ],
          "documentation" : "The DaVinci DEQM Consumer Client **SHOULD** be capable of supporting the DEQM MeasureReport Profile and all the DEQM, CQFM and QI Core Profiles they reference.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read"
            }
          ]
        }
      ],
      "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"
        }
      ]
    }
  ]
}