Bulk Data Access IG
3.0.0-ballot - STU 3 - Ballot International flag

This page is part of the FHIR Bulk Data Access (Flat FHIR) (v3.0.0-ballot: STU3 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. 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.

Capability Statement

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.

Group Level Export Operation Definition

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
Patient Level Export Operation Definition

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
System Level Export Operation Definition

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

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Bulk Cohort Group

Group that provides characteristic based cohorts through coarse-grained, REST search expression based filters to support constraining bulk export requests

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Member Filter

Extension to define the population of the group using FHIR REST API parameters. For example, the following extension would limit the population of the group to patients with an ambulatory encounter in January 2024:

"modifierExtension" : [{
  "url" : "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter",
  "valueExpression" : {
    "language" : "application/x-fhir-query",
      "expression" : "Encounter?class=http://terminology.hl7.org/CodeSystem/v3-ActCode|AMB&date=ge2024-01-01&date=le2024-01-31"
  }
}]
Members Refreshed

Extension used by a server to indicate to a client when the members in a dynamic group were last updated. For example, the following extension would indicate that the group members were last updated January 1st 2024:

"Extension" : [{
  "url" : "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed",
  "valueDateTime" : "2024-01-01T13:28:17-05:00"
}]
Operation Not Supported

Extension used in a CapabilityStatement to indicate that the parent resource type or search parameter is not supported for use in a bulk data export operation. For example, the following extension would indicate that the AllergyIntolerance.clinical-status search parameter may not be used in a _typeFilter parameter on this server.

  "searchParam": [{
    "name": "clinical-status",
    "type": "token",
    "extension": [{
      "url": "http://hl7.org/fhir/uv/bulkdata/Extension/operation-not-supported",
      "valueCanonical": "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"
    }]
  }]

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
Person and Practitioner from GroupType Value Set

Valuset to constrain the type element in a Group to just person and practitioner

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

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Bulk Cohort Group Example

Blue cross plan member group with members filtered to patients that have an active diagnosis of diabetes on their problem list and an ambulatory encounter in January 2024