Da Vinci Risk Adjustment Implementation Guide
2.0.0-ballot - STU2 Ballot
Da Vinci Risk Adjustment Implementation Guide
2.0.0-ballot - STU2 Ballot
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 |
{
"resourceType" : "CapabilityStatement",
"id" : "ra-reporting-client",
"text" : {
"status" : "extensions",
"div" : "<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>\n</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>\n</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>"
},
"url" : "http://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-reporting-client",
"version" : "2.0.0-ballot",
"name" : "RAClientCapabilityStatement",
"title" : "Risk Adjustment Reporting Client Capability Statement",
"status" : "active",
"experimental" : false,
"date" : "2023-03-28T02:02:49+00:00",
"publisher" : "HL7 Clinical Quality Information Work Group",
"contact" : [
{
"name" : "HL7 Clinical Quality Information Work Group",
"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 - Clinical Quality Information Work Group, 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/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",
"profile" : "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" : [
{
"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"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Bundle",
"profile" : "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"
]
},
{
"type" : "ImplementationGuide",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"interaction" : [
{
"code" : "read",
"documentation" : "Implemented per the specification"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification"
},
{
"code" : "update",
"documentation" : "Implemented per the specification"
},
{
"code" : "patch",
"documentation" : "Implemented per the specification"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification"
},
{
"code" : "create",
"documentation" : "Implemented per the specification"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : [
"literal",
"logical"
],
"searchInclude" : [
"ImplementationGuide.resource",
"ImplementationGuide.global",
"ImplementationGuide.depends-on"
],
"searchRevInclude" : [
"CapabilityStatement.guide",
"ImplementationGuide.depends-on"
],
"searchParam" : [
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The implementation guide publication date"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the implementation guide"
},
{
"name" : "resource",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-resource",
"type" : "reference",
"documentation" : "Location of the resource"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the implementation guide"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the implementation guide"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the implementation guide"
},
{
"name" : "experimental",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-experimental",
"type" : "token",
"documentation" : "For testing purposes, not real usage"
},
{
"name" : "global",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-global",
"type" : "reference",
"documentation" : "Profile that all resources must conform to"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the implementation guide"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the implementation guide"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the implementation guide"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the implementation guide"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ImplementationGuide-depends-on",
"type" : "reference",
"documentation" : "Identity of the IG that this depends on"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the implementation guide"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the implementation guide"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the implementation guide"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the implementation guide"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the implementation guide"
}
]
},
{
"type" : "CapabilityStatement",
"profile" : "http://hl7.org/fhir/StructureDefinition/CapabilityStatement",
"interaction" : [
{
"code" : "read",
"documentation" : "Implemented per the specification"
},
{
"code" : "vread",
"documentation" : "Implemented per the specification"
},
{
"code" : "update",
"documentation" : "Implemented per the specification"
},
{
"code" : "patch",
"documentation" : "Implemented per the specification"
},
{
"code" : "delete",
"documentation" : "Implemented per the specification"
},
{
"code" : "history-instance",
"documentation" : "Implemented per the specification"
},
{
"code" : "history-type",
"documentation" : "Implemented per the specification"
},
{
"code" : "create",
"documentation" : "Implemented per the specification"
},
{
"code" : "search-type",
"documentation" : "Implemented per the specification"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : [
"literal",
"logical"
],
"searchInclude" : [
"CapabilityStatement.resource-profile",
"CapabilityStatement.supported-profile",
"CapabilityStatement.guide"
],
"searchParam" : [
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-date",
"type" : "date",
"documentation" : "The capability statement publication date"
},
{
"name" : "resource-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource-profile",
"type" : "reference",
"documentation" : "A profile id invoked in a capability statement"
},
{
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
"type" : "composite",
"documentation" : "A use context type and value assigned to the capability statement"
},
{
"name" : "software",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-software",
"type" : "string",
"documentation" : "Part of the name of a software application"
},
{
"name" : "resource",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-resource",
"type" : "token",
"documentation" : "Name of a resource mentioned in a capability statement"
},
{
"name" : "jurisdiction",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the capability statement"
},
{
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-format",
"type" : "token",
"documentation" : "formats supported (xml | json | ttl | mime type)"
},
{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-description",
"type" : "string",
"documentation" : "The description of the capability statement"
},
{
"name" : "context-type",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the capability statement"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-title",
"type" : "string",
"documentation" : "The human-friendly name of the capability statement"
},
{
"name" : "fhirversion",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-fhirversion",
"type" : "token",
"documentation" : "The version of FHIR"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-version",
"type" : "token",
"documentation" : "The business version of the capability statement"
},
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-url",
"type" : "uri",
"documentation" : "The uri that identifies the capability statement"
},
{
"name" : "supported-profile",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-supported-profile",
"type" : "reference",
"documentation" : "Profiles for use cases supported"
},
{
"name" : "mode",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-mode",
"type" : "token",
"documentation" : "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name" : "context-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the capability statement"
},
{
"name" : "security-service",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-security-service",
"type" : "token",
"documentation" : "OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-name",
"type" : "string",
"documentation" : "Computationally friendly name of the capability statement"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context",
"type" : "token",
"documentation" : "A use context assigned to the capability statement"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type" : "string",
"documentation" : "Name of the publisher of the capability statement"
},
{
"name" : "context-type-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
"type" : "composite",
"documentation" : "A use context type and quantity- or range-based value assigned to the capability statement"
},
{
"name" : "guide",
"definition" : "http://hl7.org/fhir/SearchParameter/CapabilityStatement-guide",
"type" : "reference",
"documentation" : "Implementation guides supported"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/conformance-status",
"type" : "token",
"documentation" : "The current status of the capability statement"
}
]
}
],
"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"
}
]
}
]
}
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