Bulk Data Access IG
3.0.0-ballot - International flag

Bulk Data Access IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bulk-data/ and changes regularly. See the Directory of published versions

Extension: Member Filter

Official URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter Version: 3.0.0-ballot
Standards status: Trial-use Active as of 2025-11-03 Maturity Level: 5 Computable Name: MemberFilter

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"
  }
}]

Context of Use

    This extension is a modifier extension.

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
This is a modifier extension
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
... value[x] 0..1 Expression Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
This is a modifier extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Modifier Extension with the type Expression: 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"
  }
}]

Maturity: 5

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
This is a modifier extension
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
... value[x] 0..1 Expression Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
This is a modifier extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Modifier Extension with the type Expression: 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"
  }
}]

Maturity: 5

 

Other representations of profile: CSV, Excel, Schematron