Bulk Data Access IG
2.0.0 - Standard for Trial Use

This page is part of the FHIR Bulk Data Access (Flat FHIR) (v2.0.0: STU 2) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

FHIR Bulk Data Access Implementation Guide

The expected capabilities of a Bulk Data Provider actor (e.g., EHR systems, data warehouses, and other clinical and administrative systems that aim to interoperate by sharing large FHIR datasets) which is responsible for providing responses to the queries submitted by a FHIR Bulk Data Client actor. Systems implementing this capability statement should meet the requirements set by the Bulk Data Access Implementation Guide. A FHIR Bulk Data Client has the option of choosing from this list to access necessary data based on use cases and other contextual requirements.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

FHIR Bulk Data System Level Export

FHIR Operation to export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern
FHIR Bulk Data Group Level Export

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all members of the specified Group. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern
FHIR Bulk Data Patient Level Export

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Include Associated Data Value Set

Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Include Associated Data Code System

Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter