FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/vbp-reporting-server

Packagehl7.fhir.us.davinci-vbpr
Resource TypeCapabilityStatement
Idvbp-reporting-server
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-vbpr/https://build.fhir.org/ig/HL7/davinci-vbpr/CapabilityStatement-vbp-reporting-server.html
URLhttp://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-server
Version1.1.0
Statusactive
Date2024-04-25
NameVBPReportingServerCapabilityStatement
TitleVBP Reporting Server Capability Statement
Realmus
Authorityhl7
DescriptionThis profile defines the expected capabilities of the Value-Based Performance (VBP) Reporting Server actor which is responsible for producing value-based performance MeasureReports to be consumed by a Value-Based Performance Reporting Client. The complete list of FHIR profiles and search parameters that a VBP Reporting Server could support are defined. VBP Reporting Servers have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.us.davinci-deqmData Exchange For Quality Measures Implementation Guide
hl7.fhir.us.cqfmeasuresQuality Measure Implementation Guide
SearchParameter
measurereport-categoryMeasureReportCategory
measurereport-subject-organizationMeasureReportSubjectOrganization
StructureDefinition
vbp-measureValue-Based Performance Measure
vbp-performance-measurereportValue-Based Performance MeasureReport
vbp-quality-measurereportVBP Quality MeasureReport

Narrative

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

Generated Narrative: CapabilityStatement vbp-reporting-server

VBP Reporting Server Capability Statement

  • Implementation Guide Version: 1.1.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: server

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
  • SHALL support the transactioninteraction.
  • SHOULD support the batchinteraction.
  • MAY support the search-systeminteraction.
  • MAY support 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 TypeProfileRV-RSUPCDH-IH-TSearches_include_revincludeOperations
Measurehttp://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measureyyyyyyyyy
MeasureReportSupported Profiles
  Value-Based Performance MeasureReport
  VBP Quality MeasureReport		yyyyyyyyydate, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-category, measurereport-subject-organizationMeasureReport.evaluatedResources

Resource Conformance: MAY Measure

Base System Profile
Value-Based Performance Measure
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    read

    Read allows maintainers of the Measures to get the logical definitions of the Measure

    create

    Create allows maintainers of the Measures to create the logical definition of a Measure

    update

    Update allows maintainers of the Measures to update the logical definitions of a Measure by its id or create a new one if it is new

    patch

    Patch allows maintainers of the Measures to update the logical definition of a Measure by posting a set of changes to it

    delete

    Delete allows maintainers of the Measures to delete the logical definition of a Measure

    search-type

    Search allows maintainers of the Measures to find the logical definition of a Measure

  • MAY support vread, history-instance, history-type.

Resource Conformance: SHALL MeasureReport

Core FHIR Resource
MeasureReport
Reference Policy
literal, logical
Interaction summary
  • SHALL support
    read

    Read allows maintainers of the MeasureReports to get the logical definitions of the MeasureReports

    create

    Create allows maintainers of the MeasureReports to create the logical definition of a MeasureReport

    update

    Update allows maintainers of the MeasureReports to update the logical definitions of a MeasureReport by its id or create a new one if it is new

    patch

    Patch allows maintainers of the MeasureReports to update the logical definition of a MeasureReport by posting a set of changes to it

    delete

    Delete allows maintainers of the MeasureReports to delete the logical definition of a MeasureReport

    search-type

    Search allows maintainers of the MeasureReports to find the logical definition of a MeasureReport

  • MAY support vread, history-instance, history-type.

Supported Profiles

Value-Based Performance MeasureReport
VBP Quality MeasureReport

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLevaluatedResourcereference
SHALLidentifiertoken
SHALLmeasurereference
SHALLpatientreference
SHALLperioddate
SHALLreporterreference
SHALLstatustoken
SHALLsubjectreference
SHALLmeasurereport-categorytoken
SHALLmeasurereport-subject-organizationreference
 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "vbp-reporting-server",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cqi"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-vbpr/ImplementationGuide/hl7.fhir.us.davinci-vbpr"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-vbpr/ImplementationGuide/hl7.fhir.us.davinci-vbpr"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-server",
  "version": "1.1.0",
  "name": "VBPReportingServerCapabilityStatement",
  "title": "VBP Reporting Server 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 Server actor which is responsible for producing value-based performance MeasureReports to be consumed by a Value-Based Performance Reporting Client. The complete list of FHIR profiles \r\nand search parameters that a VBP Reporting Server could support are defined. VBP Reporting Servers 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": "server",
      "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": "create",
              "documentation": "Create allows maintainers of the Measures to create the logical definition of a Measure"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Update allows maintainers of the Measures to update the logical definitions of a Measure by its id or create a new one if it is new"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "patch",
              "documentation": "Patch allows maintainers of the Measures to update the logical definition of a Measure by posting a set of changes to it"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "delete",
              "documentation": "Delete allows maintainers of the Measures to delete the logical definition of a Measure"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "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": "create",
              "documentation": "Create allows maintainers of the MeasureReports to create the logical definition of a MeasureReport"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Update allows maintainers of the MeasureReports to update the logical definitions of a MeasureReport by its id or create a new one if it is new"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "patch",
              "documentation": "Patch allows maintainers of the MeasureReports to update the logical definition of a MeasureReport by posting a set of changes to it"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "delete",
              "documentation": "Delete allows maintainers of the MeasureReports to delete the logical definition of a MeasureReport"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "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": "token"
            },
            {
              "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": "SHALL"
            }
          ],
          "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"
        }
      ]
    }
  ]
}