This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v2.0.0-ballot: STU2 (v2.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Active as of 2023-03-28 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="ra-reporting-client"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2>RAClientCapabilityStatement</h2><div><p>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 <em>recommended</em> 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.</p>
</div><table><tr><td>Mode</td><td>CLIENT</td></tr><tr><td>Description</td><td><div><p>Da Vinci Risk Adjustment Reporting Client <strong>SHALL</strong> support the operation and profiles specified in this implementation guide.</p>
</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="PATCH a new resource version (patch interaction)">Patch</b></th><th><b title="POST a new resource (create interaction)">Create</b></th><th><b title="DELETE a resource (delete interaction)">Delete</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>MeasureReport</td><td><a href="http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport">http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td><td></td><td></td><td>y</td><td>y</td></tr><tr><td>Bundle</td><td><a href="http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle">http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle</a></td><td>y</td><td></td><td>y</td><td></td><td></td><td></td><td></td><td>y</td><td>y</td></tr><tr><td>ImplementationGuide</td><td><a href="http://hl7.org/fhir/StructureDefinition/ImplementationGuide">http://hl7.org/fhir/StructureDefinition/ImplementationGuide</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>CapabilityStatement</td><td><a href="http://hl7.org/fhir/StructureDefinition/CapabilityStatement">http://hl7.org/fhir/StructureDefinition/CapabilityStatement</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td><td>y</td></tr></table></div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-reporting-client"/>
<version value="2.0.0-ballot"/>
<name value="RAClientCapabilityStatement"/>
<title value="Risk Adjustment Reporting Client Capability Statement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-03-28T02:02:49+00:00"/>
<publisher value="HL7 Clinical Quality Information Work Group"/>
<contact>
<name value="HL7 Clinical Quality Information Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cqi"/>
</telecom>
</contact>
<description
value="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 value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7 International - Clinical Quality Information Work Group, all rights reserved Creative Commons License"/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/fhir.us.davinci-ra"/>
<rest>
<mode value="client"/>
<documentation
value="Da Vinci Risk Adjustment Reporting Client **SHALL** support the operation and profiles specified in this implementation guide."/>
<security>
<description
value="For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."/>
</security>
<resource>
<type value="MeasureReport"/>
<profile
value="http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Read allows maintainers of the MeasureReports to get the logical definitions of the MeasureReports"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Search allows maintainers of the MeasureReports to find the logical definition of a MeasureReport"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
<documentation
value="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"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
<documentation
value="Patch allows maintainers of the MeasureReports to update the logical definition of a MeasureReport by posting a set of changes to it"/>
</interaction>
<referencePolicy value="literal"/>
<referencePolicy value="logical"/>
<searchInclude value="MeasureReport.evaluatedResources"/>
<searchParam>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-date"/>
<type value="date"/>
</searchParam>
<searchParam>
<name value="evaluatedResource"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-evaluated-resource"/>
<type value="reference"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-identifier"/>
<type value="token"/>
</searchParam>
<searchParam>
<name value="measure"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-measure"/>
<type value="reference"/>
</searchParam>
<searchParam>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-patient"/>
<type value="reference"/>
</searchParam>
<searchParam>
<name value="period"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-period"/>
<type value="date"/>
</searchParam>
<searchParam>
<name value="reporter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-reporter"/>
<type value="reference"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MeasureReport-subject"/>
<type value="reference"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Read allows maintainers of the Bundles to get the logical definitions of the Bundle"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Search allows maintainers of the Bundles to find the logical definition of a Bundle"/>
</interaction>
<referencePolicy value="literal"/>
<referencePolicy value="logical"/>
</resource>
<resource>
<type value="ImplementationGuide"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/ImplementationGuide"/>
<interaction>
<code value="read"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="vread"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="update"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="patch"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="delete"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="history-instance"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="history-type"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="create"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation value="Implemented per the specification"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<conditionalDelete value="multiple"/>
<referencePolicy value="literal"/>
<referencePolicy value="logical"/>
<searchInclude value="ImplementationGuide.resource"/>
<searchInclude value="ImplementationGuide.global"/>
<searchInclude value="ImplementationGuide.depends-on"/>
<searchRevInclude value="CapabilityStatement.guide"/>
<searchRevInclude value="ImplementationGuide.depends-on"/>
<searchParam>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-date"/>
<type value="date"/>
<documentation value="The implementation guide publication date"/>
</searchParam>
<searchParam>
<name value="context-type-value"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type-value"/>
<type value="composite"/>
<documentation
value="A use context type and value assigned to the implementation guide"/>
</searchParam>
<searchParam>
<name value="resource"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ImplementationGuide-resource"/>
<type value="reference"/>
<documentation value="Location of the resource"/>
</searchParam>
<searchParam>
<name value="jurisdiction"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-jurisdiction"/>
<type value="token"/>
<documentation
value="Intended jurisdiction for the implementation guide"/>
</searchParam>
<searchParam>
<name value="description"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-description"/>
<type value="string"/>
<documentation value="The description of the implementation guide"/>
</searchParam>
<searchParam>
<name value="context-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type"/>
<type value="token"/>
<documentation
value="A type of use context assigned to the implementation guide"/>
</searchParam>
<searchParam>
<name value="experimental"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ImplementationGuide-experimental"/>
<type value="token"/>
<documentation value="For testing purposes, not real usage"/>
</searchParam>
<searchParam>
<name value="global"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ImplementationGuide-global"/>
<type value="reference"/>
<documentation value="Profile that all resources must conform to"/>
</searchParam>
<searchParam>
<name value="title"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-title"/>
<type value="string"/>
<documentation
value="The human-friendly name of the implementation guide"/>
</searchParam>
<searchParam>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
<documentation
value="The business version of the implementation guide"/>
</searchParam>
<searchParam>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
<documentation
value="The uri that identifies the implementation guide"/>
</searchParam>
<searchParam>
<name value="context-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-quantity"/>
<type value="quantity"/>
<documentation
value="A quantity- or range-valued use context assigned to the implementation guide"/>
</searchParam>
<searchParam>
<name value="depends-on"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ImplementationGuide-depends-on"/>
<type value="reference"/>
<documentation value="Identity of the IG that this depends on"/>
</searchParam>
<searchParam>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-name"/>
<type value="string"/>
<documentation
value="Computationally friendly name of the implementation guide"/>
</searchParam>
<searchParam>
<name value="context"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context"/>
<type value="token"/>
<documentation
value="A use context assigned to the implementation guide"/>
</searchParam>
<searchParam>
<name value="publisher"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-publisher"/>
<type value="string"/>
<documentation
value="Name of the publisher of the implementation guide"/>
</searchParam>
<searchParam>
<name value="context-type-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity"/>
<type value="composite"/>
<documentation
value="A use context type and quantity- or range-based value assigned to the implementation guide"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-status"/>
<type value="token"/>
<documentation
value="The current status of the implementation guide"/>
</searchParam>
</resource>
<resource>
<type value="CapabilityStatement"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/CapabilityStatement"/>
<interaction>
<code value="read"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="vread"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="update"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="patch"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="delete"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="history-instance"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="history-type"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="create"/>
<documentation value="Implemented per the specification"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation value="Implemented per the specification"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<conditionalDelete value="multiple"/>
<referencePolicy value="literal"/>
<referencePolicy value="logical"/>
<searchInclude value="CapabilityStatement.resource-profile"/>
<searchInclude value="CapabilityStatement.supported-profile"/>
<searchInclude value="CapabilityStatement.guide"/>
<searchParam>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-date"/>
<type value="date"/>
<documentation value="The capability statement publication date"/>
</searchParam>
<searchParam>
<name value="resource-profile"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile"/>
<type value="reference"/>
<documentation
value="A profile id invoked in a capability statement"/>
</searchParam>
<searchParam>
<name value="context-type-value"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type-value"/>
<type value="composite"/>
<documentation
value="A use context type and value assigned to the capability statement"/>
</searchParam>
<searchParam>
<name value="software"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-software"/>
<type value="string"/>
<documentation value="Part of the name of a software application"/>
</searchParam>
<searchParam>
<name value="resource"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource"/>
<type value="token"/>
<documentation
value="Name of a resource mentioned in a capability statement"/>
</searchParam>
<searchParam>
<name value="jurisdiction"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-jurisdiction"/>
<type value="token"/>
<documentation
value="Intended jurisdiction for the capability statement"/>
</searchParam>
<searchParam>
<name value="format"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-format"/>
<type value="token"/>
<documentation
value="formats supported (xml | json | ttl | mime type)"/>
</searchParam>
<searchParam>
<name value="description"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-description"/>
<type value="string"/>
<documentation value="The description of the capability statement"/>
</searchParam>
<searchParam>
<name value="context-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type"/>
<type value="token"/>
<documentation
value="A type of use context assigned to the capability statement"/>
</searchParam>
<searchParam>
<name value="title"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-title"/>
<type value="string"/>
<documentation
value="The human-friendly name of the capability statement"/>
</searchParam>
<searchParam>
<name value="fhirversion"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion"/>
<type value="token"/>
<documentation value="The version of FHIR"/>
</searchParam>
<searchParam>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
<documentation
value="The business version of the capability statement"/>
</searchParam>
<searchParam>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
<documentation
value="The uri that identifies the capability statement"/>
</searchParam>
<searchParam>
<name value="supported-profile"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile"/>
<type value="reference"/>
<documentation value="Profiles for use cases supported"/>
</searchParam>
<searchParam>
<name value="mode"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode"/>
<type value="token"/>
<documentation
value="Mode - restful (server/client) or messaging (sender/receiver)"/>
</searchParam>
<searchParam>
<name value="context-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-quantity"/>
<type value="quantity"/>
<documentation
value="A quantity- or range-valued use context assigned to the capability statement"/>
</searchParam>
<searchParam>
<name value="security-service"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service"/>
<type value="token"/>
<documentation
value="OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"/>
</searchParam>
<searchParam>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-name"/>
<type value="string"/>
<documentation
value="Computationally friendly name of the capability statement"/>
</searchParam>
<searchParam>
<name value="context"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context"/>
<type value="token"/>
<documentation
value="A use context assigned to the capability statement"/>
</searchParam>
<searchParam>
<name value="publisher"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-publisher"/>
<type value="string"/>
<documentation
value="Name of the publisher of the capability statement"/>
</searchParam>
<searchParam>
<name value="context-type-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity"/>
<type value="composite"/>
<documentation
value="A use context type and quantity- or range-based value assigned to the capability statement"/>
</searchParam>
<searchParam>
<name value="guide"/>
<definition
value="http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide"/>
<type value="reference"/>
<documentation value="Implementation guides supported"/>
</searchParam>
<searchParam>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-status"/>
<type value="token"/>
<documentation
value="The current status of the capability statement"/>
</searchParam>
</resource>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="batch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="transaction"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-system"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-system"/>
</interaction>
</rest>
</CapabilityStatement>
IG © 2021+ HL7 Clinical Quality Information Work Group. Package hl7.fhir.us.davinci-ra#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-03-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change