XIG: CapabilityStatement/ra-reporting-server

FHIR IG Statistics: CapabilityStatement/ra-reporting-server

Package	hl7.fhir.us.davinci-ra
Type	CapabilityStatement
Id	ra-reporting-server
FHIR Version	R4
Source	http://hl7.org/fhir/us/davinci-ra/https://build.fhir.org/ig/HL7/davinci-ra/CapabilityStatement-ra-reporting-server.html
URL	http://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-reporting-server
Version	2.1.0
Status	active
Date	2025-07-24T18:33:11+00:00
Name	RAServerCapabilityStatement
Title	Risk Adjustment Reporting Server Capability Statement
Realm	us
Authority	hl7
Description	This profile defines the expected capabilities of a Da Vinci Risk Adjustment Reporting Server when conforming to the Da Vinci Risk Adjustment Implementation Guide for interactions between Reporting Clients and Reporting Servers. Servers are the actors receiving the request for Risk Adjustment Coding Gap Reports for patient(s) and for Risk Adjustmenet Models that are available on the Server. This CapabilityStatement resource includes the complete list of the recommended Da Vinci Risk Adjustment profiles and RESTful operations that a Risk Adjustment Reporting Server could support. Servers have the option of choosing from this list based on their local use cases and other contextual requirements.
Copyright	Used by permission of HL7 International, all rights reserved Creative Commons License
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.us.davinci-ra	Da Vinci Risk Adjustment Implementation Guide

OperationDefinition
ra.evaluate-measure	Evaluate Measure

SearchParameter
measurereport-category	MeasureReportCategory

StructureDefinition
ra-measurereport-bundle	Risk Adjustment Coding Gap Report Bundle
ra-measurereport	Risk Adjustment Coding Gap MeasureReport
ra-model-measure	Risk Adjustment Model Measure

Narrative

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

Generated Narrative: CapabilityStatement ra-reporting-server

Risk Adjustment Reporting Server Capability Statement

Implementation Guide Version: 2.1.0
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats: application/json-patch+json
Published on: 2025-07-24 18:33:11+0000
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

http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/hl7.fhir.us.davinci-ra

FHIR RESTful Capabilities

Mode: `server`

Da Vinci Risk Adjustment Reporting Server SHALL support the operation and profiles specified in this implementation guide.

Security

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

Summary of System-wide Interactions

SHOULD support the batchinteraction.
MAY support the transactioninteraction.
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 Type	Profile	R	V-R	S	U	P	C	D	H-I	H-T	Searches	`_include`	Operations
Measure	Supported Profiles Risk Adjustment Model Measure	y											`$ra.evaluate-measure`
MeasureReport	Supported Profiles Risk Adjustment Coding Gap MeasureReport	y	y	y	y	y	y	y	y	y	date, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-category	`MeasureReport.evaluatedResources`
Bundle	Supported Profiles Risk Adjustment Coding Gap Report Bundle	y	y	y	y	y	y	y	y	y

Resource Conformance: MAY Measure

Core FHIR Resource
Measure

Reference Policy

Interaction summary

SHALL support read.

Supported Profiles

Risk Adjustment Model Measure

Extended Operations

Conformance	Operation	Documentation
MAY	$ra.evaluate-measure

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

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

create
Create allows maintainers of the MeasureReports to create 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

Risk Adjustment Coding Gap MeasureReport

Search Parameters

Conformance	Parameter	Type
SHALL	date	`date`
SHALL	measure	`reference`
SHALL	patient	`reference`
SHALL	period	`date`
SHALL	status	`token`
SHALL	subject	`reference`
SHALL	measurereport-category	`token`
SHOULD	evaluatedResource	`reference`
MAY	identifier	`token`
MAY	reporter	`reference`

Resource Conformance: MAY Bundle

Core FHIR Resource
Bundle

Reference Policy
literal, logical

Interaction summary

SHALL support
read
Read allows maintainers of the Bundles to get the logical definitions of the Bundle

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

patch
Patch allows maintainers of the Bundles to update the logical definition of a Bundles by posting a set of changes to it

delete
Delete allows maintainers of the Bundles to delete the logical definition of a Bundles

create
Create allows maintainers of the Bundles to create the logical definition of a Bundle

search-type
Search allows maintainers of the Bundles to find the logical definition of a Bundle
MAY support vread, history-instance, history-type.

Supported Profiles

Risk Adjustment Coding Gap Report Bundle

Source

{
  "resourceType": "CapabilityStatement",
  "id": "ra-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": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/davinci-ra"
          }
        ]
      }
    },
    {
      "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-ra/ImplementationGuide/davinci-ra"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-reporting-server",
  "version": "2.1.0",
  "name": "RAServerCapabilityStatement",
  "title": "Risk Adjustment Reporting Server Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2025-07-24T18:33:11+00:00",
  "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 Risk Adjustment Reporting Server when conforming to the Da Vinci Risk Adjustment Implementation Guide for interactions between Reporting Clients and Reporting Servers. Servers are the actors receiving the request for Risk Adjustment Coding Gap Reports for patient(s) and for Risk Adjustmenet Models that are available on the Server. This CapabilityStatement resource includes the complete list of the *recommended* Da Vinci Risk Adjustment profiles and RESTful operations that a Risk Adjustment Reporting 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",
          "display": "United States of America"
        }
      ]
    }
  ],
  "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/hl7.fhir.us.davinci-ra"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Da Vinci Risk Adjustment Reporting Server **SHALL** support the operation and 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",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-model-measure"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "ra.evaluate-measure",
              "definition": "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/ra.evaluate-measure"
            }
          ]
        },
        {
          "type": "MeasureReport",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-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": "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": "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": "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": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "evaluatedResource",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-evaluated-resource",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "measure",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-measure",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-patient",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "period",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-period",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "reporter",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-reporter",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/MeasureReport-subject",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "measurereport-category",
              "definition": "http://hl7.org/fhir/us/davinci-ra/SearchParameter/measurereport-category",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "type": "Bundle",
          "supportedProfile": [
            "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read allows maintainers of the Bundles to get the logical definitions of the Bundle"
            },
            {
              "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": "update",
              "documentation": "Update allows maintainers of the Bundles to update the logical definitions of a Bundles 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 Bundles to update the logical definition of a Bundles 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 Bundles to delete the logical definition of a Bundles"
            },
            {
              "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": "create",
              "documentation": "Create allows maintainers of the Bundles to create the logical definition of a Bundle"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search allows maintainers of the Bundles to find the logical definition of a Bundle"
            }
          ],
          "conditionalCreate": true,
          "conditionalUpdate": true,
          "conditionalDelete": "multiple",
          "referencePolicy": [
            "literal",
            "logical"
          ]
        }
      ],
      "interaction": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "code": "batch"
        },
        {
          "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": "search-system"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "code": "history-system"
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/ra-reporting-server

Resources that use this resource

Resources that this resource uses

Narrative

Risk Adjustment Reporting Server Capability Statement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: MAY Measure

Resource Conformance: SHALL MeasureReport

Resource Conformance: MAY Bundle

Source

Mode: `server`