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 
Formats: Narrative, XML, JSON, Turtle
Raw xml
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="daf-research-queryrequester"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2>Research Query Requester (Research Query Composer)</h2> <p>Published: 2016-08-10</p> <p>Published by: <b> <a href="http://www.healthit.gov/">U.S. Office of the National Coordinator (ONC)</a> </b> </p> <p>This profile defines the expected capabilities of the <i>Research Query Requester</i> actor when conforming to the <a href="index.html">DAF-Research IG</a>. The statement includes the complete list of actual profiles, RESTful operations, search parameters supported by a Research Query Requester. </p> <h2>General</h2> <table> <tbody> <tr> <th>FHIR Version:</th> <td>STU3</td> </tr> <tr> <th>Supported formats:</th> <td>json and xml</td> </tr> </tbody> </table> <h2>REST behavior</h2> <p>The Research Query Requester SHALL implement REST behavior according to the <a href="http://hl7.org/fhir/STU3/http.html">FHIR</a> specification. The Research Query Requester SHALL support both json and xml resource formats for all DAF interactions. The Research Query Requester SHALL identify the DAF profile(s) supported as part of the FHIR BaseResource.Meta.profile attribute for each instance. The Research Query Requester SHALL declare a Capability statement and identify the list of profiles, operations, search parameters supported. </p> <p> <b>Security:</b> </p> <p>Research Query Requester are advised to implement security requirements according to their existing protocols for executing research queries. However Research Query Requesters implementing US-Core IG SHOULD reuse US-Core security protocols for data access as applicable. Research Query Requesters SHOULD honour patient's data disclosure polices. </p> <h3>RESTful Operations Summary</h3> <table class="grid"> <thead> <tr> <th>Resource(Profile Name)</th> <th> <a href="http://hl7.org/fhir/http.html">Search</a> </th> <th> <a href="http://hl7.org/fhir/http.html">Read</a> </th> <th> <a href="http://hl7.org/fhir/http.html">Version Read</a> </th> <th> <a href="http://hl7.org/fhir/http.html">Instance History</a> </th> <th> <a href="http://hl7.org/fhir/http.html">Create</a> </th> <th> <a href="http://hl7.org/fhir/http.html">Update</a> </th> </tr> </thead> <tbody> <tr> <th> <a href="StructureDefinition-daf-task.html">DAF-Task</a> </th> <td> <a href="#DAFTaskSearch" title="Allows discovery of DAF-Task resources based on different search criteria">SHALL</a> </td> <td> <p title="Allows retrieval of a specific DAF-Task by resource id">SHALL</p> </td> <td> <p title="Allows retrieval of a historical version of a DAF-Task">SHALL</p> </td> <td> <p title="Allows review of changes to DAF-Task over time">SHALL</p> </td> <td> <p title="Allows creation of DAF-Task">SHALL</p> </td> <td> <p title="Allows updates to DAF-Task">SHALL</p> </td> </tr> <tr> <th> <a href="StructureDefinition-daf-queryresults.html">DAF-QueryResults</a> </th> <td> <p title="Allows discovery of DAF-QueryResults resources based on different search criteria">SHALL</p> </td> <td> <p title="Allows retrieval of a specific DAF-QueryResults by resource id">SHALL</p> </td> <td> <p title="Allows retrieval of a historical version of a DAF-QueryResults">SHALL</p> </td> <td> <p title="Allows review of changes to DAF-QueryResults over time">SHALL</p> </td> <td> <p title="Allows creation of DAF-QueryResults">SHALL</p> </td> <td> <p title="Allows updates to DAF-QueryResults">SHALL</p> </td> </tr> <tr> <th> <a href="StructureDefinition-daf-provenance.html">DAF-Provenance</a> </th> <td> <a href="#DAFProvenanceSearch" title="Allows discovery of DAF-Provenance resources based on different search criteria">SHALL</a> </td> <td> <p title="Allows retrieval of a specific DAF-Provenance by resource id">SHALL</p> </td> <td> <p title="Allows retrieval of a historical version of a DAF-Provenance">SHALL</p> </td> <td> <p title="Allows review of changes to DAF-Provenance over time">SHALL</p> </td> <td> <p title="Allows creation of DAF-Provenance">SHALL</p> </td> <td> <p title="Allows updates to DAF-Provenance">SHALL</p> </td> </tr> <tr> <th> <a href="StructureDefinition-daf-operationdefinition.html">DAF-OperationDefinition</a> </th> <td> <p title="Allows discovery of DAF-OperationDefinition resources based on different search criteria">SHALL</p> </td> <td> <p title="Allows retrieval of a specific DAF-OperationDefinition by resource id">SHALL</p> </td> <td> <p title="Allows retrieval of a historical version of a DAF-OperationDefinition">SHALL</p> </td> <td> <p title="Allows review of changes to DAF-OperationDefinition over time">SHALL</p> </td> <td> <p title="Allows creation of DAF-OperationDefinition">SHALL</p> </td> <td> <p title="Allows updates to DAF-OperationDefinition">SHALL</p> </td> </tr> </tbody> </table> <br/> <br/> <h3>Research Query Requester Search Parameters</h3> <p>Research Query Requester SHALL support the following common parameters as part of queries related to DAF-Research profiles:</p> <ul> <li> <a href="http://hl7.org/fhir/STU3/search.html#id">_id</a> </li> <li> <a href="http://hl7.org/fhir/STU3/search.html#lastUpdated">_lastUpdated</a> </li> <li> <a href="http://hl7.org/fhir/STU3/search.html#profile">_profile</a> </li> <li> <a href="http://hl7.org/fhir/STU3/search.html#count">_count</a> </li> <li> <a href="http://hl7.org/fhir/STU3/search.html#include">_include</a> </li> </ul> <p>Research Query Requester SHALL support the following search contexts defined within the <a href="http://hl7.org/fhir/STU3/search.html#introduction">FHIR</a> specification. </p> <ul> <li>Search context by specifying a particular resource type</li> </ul> <p>Research Query Requesters SHALL support <a href="http://hl7.org/fhir/STU3/search.html#modifiers">Modifiers</a> as applicable to the data types of the search parameters. Research Query Requester SHALL also support <a href="http://hl7.org/fhir/STU3/search.html#composite">Composite Search Parameters</a> as defined in the FHIR specification. </p> <table class="grid"> <thead> <tr> <th>Resource Name</th> <th>Search and Include Parameters</th> </tr> </thead> <tbody> <tr> <td id="DAFTaskSearch">DAF-Task</td> <td> <ul> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">id</a> - Search based on resource id ( <a href="http://hl7.org/fhir/STU3/search.html#string">string</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">identifier</a> - Search based on Task identifier ( <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">code</a> - Search based on Task code ( <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">status</a> - Search based on Task status ( <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">part-of</a> - Search based on Task this Task is part of ( <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">owner</a> - Search based on Task owner ( <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">performer</a> - Search based on Task performer type ( <a href="http://hl7.org/fhir/STU3/search.html#token">token</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/task.html#search">requester</a> - Search based on Task requester ( <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>) </li> </ul> </td> </tr> <tr> <td id="DAFProvenanceSearch">DAF-Provenance</td> <td> <ul> <li> <a href="http://hl7.org/fhir/STU3/provenance.html#search">target</a> - Search based on Provenance target ( <a href="http://hl7.org/fhir/STU3/search.html#reference">reference</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/provenance.html#search">start</a> - Search based on Provenance start time ( <a href="http://hl7.org/fhir/STU3/search.html#date">date</a>) </li> <li> <a href="http://hl7.org/fhir/STU3/provenance.html#search">end</a> - Search based on Provenance end time ( <a href="http://hl7.org/fhir/STU3/search.html#date">date</a>) </li> </ul> </td> </tr> </tbody> </table> <h3>DAF-Research Specific Operations</h3> <p>Research Query Requester SHALL support <a href="OperationDefinition-daf-execute-query.html">daf-execute-query</a> operation on the ROOT URL of the system.</p> <p>Research Query Requester SHALL publish their Capability statement using the DAF-Capability profile and identify the specific operations supported.</p> </div> </text> <url value="http://hl7.org/fhir/us/daf-research/CapabilityStatement/daf-research-queryrequester"/> <version value="1.0.0"/> <name value="Research Query Requester"/> <status value="draft"/> <date value="2016-08-10"/> <publisher value="U.S. Office of the National Coordinator (ONC)"/> <contact> <telecom> <system value="other"/> <value value="http://www.healthit.gov/"/> </telecom> </contact> <description value="This profile defines the expected capabilities of the Research Query Requester actor when conforming to the DAF-Research IG."/> <kind value="requirements"/> <fhirVersion value="3.0.0"/> <acceptUnknown value="extensions"/> <format value="xml"/> <format value="json"/> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"/> </profile> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-provenance"/> </profile> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-operationdefinition"/> </profile> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-queryresults"/> </profile> <rest> <mode value="server"/> <documentation value="The Research Query Requester SHALL support the DAF-Task, DAF-Capability, DAF-OperationDefinition profiles along with the daf-execute-query operation"/> <security> <description value="Data Mart SHALL use appropriate security protocols for executing queries."/> </security> <resource> <type value="Task"/> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"/> </profile> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing DAF-Task resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific DAF-Task by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to DAF-Task instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a DAF-Task instance"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="create"/> <documentation value="Allows creation of a DAF-Task instance"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="update"/> <documentation value="Allows updation of a DAF-Task instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="identifier"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="status"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="code"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="part-of"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="owner"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="performer"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="requester"/> <type value="reference"/> </searchParam> </resource> <resource> <type value="Provenance"/> <profile> <reference value="http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-provenance"/> </profile> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing DAF-Provenance resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific DAF-Provenance by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to DAF-Provenance instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a DAF-Provenance instance"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="create"/> <documentation value="Allows creation of a DAF-Provenance instance"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="update"/> <documentation value="Allows updation of a DAF-Provenance instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="target"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="start"/> <type value="date"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="end"/> <type value="date"/> </searchParam> </resource> <operation> <name value="daf-execute-query"/> <definition> <reference value="http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query"/> </definition> </operation> </rest> </CapabilityStatement>
DAF Research v2.0.0 (STU2) © FHIR STU3 Version: 3.0.1 (IG Publisher v3.0.0-11681) generated on Fri, Apr 21, 2017 08:00+1000. |
