This page is part of the Subscriptions R5 Backport (v1.2.0-ballot: STU 1.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v4.3.0. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use |
Definitions for the backport-filter-criteria extension.
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | Criteria for topic-based filtering (filter-by). |
Short | Backported R5 FilterBy Criteria |
2. Extension.extension | |
Control | 0..0 |
4. Extension.url | |
Fixed Value | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria |
6. 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. |
Short | Filtering critiera applied to events |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Type | 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] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | Criteria for topic-based filtering (filter-by). Optional Extension Element - found in all resources. |
Short | Backported R5 FilterBy CriteriaOptional Extensions Element |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | 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. |
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 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. |
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/subscriptions-backport/StructureDefinition/backport-filter-criteria |
6. 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). |
Short | Filtering critiera applied to eventsValue of extension |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Control | 0..1 |
Type | 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] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
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 | Criteria for topic-based filtering (filter-by). |
Short | Backported R5 FilterBy Criteria |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | 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.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 | id |
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 are unordered and Open, and can be differentiated using the following discriminators: |
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/subscriptions-backport/StructureDefinition/backport-filter-criteria |
8. 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. |
Short | Filtering critiera applied to events |
Comments | When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). |
Control | 0..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |