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 json

{
  "resourceType" : "OperationDefinition",
  "id" : "daf-execute-query",
  "text" : {
    "status" : "generated",
    "div" : "<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>"
  },
  "url" : "http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query",
  "version" : "1.0.0",
  "name" : "Execute Query",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2016-07-24",
  "description" : "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" : "execute-query",
  "comment" : "Pilots underway in PCORNet",
  "base" : {
    "reference" : "OperationDefinition/daf-execute-query"
  },
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "queryformat",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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" : "CodeableConcept"
    },
    {
      "name" : "queryFormatVersion",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The version of the queryFormat that was used to construct the query.",
      "type" : "string"
    },
    {
      "name" : "dataModel",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The data model that was used to construct the query.",
      "type" : "CodeableConcept"
    },
    {
      "name" : "querypackage",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The actual query string.",
      "type" : "string"
    },
    {
      "name" : "instructions",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The actual query string.",
      "type" : "string"
    },
    {
      "name" : "queryResultsPhiDisclosureLevel",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "A Bundle containing the resulting data.",
      "type" : "Bundle"
    },
    {
      "name" : "issues",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "OperationOutcome"
    }
  ]
}