DAF Research Implementation Guide v2.0.0 (STU2)
Formats: Narrative, XML, JSON, Turtle
Raw ttl
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- a fhir:OperationDefinition; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "daf-execute-query"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table><div><p>Pilots underway in PCORNet</p>\n</div></div>" ]; fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query"]; fhir:OperationDefinition.version [ fhir:value "1.0.0"]; fhir:OperationDefinition.name [ fhir:value "Execute Query"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2016-07-24"^^xsd:date]; fhir:OperationDefinition.description [ fhir: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."]; fhir:OperationDefinition.code [ fhir:value "execute-query"]; fhir:OperationDefinition.comment [ fhir:value "Pilots underway in PCORNet"]; fhir:OperationDefinition.base [ fhir:Reference.reference [ fhir:value "OperationDefinition/daf-execute-query" ] ]; fhir:OperationDefinition.system [ fhir:value "true"^^xsd:boolean]; fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean]; fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean]; fhir:OperationDefinition.parameter [ fhir:index 0; fhir:OperationDefinition.parameter.name [ fhir:value "queryformat" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir: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." ]; fhir:OperationDefinition.parameter.type [ fhir:value "CodeableConcept" ] ], [ fhir:index 1; fhir:OperationDefinition.parameter.name [ fhir:value "queryFormatVersion" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "The version of the queryFormat that was used to construct the query." ]; fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ], [ fhir:index 2; fhir:OperationDefinition.parameter.name [ fhir:value "dataModel" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "The data model that was used to construct the query." ]; fhir:OperationDefinition.parameter.type [ fhir:value "CodeableConcept" ] ], [ fhir:index 3; fhir:OperationDefinition.parameter.name [ fhir:value "querypackage" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "The actual query string." ]; fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ], [ fhir:index 4; fhir:OperationDefinition.parameter.name [ fhir:value "instructions" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "The actual query string." ]; fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ], [ fhir:index 5; fhir:OperationDefinition.parameter.name [ fhir:value "queryResultsPhiDisclosureLevel" ]; fhir:OperationDefinition.parameter.use [ fhir:value "in" ]; fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir: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." ]; fhir:OperationDefinition.parameter.type [ fhir:value "string" ] ], [ fhir:index 6; fhir:OperationDefinition.parameter.name [ fhir:value "return" ]; fhir:OperationDefinition.parameter.use [ fhir:value "out" ]; fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir:value "A Bundle containing the resulting data." ]; fhir:OperationDefinition.parameter.type [ fhir:value "Bundle" ] ], [ fhir:index 7; fhir:OperationDefinition.parameter.name [ fhir:value "issues" ]; fhir:OperationDefinition.parameter.use [ fhir:value "out" ]; fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ]; fhir:OperationDefinition.parameter.max [ fhir:value "1" ]; fhir:OperationDefinition.parameter.documentation [ fhir: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." ]; fhir:OperationDefinition.parameter.type [ fhir:value "OperationOutcome" ] ]. # - ontology header ------------------------------------------------------------ a owl:Ontology; owl:imports fhir:fhir.ttl.
DAF Research v2.0.0 (STU2) © based on FHIR STU3 Version: 3.0.1 generated on Fri, Apr 21, 2017 08:00+1000. |
