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

FHIR IG Statistics: CapabilityStatement/ra-reporting-client

Packagehl7.fhir.us.davinci-ra
TypeCapabilityStatement
Idra-reporting-client
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-ra/https://build.fhir.org/ig/HL7/davinci-ra/CapabilityStatement-ra-reporting-client.html
URLhttp://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-reporting-client
Version2.1.0
Statusactive
Date2025-06-30T21:15:44+00:00
NameRAClientCapabilityStatement
TitleRisk Adjustment Reporting Client Capability Statement
Realmus
Authorityhl7
DescriptionThis profile defines the expected capabilities of a Da Vinci Risk Adjustment Reporting Client when conforming to the Da Vinci Risk Adjustment Implementation Guide for interactions between Reporting Clients and Reporting Servers. Clients are the actors making 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 Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements.
CopyrightUsed by permission of HL7 International, all rights reserved Creative Commons License
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.us.davinci-raDa Vinci Risk Adjustment Implementation Guide
SearchParameter
measurereport-categoryMeasureReportCategory
StructureDefinition
ra-measurereport-bundleRisk Adjustment Coding Gap Report Bundle
ra-measurereportRisk Adjustment Coding Gap MeasureReport

Narrative

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

Generated Narrative: CapabilityStatement ra-reporting-client

Risk Adjustment Reporting Client 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-06-30 21:15:44+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

FHIR RESTful Capabilities

Mode: client

Da Vinci Risk Adjustment Reporting Client 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 TypeProfileRSUPCH-IH-TSearches_include_revincludeOperations
MeasureReportSupported Profiles
  Risk Adjustment Coding Gap MeasureReport		yyyyyydate, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-categoryMeasureReport:evaluatedResources
BundleSupported Profiles
  Risk Adjustment Coding Gap Report Bundle		yyyy

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

    search-type

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

  • MAY support history-instance, history-type
    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

Supported Profiles

Risk Adjustment Coding Gap MeasureReport

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLmeasurereference
SHALLpatientreference
SHALLperioddate
SHALLstatustoken
SHALLsubjectreference
SHALLmeasurereport-categorytoken
SHOULDevaluatedResourcereference
MAYidentifiertoken
MAYreporterreference
 

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

    search-type

    Search allows maintainers of the Bundles to find the logical definition of a Bundle

  • MAY support history-instance, history-type.

Supported Profiles

Risk Adjustment Coding Gap Report Bundle

Source

{
  "resourceType": "CapabilityStatement",
  "id": "ra-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/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-client",
  "version": "2.1.0",
  "name": "RAClientCapabilityStatement",
  "title": "Risk Adjustment Reporting Client Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2025-06-30T21:15:44+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 Client when conforming to the Da Vinci Risk Adjustment Implementation Guide for interactions between Reporting Clients and Reporting Servers. Clients are the actors making 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 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",
          "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": "client",
      "documentation": "Da Vinci Risk Adjustment Reporting Client **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": [
        {
          "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": "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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "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": "MAY"
                }
              ],
              "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"
            }
          ],
          "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": "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 Bundles to find the logical definition of a Bundle"
            }
          ],
          "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"
        }
      ]
    }
  ]
}