XIG: CapabilityStatement/daf-research-queryrequester

FHIR © HL7.org | Server Home | XIG Home | Server Source | FHIR

FHIR IG Statistics: CapabilityStatement/daf-research-queryrequester

Package	hl7.fhir.us.daf
Type	CapabilityStatement
Id	daf-research-queryrequester
FHIR Version	R3
Source	http://hl7.org/fhir/us/daf/CapabilityStatement-daf-research-queryrequester.html
URL	http://hl7.org/fhir/us/daf-research/CapabilityStatement/daf-research-queryrequester
Version	1.0.0
Status	draft
Date	2016-08-10
Name	Research Query Requester
Realm	us
Authority	hl7
Description	This profile defines the expected capabilities of the Research Query Requester actor when conforming to the DAF-Research IG.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
daf-execute-query	Execute Query

StructureDefinition
daf-provenance	U.S. Data Access Framework (DAF) Provenance
daf-task	U.S. Data Access Framework (DAF) Task Profile

Narrative

Note: links and images are rebased to the (stated) source

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

Resource(Profile Name)

Search

Read

Version Read

Instance History

Create

Update

DAF-Task

SHALL

DAF-QueryResults

SHALL

DAF-Provenance

SHALL

DAF-OperationDefinition

SHALL

Research Query Requester Search Parameters

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

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)

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.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "daf-research-queryrequester",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/us/daf-research/CapabilityStatement/daf-research-queryrequester",
  "version": "1.0.0",
  "name": "Research Query Requester",
  "status": "draft",
  "date": "2016-08-10",
  "publisher": "U.S. Office of the National Coordinator (ONC)",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://www.healthit.gov/"
        }
      ]
    }
  ],
  "description": "This profile defines the expected capabilities of the Research Query Requester actor when conforming to the DAF-Research IG.",
  "kind": "requirements",
  "fhirVersion": "3.0.0",
  "acceptUnknown": "extensions",
  "format": [
    "xml",
    "json"
  ],
  "profile": [
    {
      "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"
    },
    {
      "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-provenance"
    },
    {
      "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-operationdefinition"
    },
    {
      "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-queryresults"
    }
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "The Research Query Requester SHALL support the DAF-Task, DAF-Capability, DAF-OperationDefinition profiles along with the daf-execute-query operation",
      "security": {
        "description": "Data Mart SHALL use appropriate security protocols for executing queries."
      },
      "resource": [
        {
          "type": "Task",
          "profile": {
            "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-task"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing DAF-Task resources using different search criteria"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific DAF-Task by id"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to DAF-Task instance over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a DAF-Task instance"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows creation of a DAF-Task instance"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows updation of a DAF-Task instance"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "part-of",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "owner",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "performer",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "requester",
              "type": "reference"
            }
          ]
        },
        {
          "type": "Provenance",
          "profile": {
            "reference": "http://hl7.org/fhir/us/daf-research/StructureDefinition/daf-provenance"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing DAF-Provenance resources using different search criteria"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific DAF-Provenance by id"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to DAF-Provenance instance over time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a DAF-Provenance instance"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows creation of a DAF-Provenance instance"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update",
              "documentation": "Allows updation of a DAF-Provenance instance"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "target",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "start",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "end",
              "type": "date"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "daf-execute-query",
          "definition": {
            "reference": "http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-execute-query"
          }
        }
      ]
    }
  ]
}