Da Vinci Value-Based Performance Reporting Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the Da Vinci Value-Based Performance Reporting Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: VBP Reporting Client Capability Statement - JSON Representation

Active as of 2023-06-25

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "vbp-reporting-client",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>VBPReportingClientCapabilityStatement</h2><div><p>This profile defines the expected capabilities of the Value-Based Performance (VBP) Reporting Client actor, when request and consume value-based performance MeasureReports from a Value-Based Performance Reporting Server. The complete list of FHIR profiles\nthat a VBP Reporting Server could support are defined. VBP Reporting Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.</p>\n</div><table><tr><td>Mode</td><td>CLIENT</td></tr><tr><td>Description</td><td><div><p>Da Vinci Value-Based Performance Reporting Server <strong>SHALL</strong> support the profiles specified in this implementation guide.</p>\n</div></td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET past versions of resources (vread interaction)\">V-Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th><th><b title=\"GET changes to a resource (history interaction on instance)\">Updates</b></th><th><b title=\"GET changes for all resources of the type (history interaction on type)\">History</b></th></tr><tr><td>Measure</td><td><a href=\"http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure\">http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure</a></td><td>y</td><td>y</td><td>y</td><td></td><td></td><td>y</td><td>y</td></tr><tr><td>MeasureReport</td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-vbp-performance-measurereport.html\">Value-Based Performance MeasureReport</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-vbp-quality-measurereport.html\">VBP Quality MeasureReport</a></td><td>y</td><td>y</td><td>y</td><td></td><td></td><td>y</td><td>y</td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-client",
  "version" : "1.0.0-ballot",
  "name" : "VBPReportingClientCapabilityStatement",
  "title" : "VBP Reporting Client Capability Statement",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-06-25",
  "publisher" : "HL7 Clinical Quality Information Work Group",
  "contact" : [
    {
      "name" : "HL7 Clinical Quality Information Work Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of the Value-Based Performance (VBP) Reporting Client actor, when request and consume value-based performance MeasureReports from a Value-Based Performance Reporting Server. The complete list of FHIR profiles \r\nthat a VBP Reporting Server could support are defined. VBP Reporting Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "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/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "Da Vinci Value-Based Performance Reporting Server **SHALL** support the profiles specified in this implementation guide.",
      "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" : "MAY"
            }
          ],
          "type" : "Measure",
          "profile" : "http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Read allows maintainers of the Measures to get the logical definitions of the Measure"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "history-instance"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Search allows maintainers of the Measures to find the logical definition of a Measure"
            }
          ]
        },
        {
          "type" : "MeasureReport",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-performance-measurereport",
            "http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-quality-measurereport"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Read allows maintainers of the MeasureReports to get the logical definitions of the MeasureReports"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "history-instance"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Search allows maintainers of the MeasureReports to find the logical definition of a MeasureReport"
            }
          ],
          "conditionalCreate" : true,
          "conditionalUpdate" : true,
          "conditionalDelete" : "multiple",
          "referencePolicy" : [
            "literal",
            "logical"
          ],
          "searchInclude" : [
            "MeasureReport.evaluatedResources"
          ],
          "searchParam" : [
            {
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-date",
              "type" : "date"
            },
            {
              "name" : "evaluatedResource",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-evaluated-resource",
              "type" : "reference"
            },
            {
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-identifier",
              "type" : "token"
            },
            {
              "name" : "measure",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-measure",
              "type" : "reference"
            },
            {
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-patient",
              "type" : "reference"
            },
            {
              "name" : "period",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-period",
              "type" : "date"
            },
            {
              "name" : "reporter",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-reporter",
              "type" : "reference"
            },
            {
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-status",
              "type" : "token"
            },
            {
              "name" : "subject",
              "definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-subject",
              "type" : "reference"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "code" : "batch"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "code" : "transaction"
        },
        {
          "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"
        }
      ]
    }
  ]
}