This page is part of the Subscriptions R5 Backport (v1.1.0: STU 1.1) based on FHIR v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Active as of 2023-01-11 |
Definitions for the backport-filter-criteria extension.
Guidance on how to interpret the contents of this table can be found here.
1. Extension | |
Definition | Criteria for topic-based filtering (filter-by). Optional Extension Element - found in all resources. |
2. Extension.extension | |
Control | 0..0* |
3. Extension.url | |
Fixed Value | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
4. Extension.value[x] | |
Definition | Search-style filters to be applied to narrow the subscription topic stream. Keys can be either search parameters appropriate to the filtering resource or keys defined within the subscription topic. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Type | Choice of: , date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Guidance on how to interpret the contents of this table can be found here.
1. Extension | |
Definition | Criteria for topic-based filtering (filter-by). Optional Extension Element - found in all resources. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) 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. |
Control | 0..0* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
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. |
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
3. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Fixed Value | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
4. Extension.value[x] | |
Definition | Search-style filters to be applied to narrow the subscription topic stream. Keys can be either search parameters appropriate to the filtering resource or keys defined within the subscription topic. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 |
Type | Choice of: string, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Invariants | Defined on this element 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.
1. Extension | |
Definition | Criteria for topic-based filtering (filter-by). |
Control | 0..* This element is affected by the following invariants: ele-1 |
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. |
Control | 0..1 |
Type | id |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
3. Extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Summary | false |
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
4. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Fixed Value | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
5. Extension.value[x] | |
Definition | Search-style filters to be applied to narrow the subscription topic stream. Keys can be either search parameters appropriate to the filtering resource or keys defined within the subscription topic. |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |