Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Extension: ExtensionSubscriptionTopic_CanFilterBy - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-SubscriptionTopic.canFilterBy extension.

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

0. Extension
Definition

R5: SubscriptionTopic.canFilterBy (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Properties by which a Subscription can filter notifications from the SubscriptionTopic (new)Optional Extensions Element
Comments

Element SubscriptionTopic.canFilterBy is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-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())
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.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.

ShortExtensionAdditional 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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
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())
SlicingThis 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.extension:description
    Slice Namedescription
    Definition

    R5: SubscriptionTopic.canFilterBy.description (new:markdown)

    ShortR5: Description of this filter parameter (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    6. Extension.extension:description.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuedescription
    8. Extension.extension:description.value[x]
    Definition

    Description of how this filtering parameter is intended to be used.


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

    ShortDescription of this filter parameterValue of extension
    Control0..1
    Typemarkdown, 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, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.extension:resource
    Slice Nameresource
    Definition

    R5: SubscriptionTopic.canFilterBy.resource (new:uri)

    ShortR5: URL of the triggering Resource that this filter applies to (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    12. Extension.extension:resource.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueresource
    14. Extension.extension:resource.value[x]
    Definition

    URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.


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

    ShortURL of the triggering Resource that this filter applies toValue of extension
    Comments

    URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from For codes, see R5SubscriptionTypesForR4 (0.1.0)
    (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R4|0.1.0)

    A type of resource, or a Reference (from all versions)

    Typeuri, 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, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Extension.extension:filterParameter
    Slice NamefilterParameter
    Definition

    R5: SubscriptionTopic.canFilterBy.filterParameter (new:string)

    ShortR5: Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    18. Extension.extension:filterParameter.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed ValuefilterParameter
    20. Extension.extension:filterParameter.value[x]
    Definition

    Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.


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

    ShortHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameterValue of extension
    Comments

    Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

    Control10..1
    Typestring, 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, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Extension.extension:filterDefinition
    Slice NamefilterDefinition
    Definition

    R5: SubscriptionTopic.canFilterBy.filterDefinition (new:uri)

    ShortR5: Canonical URL for a filterParameter definition (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    24. Extension.extension:filterDefinition.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed ValuefilterDefinition
    26. Extension.extension:filterDefinition.value[x]
    Definition

    Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event").


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

    ShortCanonical URL for a filterParameter definitionValue of extension
    Comments

    Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

    Control0..1
    Typeuri, 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, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Extension.extension:comparator
    Slice Namecomparator
    Definition

    R5: SubscriptionTopic.canFilterBy.comparator (new:code)

    ShortR5: eq | ne | gt | lt | ge | le | sa | eb | ap (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no comparators are listed, clients should not expect servers to support any comparators.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    30. Extension.extension:comparator.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuecomparator
    32. Extension.extension:comparator.value[x]
    Definition

    Comparators allowed for the filter parameter.


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

    Shorteq | ne | gt | lt | ge | le | sa | eb | apValue of extension
    Comments

    If no comparators are listed, clients should not expect servers to support any comparators.

    Control0..1
    BindingThe codes SHALL be taken from For codes, see SearchComparator
    (required to http://hl7.org/fhir/ValueSet/search-comparator|4.0.1)

    Search Comparator Codes supported in this filter.

    Typecode, 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, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Extension.extension:modifier
    Slice Namemodifier
    Definition

    R5: SubscriptionTopic.canFilterBy.modifier (new:code)

    ShortR5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate (new)Additional content defined by implementations
    Comments

    Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no modifiers are listed, clients should not expect servers to support any modifiers.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-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())
    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())
    36. Extension.extension:modifier.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuemodifier
    38. Extension.extension:modifier.value[x]
    Definition

    Modifiers allowed for the filter parameter.


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

    Shortmissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterateValue of extension
    Comments

    If no modifiers are listed, clients should not expect servers to support any modifiers.

    Control0..1
    BindingThe codes SHALL be taken from For codes, see R5SearchModifierCodeForR4 (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-search-modifier-code-for-R4|0.1.0)

    Search Modifier Codes supported in this filter.

    Typecode, 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, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Extension.url
    Definition

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

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy
    42. Extension.value[x]
    Definition

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

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    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 foundhere

    0. Extension
    Definition

    R5: SubscriptionTopic.canFilterBy (new:BackboneElement)

    ShortR5: Properties by which a Subscription can filter notifications from the SubscriptionTopic (new)
    Comments

    Element SubscriptionTopic.canFilterBy is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control1..*
    SlicingThis 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.extension:description
      Slice Namedescription
      Definition

      R5: SubscriptionTopic.canFilterBy.description (new:markdown)

      ShortR5: Description of this filter parameter (new)
      Comments

      Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:description.url
      Control1..1
      Fixed Valuedescription
      8. Extension.extension:description.value[x]
      Definition

      Description of how this filtering parameter is intended to be used.

      ShortDescription of this filter parameter
      Control0..1
      Typemarkdown
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. Extension.extension:resource
      Slice Nameresource
      Definition

      R5: SubscriptionTopic.canFilterBy.resource (new:uri)

      ShortR5: URL of the triggering Resource that this filter applies to (new)
      Comments

      Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

      Control0..1
      Requirements

      Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:resource.url
      Control1..1
      Fixed Valueresource
      14. Extension.extension:resource.value[x]
      Definition

      URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.

      ShortURL of the triggering Resource that this filter applies to
      Comments

      URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR4 (0.1.0)
      (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R4|0.1.0)

      A type of resource, or a Reference (from all versions)

      Typeuri
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Extension.extension:filterParameter
      Slice NamefilterParameter
      Definition

      R5: SubscriptionTopic.canFilterBy.filterParameter (new:string)

      ShortR5: Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter (new)
      Comments

      Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

      Control1..1
      Requirements

      Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:filterParameter.url
      Control1..1
      Fixed ValuefilterParameter
      20. Extension.extension:filterParameter.value[x]
      Definition

      Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.

      ShortHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
      Comments

      Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

      Control1..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. Extension.extension:filterDefinition
      Slice NamefilterDefinition
      Definition

      R5: SubscriptionTopic.canFilterBy.filterDefinition (new:uri)

      ShortR5: Canonical URL for a filterParameter definition (new)
      Comments

      Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

      Control0..1
      Requirements

      Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      24. Extension.extension:filterDefinition.url
      Control1..1
      Fixed ValuefilterDefinition
      26. Extension.extension:filterDefinition.value[x]
      Definition

      Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event").

      ShortCanonical URL for a filterParameter definition
      Comments

      Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

      Control0..1
      Typeuri
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. Extension.extension:comparator
      Slice Namecomparator
      Definition

      R5: SubscriptionTopic.canFilterBy.comparator (new:code)

      ShortR5: eq | ne | gt | lt | ge | le | sa | eb | ap (new)
      Comments

      Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no comparators are listed, clients should not expect servers to support any comparators.

      Control0..*
      Requirements

      Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      30. Extension.extension:comparator.url
      Control1..1
      Fixed Valuecomparator
      32. Extension.extension:comparator.value[x]
      Definition

      Comparators allowed for the filter parameter.

      Shorteq | ne | gt | lt | ge | le | sa | eb | ap
      Comments

      If no comparators are listed, clients should not expect servers to support any comparators.

      Control0..1
      BindingThe codes SHALL be taken from SearchComparator
      (required to http://hl7.org/fhir/ValueSet/search-comparator|4.0.1)

      Search Comparator Codes supported in this filter.

      Typecode
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. Extension.extension:modifier
      Slice Namemodifier
      Definition

      R5: SubscriptionTopic.canFilterBy.modifier (new:code)

      ShortR5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate (new)
      Comments

      Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no modifiers are listed, clients should not expect servers to support any modifiers.

      Control0..*
      Requirements

      Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      36. Extension.extension:modifier.url
      Control1..1
      Fixed Valuemodifier
      38. Extension.extension:modifier.value[x]
      Definition

      Modifiers allowed for the filter parameter.

      Shortmissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
      Comments

      If no modifiers are listed, clients should not expect servers to support any modifiers.

      Control0..1
      BindingThe codes SHALL be taken from R5SearchModifierCodeForR4 (0.1.0)
      (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-search-modifier-code-for-R4|0.1.0)

      Search Modifier Codes supported in this filter.

      Typecode
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy
      42. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: SubscriptionTopic.canFilterBy (new:BackboneElement)

      ShortR5: Properties by which a Subscription can filter notifications from the SubscriptionTopic (new)
      Comments

      Element SubscriptionTopic.canFilterBy is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-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.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-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())
      SlicingThis 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.extension:description
        Slice Namedescription
        Definition

        R5: SubscriptionTopic.canFilterBy.description (new:markdown)

        ShortR5: Description of this filter parameter (new)
        Comments

        Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element SubscriptionTopic.canFilterBy.description is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.description is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Invariantsele-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())
        8. Extension.extension:description.id
        Definition

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

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:description.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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:description.url
          Definition

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

          Shortidentifies 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.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuedescription
          14. Extension.extension:description.value[x]
          Definition

          Description of how this filtering parameter is intended to be used.

          ShortDescription of this filter parameter
          Control0..1
          Typemarkdown
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Extension.extension:resource
          Slice Nameresource
          Definition

          R5: SubscriptionTopic.canFilterBy.resource (new:uri)

          ShortR5: URL of the triggering Resource that this filter applies to (new)
          Comments

          Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element SubscriptionTopic.canFilterBy.resource is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.resource is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.resource has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Invariantsele-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())
          18. Extension.extension:resource.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:resource.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.

          ShortAdditional 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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:resource.url
            Definition

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

            Shortidentifies 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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valueresource
            24. Extension.extension:resource.value[x]
            Definition

            URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.

            ShortURL of the triggering Resource that this filter applies to
            Comments

            URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR4 (0.1.0)
            (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R4|0.1.0)

            A type of resource, or a Reference (from all versions)

            Typeuri
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Extension.extension:filterParameter
            Slice NamefilterParameter
            Definition

            R5: SubscriptionTopic.canFilterBy.filterParameter (new:string)

            ShortR5: Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter (new)
            Comments

            Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

            Control1..1
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Requirements

            Element SubscriptionTopic.canFilterBy.filterParameter is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterParameter is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterParameter has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

            Invariantsele-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())
            28. Extension.extension:filterParameter.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            30. Extension.extension:filterParameter.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.

            ShortAdditional 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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Extension.extension:filterParameter.url
              Definition

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

              Shortidentifies 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.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed ValuefilterParameter
              34. Extension.extension:filterParameter.value[x]
              Definition

              Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.

              ShortHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
              Comments

              Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

              Control1..1
              Typestring
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Extension.extension:filterDefinition
              Slice NamefilterDefinition
              Definition

              R5: SubscriptionTopic.canFilterBy.filterDefinition (new:uri)

              ShortR5: Canonical URL for a filterParameter definition (new)
              Comments

              Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

              Control0..1
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Requirements

              Element SubscriptionTopic.canFilterBy.filterDefinition is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.filterDefinition is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.filterDefinition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

              Invariantsele-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())
              38. Extension.extension:filterDefinition.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              40. Extension.extension:filterDefinition.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.

              ShortAdditional 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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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())
              SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 42. Extension.extension:filterDefinition.url
                Definition

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

                Shortidentifies 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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed ValuefilterDefinition
                44. Extension.extension:filterDefinition.value[x]
                Definition

                Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event").

                ShortCanonical URL for a filterParameter definition
                Comments

                Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

                Control0..1
                Typeuri
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                46. Extension.extension:comparator
                Slice Namecomparator
                Definition

                R5: SubscriptionTopic.canFilterBy.comparator (new:code)

                ShortR5: eq | ne | gt | lt | ge | le | sa | eb | ap (new)
                Comments

                Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no comparators are listed, clients should not expect servers to support any comparators.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Requirements

                Element SubscriptionTopic.canFilterBy.comparator is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.comparator is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.comparator has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                Invariantsele-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())
                48. Extension.extension:comparator.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                50. Extension.extension:comparator.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.

                ShortAdditional 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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 52. Extension.extension:comparator.url
                  Definition

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

                  Shortidentifies 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.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuecomparator
                  54. Extension.extension:comparator.value[x]
                  Definition

                  Comparators allowed for the filter parameter.

                  Shorteq | ne | gt | lt | ge | le | sa | eb | ap
                  Comments

                  If no comparators are listed, clients should not expect servers to support any comparators.

                  Control0..1
                  BindingThe codes SHALL be taken from SearchComparator
                  (required to http://hl7.org/fhir/ValueSet/search-comparator|4.0.1)

                  Search Comparator Codes supported in this filter.

                  Typecode
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Extension.extension:modifier
                  Slice Namemodifier
                  Definition

                  R5: SubscriptionTopic.canFilterBy.modifier (new:code)

                  ShortR5: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate (new)
                  Comments

                  Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If no modifiers are listed, clients should not expect servers to support any modifiers.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Element SubscriptionTopic.canFilterBy.modifier is part of an existing definition because parent element SubscriptionTopic.canFilterBy requires a cross-version extension. Element SubscriptionTopic.canFilterBy.modifier is not mapped to FHIR R4, since FHIR R5 SubscriptionTopic is not mapped. Element SubscriptionTopic.canFilterBy.modifier has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                  Invariantsele-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())
                  58. Extension.extension:modifier.id
                  Definition

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

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  60. Extension.extension:modifier.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.

                  ShortAdditional 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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-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())
                  SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 62. Extension.extension:modifier.url
                    Definition

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

                    Shortidentifies 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.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valuemodifier
                    64. Extension.extension:modifier.value[x]
                    Definition

                    Modifiers allowed for the filter parameter.

                    Shortmissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
                    Comments

                    If no modifiers are listed, clients should not expect servers to support any modifiers.

                    Control0..1
                    BindingThe codes SHALL be taken from R5SearchModifierCodeForR4 (0.1.0)
                    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-search-modifier-code-for-R4|0.1.0)

                    Search Modifier Codes supported in this filter.

                    Typecode
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. Extension.url
                    Definition

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

                    Shortidentifies 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.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.canFilterBy
                    68. Extension.value[x]
                    Definition

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

                    ShortValue of extension
                    Control0..0
                    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))