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

Extension: Member Filter

Official URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter Version: 3.0.0-ballot
Standards status: Trial-use 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 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 of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
... value[x] 0..1 Expression Value of extension
.... language 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Required Pattern: application/x-fhir-query

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... description Σ 0..1 string Natural language description of the condition
.... name Σ 0..1 id Short name assigned to expression for reuse
.... language Σ 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding

Required Pattern: application/x-fhir-query
.... expression Σ 0..1 string Expression in specified language
.... reference Σ 0..1 uri Where the expression is found

doco Documentation for this format

This structure is derived from Extension

Summary

Simple 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 View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
... value[x] 0..1 Expression Value of extension
.... language 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Required Pattern: application/x-fhir-query

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension ?! 0..* Extension Member Filter
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... description Σ 0..1 string Natural language description of the condition
.... name Σ 0..1 id Short name assigned to expression for reuse
.... language Σ 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding

Required Pattern: application/x-fhir-query
.... expression Σ 0..1 string Expression in specified language
.... reference Σ 0..1 uri Where the expression is found

doco Documentation for this format

This structure is derived from Extension

Summary

Simple 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

Terminology Bindings

PathConformanceValueSet / CodeURI
Extension.value[x].languageextensiblePattern Value: application/x-fhir-query
http://hl7.org/fhir/ValueSet/expression-language
From the FHIR Standard
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()