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

CapabilityStatement: daf-datasource

Formats: XML, JSON, Turtle

Data Source

Published: 2016-08-10

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

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

General

FHIR Version: STU3
Supported formats: json and xml

REST behavior

For the resources and operations supported by the Data Source, the RESTful behavior SHALL conform to the FHIR specification. The Data Source SHOULD use either US-Core or DAF-Research profiles as needed to extract data. The Data Source SHOULD support both json and xml resource formats for all DAF interactions. The Data Source SHOULD identify the DAF profile(s) supported as part of the FHIR BaseResource.Meta.profile attribute for each instance. The Data Source SHOULD declare a Capability statement and identify the list of profiles, operations, search parameter supported.

Security:

Data Sources are advised to implement security requirements according to their existing protocols for data extraction purposes. However Data Sources implementing US-Core IG SHOULD reuse US-Core security protocols for data extraction purposes as applicable. Data Sources SHOULD honour patient's data disclosure polices.

RESTful Operations Summary

Resource(Profile Name) Search Read Version Read Instance History Create Update
DAF-Task SHOULD

SHOULD

SHOULD

SHOULD

SHOULD

SHOULD

US-Core profiles

SHOULD

SHOULD

SHOULD

SHOULD

MAY

MAY



Data Source Search Parameters

Data Sources SHOULD support the following common parameters as part of queries related to DAF-Research profiles:

Data Sources SHOULD support the following search contexts defined within the FHIR specification.

  • Search context by specifying a particular resource type
Resource Name Search and Include Parameters
DAF-Task
US-Core profiles
  • Search parameters provided by the US-Core IG

DAF-Research Specific Operations

Data Sources SHOULD support Patient/$everything operation using the US-Core profiles.

Data Sources SHALL support daf-extract-operation on the ROOT URL of the system.

Data Marts SHALL publish their Capability statement using the DAF-Capability profile and identify the specific operations supported.