Package | hl7.fhir.us.daf |
Type | OperationDefinition |
Id | daf-execute-query |
FHIR Version | R3 |
Source | http://hl7.org/fhir/us/daf/OperationDefinition-daf-execute-query.html |
URL | http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query |
Version | 1.0.0 |
Status | draft |
Date | 2016-07-24 |
Name | Execute Query |
Realm | us |
Authority | hl7 |
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. |
Type | false |
Kind | operation |
CapabilityStatement | |
daf-research-queryrequester | Research Query Requester |
daf-research-queryresponder | Research Query Responder |
No resources found
Note: links and images are rebased to the (stated) source
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
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
{ "resourceType": "OperationDefinition", "id": "daf-execute-query", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "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" } ] }