Research Query Requester (Research Query Composer)

Published: 2016-08-10

Published by: U.S. Office of the National Coordinator (ONC)

This profile defines the expected capabilities of the Research Query Requester actor when conforming to the DAF-Research IG. The statement includes the complete list of actual profiles, RESTful operations, search parameters supported by a Research Query Requester.

General

FHIR Version:	STU3
Supported formats:	json and xml

REST behavior

The Research Query Requester SHALL implement REST behavior according to the FHIR 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.

Security:

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.

RESTful Operations Summary

Resource(Profile Name)	Search	Read	Version Read	Instance History	Create	Update
DAF-Task	SHALL	SHALL	SHALL	SHALL	SHALL	SHALL
DAF-QueryResults	SHALL	SHALL	SHALL	SHALL	SHALL	SHALL
DAF-Provenance	SHALL	SHALL	SHALL	SHALL	SHALL	SHALL
DAF-OperationDefinition	SHALL	SHALL	SHALL	SHALL	SHALL	SHALL

Research Query Requester Search Parameters

Research Query Requester SHALL support the following common parameters as part of queries related to DAF-Research profiles:

• _id
• _lastUpdated
• _profile
• _count
• _include

Research Query Requester SHALL support the following search contexts defined within the FHIR specification.

• Search context by specifying a particular resource type

Research Query Requesters SHALL support Modifiers as applicable to the data types of the search parameters. Research Query Requester SHALL also support Composite Search Parameters as defined in the FHIR specification.

Resource Name	Search and Include Parameters
DAF-Task	id - Search based on resource id ( string) identifier - Search based on Task identifier ( token) code - Search based on Task code ( token) status - Search based on Task status ( token) part-of - Search based on Task this Task is part of ( reference) owner - Search based on Task owner ( reference) performer - Search based on Task performer type ( token) requester - Search based on Task requester ( reference)
DAF-Provenance	target - Search based on Provenance target ( reference) start - Search based on Provenance start time ( date) end - Search based on Provenance end time ( date)

DAF-Research Specific Operations

Research Query Requester SHALL support daf-execute-query operation on the ROOT URL of the system.

Research Query Requester SHALL publish their Capability statement using the DAF-Capability profile and identify the specific operations supported.