Bulk Data Access IG
2.0.0 - ci-build 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 2.0.0 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: 2.0.0
Draft as of 2024-11-04 Computable Name: MemberFilter

Extension to define the population of the group using FHIR REST API parameters

Context of Use

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

  • Element ID Group

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Simple Extension of type Expression: Extension to define the population of the group using FHIR REST API parameters

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 & Constraintsdoco
.. 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 of type Expression: Extension to define the population of the group using FHIR REST API parameters

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 & Constraintsdoco
.. 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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

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()