Da Vinci Risk Adjustment Implementation Guide (STU1 Ballot)
0.1.0 - STU 1 Ballot

This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v0.1.0: STU 1 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

: Report Operation - TTL Representation

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:OperationDefinition;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "report"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>Report</h2><p>OPERATION: Report</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report</pre><div><p>Generate a measure report</p>\n</div><p>URL: [base]/MeasureReport/$report</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>periodStart</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The start of a clinical evaluation period. The periodStart and periodEnd parameters will be compared with the clinical evaluation period (<code>MeasureReport.period.start</code> and <code>MeasureReport.period.end</code>)           of a <a href=\"StructureDefinition-ra-measurereport.html\">Risk Adjustment Coding Gap MeasureReport</a> available on the Server. The MeasureReport will be returned if there is an overlap of the two periods.</p>\n</div></td></tr><tr><td>IN</td><td>periodEnd</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The end of a clinical evaluation period.</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>Subject will be a reference to either Patient (<a href=\"http://hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html\">US Core Patient</a>) or Group (<a href=\"StructureDefinition-ra-patient-group.html\">Patient Group</a>). 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.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The $report operation will always return one <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> whether the subject is a single patient or a group of patients. <a href=\"StructureDefinition-ra-measurereport-bundle.html\">Risk Adjustment Coding Gap Report Bundle</a> for a patient is in a <code>Parameters.parameter</code> 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 <a href=\"https://www.hl7.org/fhir/parameters.html\">Parameters</a> will contain 10 <code>Parameters.parameter</code>elements, with each <code>Parameters.parameter</code> for a unique patient.</p>\n</div></td></tr><tr><td>OUT</td><td>outcome</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>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 <code>Parameters.parameter</code> with an <a href=\"https://www.hl7.org/fhir/operationOutcome.html\">OperationOutcome</a>.           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 <code>Parameters.parameter</code> 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 <code>parameter</code> elements (two <code>parameter</code> elements containing OperationOutcome for the two invalid patients and eight <code>parameter</code> elements containing <a href=\"StructureDefinition-ra-measurereport-bundle.html\">Risk Adjustment Coding Gap Report Bundle</a> for the eight valid patients).</p>\n</div></td></tr></table></div>"
  ];
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/us/davinci-ra/OperationDefinition/report"];
  fhir:OperationDefinition.version [ fhir:value "0.1.0"];
  fhir:OperationDefinition.name [ fhir:value "Report"];
  fhir:OperationDefinition.title [ fhir:value "Report Operation"];
  fhir:OperationDefinition.status [ fhir:value "active"];
  fhir:OperationDefinition.kind [ fhir:value "operation"];
  fhir:OperationDefinition.date [ fhir:value "2021-11-01"^^xsd:date];
  fhir:OperationDefinition.publisher [ fhir:value "HL7 Clinical Quality Information Work Group"];
  fhir:OperationDefinition.contact [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "HL7 Clinical Quality Information Work Group" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/cqi" ]     ]
  ];
  fhir:OperationDefinition.description [ fhir:value "Generate a measure report"];
  fhir:OperationDefinition.jurisdiction [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
       fhir:Coding.code [ fhir:value "US" ];
       fhir:Coding.display [ fhir:value "United States of America" ]     ]
  ];
  fhir:OperationDefinition.code [ fhir:value "report"];
  fhir:OperationDefinition.resource [
     fhir:value "MeasureReport";
     fhir:index 0
  ];
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean];
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.parameter [
     fhir:index 0;
     fhir:OperationDefinition.parameter.name [ fhir:value "periodStart" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "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](StructureDefinition-ra-measurereport.html) available on the Server. The MeasureReport will be returned if there is an overlap of the two periods." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index 1;
     fhir:OperationDefinition.parameter.name [ fhir:value "periodEnd" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The end of a clinical evaluation period." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index 2;
     fhir:OperationDefinition.parameter.name [ fhir:value "subject" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Subject will be a reference to either Patient ([US Core Patient](http://hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html)) or Group ([Patient Group](StructureDefinition-ra-patient-group.html)). 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." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ];
     fhir:OperationDefinition.parameter.searchType [ fhir:value "reference" ]
  ], [
     fhir:index 3;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
     fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The $report operation will always return one [Parameters](https://www.hl7.org/fhir/parameters.html) whether the subject is a single patient or a group of patients. [Risk Adjustment Coding Gap Report Bundle](StructureDefinition-ra-measurereport-bundle.html) 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](https://www.hl7.org/fhir/parameters.html) will contain 10 `Parameters.parameter`elements, with each `Parameters.parameter` for a unique patient." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "Bundle" ]
  ], [
     fhir:index 4;
     fhir:OperationDefinition.parameter.name [ fhir:value "outcome" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ];
     fhir:OperationDefinition.parameter.max [ fhir:value "*" ];
     fhir:OperationDefinition.parameter.documentation [ fhir:value "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](https://www.hl7.org/fhir/operationOutcome.html).           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](StructureDefinition-ra-measurereport-bundle.html) for the eight valid patients)." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "OperationOutcome" ]
  ].

# - ontology header ------------------------------------------------------------

 a owl:Ontology;
  owl:imports fhir:fhir.ttl.