DAF Research, Release 1 Ballot

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

Execute Query

Formats: XML, JSON, Turtle

Execute Query

OPERATION: Execute Query

Enable composition and execution of a query.

URL: [base]/$execute-query

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

queryformat

1..1

CodeableConcept

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.

IN

queryFormatVersion

1..1

string

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

IN

dataModel

1..1

CodeableConcept

The data model that was used to construct the query.

IN

querypackage

1..1

string

The actual query string.

IN

instructions

0..1

string

The actual query string.

IN

queryResultsPhiDisclosureLevel

0..1

string

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.

OUT

return

0..1

Bundle

A Bundle containing the resulting data.

OUT

issues

0..1

OperationOutcome

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