Da Vinci Risk Adjustment Implementation Guide
1.0.0 - STU 1 US

This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

OperationDefinition: Report Operation

Official URL: http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report Version: 1.0.0
Active as of 2022-06-16 Computable Name: Report

Generate a measure report

Note: all Conformance Requirements are restricted to resources in the system that are being reported on.

Conformance Requirement 1:

The $report operation SHALL be able to query:

Conformance Requirement 2:

The $report operation SHALL be able to resolve:

  • Whether the subject being processed is a valid patient when subject is a Patient/[reference]; AND
  • Whether any patient in the subject being processed is valid when subject is a Group/[reference].

Conformance Requirement 3:

The $report operation SHALL include the following output (OUT) parameters:

  • If the subject being processed is a Patient/[reference] and the patient is not valid, then the Parameters.parameter element SHALL include an OperationOutcome resource that includes the subject (Patient/[reference]) being processed; OR
  • If the subject being processed is a Group/[reference] and the group itself is not valid or none of the patients in the group is valid, then the Parameters.parameter element SHALL include an OperationOutcome resource that includes the subject (Group/[reference]) being processed; OR
  • If the patient is valid and no MeasureReport resources match the set of input (IN) parameters being processed, then the Bundle.entry SHALL include a US Core Patient resource matching the subject (Patient/[reference]) (note: an OperationOutcome will NOT be returned because $report is to return existing MeasureReports and none exist in this scenario); OR
  • If the patient is valid and one or more MeasureReport resources match the set of input (IN) parameters being processed, then the Bundle.entry SHALL include all matching MeasureReport resources and all resources referenced by the evalautedResource element of all matching MeasureReport resources.

Report

OPERATION: Report

The official URL for this operation definition is: 

http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report

Generate a measure report

URL: [base]/MeasureReport/$report

Parameters

UseNameCardinalityTypeBindingDocumentation
INperiodStart1..1date

The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (MeasureReport.period.start and MeasureReport.period.end) of a Risk Adjustment Coding Gap MeasureReport available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.

INperiodEnd1..1date

The end of a clinical evaluation period.

INsubject1..1string
(reference)

Subject will be a reference to either Patient (US Core Patient) or Group (Patient Group). Must provide either Patient/123 or Group/123, cannot simply provide 123. If only 123 is provided, then the operation would not know if it is a Patient reference or a Group reference.

OUTreturn0..*Bundle

The $report operation will always return one Parameters whether the subject is a single patient or a group of patients. Risk Adjustment Coding Gap Report Bundle for a patient is in a Parameters.parameter element. A Risk Adjustment Coding Gap Report Bundle contains the Risk Adjustment Coding Gap Reports for the same patient. For example, if a Group has 10 valid patients, then a Parameters will contain 10 Parameters.parameterelements, with each Parameters.parameter for a unique patient.

OUToutcome0..*OperationOutcome

If subject is a patient and the patient is not found on the Server, or if subject is a Group and the group is not found on the Server, then the $report returns a Parameters.parameter with an OperationOutcome. If subject is a Group, the group is valid but one or more patients within the Group can not be found on the Server, then the $report returns a separate Parameters.parameter with an OperationOutcome for each of the invalid patients. For example, if a Group has 10 patients and two of the patients cannot be found on the Server, then the $report returns a Parameters resource containing 10 parameter elements (two parameter elements containing OperationOutcome for the two invalid patients and eight parameter elements containing Risk Adjustment Coding Gap Report Bundle for the eight valid patients).

Notes:

Examples:

Request:

  • Request Risk Adjustment Coding Gap Reports over a clinical evaluation period from 2021-01-01 to 2021-09-30 for patient01.
GET [base]/Measure/$report?periodStart=2021-01-01&periodEnd=2021-09-30&subject=Patient/01

Request:

  • Request Risk Adjustment Coding Gap Reports over a clinical evaluation period from 2021-01-01 to 2021-09-30 for group01.
GET [base]/Measure/$report?periodStart=2021-01-01&periodEnd=2021-09-30&subject=Group/01