This page is part of the Data Access Framework (v2.0.0: STU 2) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

Example: OperationDefinition-daf-execute-query

Formats: Narrative, XML, JSON, Turtle

Raw xml

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="daf-execute-query"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Execute Query</h2><p>OPERATION: Execute Query</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query</pre><div><p>The purpose of this operation is to enable composition and execution of a query in a research setting.Please refer to the Implementation Guidance for further information on how to use the task and execute-query operation together for querying research research data marts.</p>
</div><p>URL: [base]/$execute-query</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>queryformat</td><td>1..1</td><td>CodeableConcept</td><td/><td><div><p>The format of the actual query (e.g SAS, SQL).This will be used by the Data Marts to determine how to execute the query.</p>
</div></td></tr><tr><td>IN</td><td>queryFormatVersion</td><td>1..1</td><td>string</td><td/><td><div><p>The version of the queryFormat that was used to construct the query.</p>
</div></td></tr><tr><td>IN</td><td>dataModel</td><td>1..1</td><td>CodeableConcept</td><td/><td><div><p>The data model that was used to construct the query.</p>
</div></td></tr><tr><td>IN</td><td>querypackage</td><td>1..1</td><td>string</td><td/><td><div><p>The actual query string.</p>
</div></td></tr><tr><td>IN</td><td>instructions</td><td>0..1</td><td>string</td><td/><td><div><p>The actual query string.</p>
</div></td></tr><tr><td>IN</td><td>queryResultsPhiDisclosureLevel</td><td>0..1</td><td>string</td><td/><td><div><p>The parameter indicates whether Aggregate, De-Identified, Patient Level data is expected as part of the query results. By default only aggregate data would be returned.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td>Bundle</td><td/><td><div><p>A Bundle containing the resulting data.</p>
</div></td></tr><tr><td>OUT</td><td>issues</td><td>0..1</td><td>OperationOutcome</td><td/><td><div><p>A list of hints and warnings about problems encountered while executing the query. These might be shown to the user as an advisory note. Note: if the query cannot be executed at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter.</p>
</div></td></tr></table><div><p>Pilots underway in PCORNet</p>
</div></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query"/>
  <version value="1.0.0"/>
  <name value="Execute Query"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-07-24"/>
  <description
               value="The purpose of this operation is to enable composition and execution of a query in a research setting.Please refer to the Implementation Guidance for further information on how to use the task and execute-query operation together for querying research research data marts."/>
  <code value="execute-query"/>
  <comment value="Pilots underway in PCORNet"/>
  <base>
    <reference value="OperationDefinition/daf-execute-query"/>
  </base>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="queryformat"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The format of the actual query (e.g SAS, SQL).This will be used by the Data Marts to determine how to execute the query."/>
    <type value="CodeableConcept"/>
  </parameter>
  <parameter>
    <name value="queryFormatVersion"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The version of the queryFormat that was used to construct the query."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="dataModel"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The data model that was used to construct the query."/>
    <type value="CodeableConcept"/>
  </parameter>
  <parameter>
    <name value="querypackage"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The actual query string."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="instructions"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The actual query string."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="queryResultsPhiDisclosureLevel"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The parameter indicates whether Aggregate, De-Identified, Patient Level data is expected as part of the query results. By default only aggregate data would be returned."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A Bundle containing the resulting data."/>
    <type value="Bundle"/>
  </parameter>
  <parameter>
    <name value="issues"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A list of hints and warnings about problems encountered while executing the query. These might be shown to the user as an advisory note. Note: if the query cannot be executed at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>