Member Filter - Definitions - Bulk Data Access IG v2.0.0

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: MemberFilter - Detailed Descriptions

Draft as of 2024-11-04

Definitions for the member-filter extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	Extension to define the population of the group using FHIR REST API parameters
Short	Member Filter
Is Modifier	true because Filters members of group to a subset
2. Extension.extension
Control	0..0
4. Extension.url
Fixed Value	`http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter`
6. Extension.value[x]
Type	Expression, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
8. Extension.value[x].language
Pattern Value	`application/x-fhir-query`

Guidance on how to interpret the contents of this table can be found here

0. Extension

Definition

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

Optional Extension Element - found in all resources.

Short Member FilterOptional Extensions Element

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier truefalse because Filters members of group to a subset

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

2. Extension.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..0*

Type

Extension

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

4. Extension.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1

Type

uri

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter

6. Extension.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..1

Type Expression, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Extension.value[x].language

Definition

The media type of the language for the expression.

Short text/cql | text/fhirpath | application/x-fhir-query | etc.

Control 1..1

Binding

Unless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language
(extensible to http://hl7.org/fhir/ValueSet/expression-language)

The media type of the expression language.

Additional Bindings

Purpose

http://www.rfc-editor.org/bcp/bcp13.txt

Max Binding

Type

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Pattern Value application/x-fhir-query

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension

Definition

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

Short Member Filter

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier true because Filters members of group to a subset

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

2. Extension.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

4. Extension.extension

Definition

An Extension

Short Extension

Control 0..0

Type

Extension

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

6. Extension.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1

Type

uri

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter

8. Extension.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 0..1

Type

Expression

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Extension.value[x].id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Type

string

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

12. Extension.value[x].extension

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*

Type

Extension

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

14. Extension.value[x].description

Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Short Natural language description of the condition

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

16. Extension.value[x].name

Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

Short Short name assigned to expression for reuse

Control 0..1

Type

id

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. Extension.value[x].language

Definition

The media type of the language for the expression.

Short text/cql | text/fhirpath | application/x-fhir-query | etc.

Control 1..1

Binding

Unless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language)

The media type of the expression language.

Additional Bindings

Purpose

http://www.rfc-editor.org/bcp/bcp13.txt

Max Binding

Type

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Pattern Value application/x-fhir-query

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. Extension.value[x].expression

Definition

An expression in the specified language that returns a value.

Short Expression in specified language

Control 0..1

Type

string

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. Extension.value[x].reference

Definition

A URI that defines where the expression is found.

Short Where the expression is found

Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control 0..1

Type

uri

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

IG © 2021+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.bulkdata#2.0.0 based on FHIR 4.0.1. Generated 2024-11-04
Links: Table of Contents | QA Report | Version History | | Propose a change