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-datamart

Formats: XML, JSON, Turtle

Data Mart

Published: 2016-08-10

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

This profile defines the expected capabilities of the Data Mart 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 Mart.

General

FHIR Version: STU3
Supported formats: json and xml

REST behavior

The Data Mart SHALL implement REST behavior according to the FHIR specification. The Data Mart SHALL use either US-Core or DAF-Research profiles as needed to load data. The Data Mart SHALL support both json and xml resource formats for all DAF interactions. The Data Mart SHALL identify the DAF profile(s) supported as part of the FHIR BaseResource.Meta.profile attribute for each instance. The Data Mart SHALL declare a Capability statement and identify the list of profiles, operations, search parameters supported.

Security:

Data Marts are advised to implement security requirements according to their existing protocols for data translation and loading purposes. However Data Marts implementing US-Core IG SHOULD reuse US-Core security protocols for data translation, data loading and data access as applicable. Data Marts SHOULD honour patient's data disclosure polices. Datamarts SHOULD de-identify patient identifiable data in accordance with HHS de-identification guidelines for de-identification.

RESTful Operations Summary

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

SHALL

SHALL

SHALL

SHALL

SHALL

DAF-Provenance SHALL

SHALL

SHALL

SHALL

SHALL

SHALL

DAF-OperationDefinition

SHALL

SHALL

SHALL

SHALL

SHALL

SHALL



Data Mart Search Parameters

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

Data Marts SHALL support the following search contexts defined within the FHIR specification.

  • Search context by specifying a particular resource type

Data Marts SHALL support Modifiers as applicable to the data types of the search parameters. Data Marts SHALL also support Composite Search Parameters as defined in the FHIR specification.

Resource Name Search and Include Parameters
DAF-Task
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

Data Marts SHALL support daf-load-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.