FHIRsmith: CapabilityStatement/CapabilityStatement-vbp-reporting-client.json

FHIR IG analytics

Package	hl7.fhir.us.davinci-vbpr.r4
Resource Type	CapabilityStatement
Id	CapabilityStatement-vbp-reporting-client.json
FHIR Version	R4

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

VBP Reporting Client Capability Statement

Implementation Guide Version: 1.0.0
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats: application/json-patch+json
Published on: 2024-04-25
Published by: HL7 International / Clinical Quality Information

Note to Implementers: FHIR Capabilities
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.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: `client`

Da Vinci Value-Based Performance Reporting Server SHALL support the profiles specified in this implementation guide.

Security

For general security consideration refer to the Security and Privacy Considerations.

Summary of System-wide Interactions

SHOULDSupports the batchinteraction.
SHOULDSupports the transactioninteraction.
MAYSupports the search-systeminteraction.
MAYSupports the history-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	V-R	S	U	C	H-I	H-T	Searches	`_include`	`_revinclude`	Operations
Measure	http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure	y	y	y			y	y
MeasureReport	Supported Profiles Value-Based Performance MeasureReport VBP Quality MeasureReport	y	y	y			y	y	date, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-category, measurereport-subject-organization	`MeasureReport.evaluatedResources`

Resource Conformance: MAY Measure

Base System Profile
http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALLsupport read, history-instance, search-type.
MAYsupport vread, history-type.

Resource Conformance: SHALL MeasureReport

Core FHIR Resource
MeasureReport

Reference Policy
literal, logical

Interaction summary

SHALLsupport read, history-instance, search-type.
MAYsupport vread, history-type.

Supported Profiles

http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-performance-measurereport
http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-quality-measurereport

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	date	`date`
SHALL	evaluatedResource	`reference`
SHALL	identifier	`token`
SHALL	measure	`reference`
SHALL	patient	`reference`
SHALL	period	`date`
SHALL	reporter	`reference`
SHALL	status	`token`
SHALL	subject	`reference`
SHALL	measurereport-category	`string`
SHALL	measurereport-subject-organization	`reference`

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "vbp-reporting-client",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cqi"
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-client",
  "version": "1.0.0",
  "name": "VBPReportingClientCapabilityStatement",
  "title": "VBP Reporting Client Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2024-04-25",
  "publisher": "HL7 International / Clinical Quality Information",
  "contact": [
    {
      "name": "HL7 International / Clinical Quality Information",
      "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"
            },
            {
              "name": "measurereport-category",
              "definition": "http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-category",
              "type": "string"
            },
            {
              "name": "measurereport-subject-organization",
              "definition": "http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-subject-organization",
              "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"
        }
      ]
    }
  ]
}