DAF Research Implementation Guide v2.0.0 (STU2)

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

OperationDefinition-daf-execute-query

Formats: XML, JSON, Turtle

Execute Query

OPERATION: Execute Query

The official URL for this operation definition is: 

http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query

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.

URL: [base]/$execute-query

Parameters

UseNameCardinalityTypeBindingDocumentation
INqueryformat1..1CodeableConcept

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.

INqueryFormatVersion1..1string

The version of the queryFormat that was used to construct the query.

INdataModel1..1CodeableConcept

The data model that was used to construct the query.

INquerypackage1..1string

The actual query string.

INinstructions0..1string

The actual query string.

INqueryResultsPhiDisclosureLevel0..1string

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.

OUTreturn0..1Bundle

A Bundle containing the resulting data.

OUTissues0..1OperationOutcome

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.

Pilots underway in PCORNet