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

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

Extension: ExtensionSubscription_FilterBy - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-Subscription.filterBy extension.

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

0. Extension
Definition

R5: Subscription.filterBy (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Criteria for narrowing the subscription topic stream (new)Optional Extensions Element
Comments

Element Subscription.filterBy has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy has no mapping targets in FHIR STU3. 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() | (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() | (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. In order 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 is allowed to 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.

Control20..*
TypeExtension
Alternate Namesextensions, user content
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:resourceType
    Slice NameresourceType
    Definition

    R5: Subscription.filterBy.resourceType (new:uri)

    ShortR5: Allowed Resource (reference to definition) for this Subscription filter (new)Additional Content defined by implementations
    Comments

    Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    6. Extension.extension:resourceType.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueresourceType
    8. Extension.extension:resourceType.value[x]
    Definition

    A resource listed in the SubscriptionTopic this Subscription references (SubscriptionTopic.canFilterBy.resource). This element can be used to differentiate filters for topics that include more than one resource type.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortAllowed Resource (reference to definition) for this Subscription filterValue of extension
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from For codes, see R5SubscriptionTypesForR3 (0.1.0)
    (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|0.1.0)

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

    Typeuri, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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:filterParameter
    Slice NamefilterParameter
    Definition

    R5: Subscription.filterBy.filterParameter (new:string)

    ShortR5: Filter label defined in SubscriptionTopic (new)Additional Content defined by implementations
    Comments

    Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Requirements

    Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    12. 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValuefilterParameter
    14. Extension.extension:filterParameter.value[x]
    Definition

    The filter as defined in the SubscriptionTopic.canFilterBy.filterParameter element.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortFilter label defined in SubscriptionTopicValue of extension
    Control10..1
    Typestring, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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:comparator
    Slice Namecomparator
    Definition

    R5: Subscription.filterBy.comparator (new:code)

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

    Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

    Control0..1*
    TypeExtension
    Requirements

    Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    18. 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuecomparator
    20. Extension.extension:comparator.value[x]
    Definition

    Comparator applied to this filter parameter.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

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

    Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

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

    Search Comparator Codes applied to this filter.

    Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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:modifier
    Slice Namemodifier
    Definition

    R5: Subscription.filterBy.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 Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

    Control0..1*
    TypeExtension
    Requirements

    Element Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    24. 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuemodifier
    26. Extension.extension:modifier.value[x]
    Definition

    Modifier applied to this filter parameter.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

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

    Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

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

    Search Modifier Code applied to this filter.

    Typecode, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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:value
    Slice Namevalue
    Definition

    R5: Subscription.filterBy.value (new:string)

    ShortR5: Literal value or resource path (new)Additional Content defined by implementations
    Comments

    Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Requirements

    Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    30. Extension.extension:value.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuevalue
    32. Extension.extension:value.value[x]
    Definition

    The literal value or resource path as is legal in search - for example, Patient/123 or le1950.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortLiteral value or resource pathValue of extension
    Control10..1
    Typestring, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy
    36. Extension.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R5: Subscription.filterBy (new:BackboneElement)

    ShortR5: Criteria for narrowing the subscription topic stream (new)
    Comments

    Element Subscription.filterBy has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control2..*
    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:resourceType
      Slice NameresourceType
      Definition

      R5: Subscription.filterBy.resourceType (new:uri)

      ShortR5: Allowed Resource (reference to definition) for this Subscription filter (new)
      Comments

      Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:resourceType.url
      Control1..1
      Fixed ValueresourceType
      8. Extension.extension:resourceType.value[x]
      Definition

      A resource listed in the SubscriptionTopic this Subscription references (SubscriptionTopic.canFilterBy.resource). This element can be used to differentiate filters for topics that include more than one resource type.

      ShortAllowed Resource (reference to definition) for this Subscription filter
      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR3 (0.1.0)
      (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|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
      10. Extension.extension:filterParameter
      Slice NamefilterParameter
      Definition

      R5: Subscription.filterBy.filterParameter (new:string)

      ShortR5: Filter label defined in SubscriptionTopic (new)
      Comments

      Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:filterParameter.url
      Control1..1
      Fixed ValuefilterParameter
      14. Extension.extension:filterParameter.value[x]
      Definition

      The filter as defined in the SubscriptionTopic.canFilterBy.filterParameter element.

      ShortFilter label defined in SubscriptionTopic
      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
      16. Extension.extension:comparator
      Slice Namecomparator
      Definition

      R5: Subscription.filterBy.comparator (new:code)

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

      Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

      Control0..1
      Requirements

      Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:comparator.url
      Control1..1
      Fixed Valuecomparator
      20. Extension.extension:comparator.value[x]
      Definition

      Comparator applied to this filter parameter.

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

      Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

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

      Search Comparator Codes applied to 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
      22. Extension.extension:modifier
      Slice Namemodifier
      Definition

      R5: Subscription.filterBy.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 Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

      Control0..1
      Requirements

      Element Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      24. Extension.extension:modifier.url
      Control1..1
      Fixed Valuemodifier
      26. Extension.extension:modifier.value[x]
      Definition

      Modifier applied to this filter parameter.

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

      Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

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

      Search Modifier Code applied to 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
      28. Extension.extension:value
      Slice Namevalue
      Definition

      R5: Subscription.filterBy.value (new:string)

      ShortR5: Literal value or resource path (new)
      Comments

      Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

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

      The literal value or resource path as is legal in search - for example, Patient/123 or le1950.

      ShortLiteral value or resource path
      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
      34. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy
      36. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: Subscription.filterBy (new:BackboneElement)

      ShortR5: Criteria for narrowing the subscription topic stream (new)
      Comments

      Element Subscription.filterBy has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy has no mapping targets in FHIR STU3. 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() | (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.

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control2..*
      TypeExtension
      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:resourceType
        Slice NameresourceType
        Definition

        R5: Subscription.filterBy.resourceType (new:uri)

        ShortR5: Allowed Resource (reference to definition) for this Subscription filter (new)
        Comments

        Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Requirements

        Element Subscription.filterBy.resourceType is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.resourceType has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.resourceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        8. Extension.extension:resourceType.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        10. Extension.extension:resourceType.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
        Alternate Namesextensions, user content
        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:resourceType.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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed ValueresourceType
          14. Extension.extension:resourceType.value[x]
          Definition

          A resource listed in the SubscriptionTopic this Subscription references (SubscriptionTopic.canFilterBy.resource). This element can be used to differentiate filters for topics that include more than one resource type.

          ShortAllowed Resource (reference to definition) for this Subscription filter
          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR3 (0.1.0)
          (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|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: Subscription.filterBy.filterParameter (new:string)

          ShortR5: Filter label defined in SubscriptionTopic (new)
          Comments

          Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control1..1
          TypeExtension
          Requirements

          Element Subscription.filterBy.filterParameter is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.filterParameter has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.filterParameter has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          20. Extension.extension:filterParameter.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
          Alternate Namesextensions, user content
          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: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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed ValuefilterParameter
            24. Extension.extension:filterParameter.value[x]
            Definition

            The filter as defined in the SubscriptionTopic.canFilterBy.filterParameter element.

            ShortFilter label defined in SubscriptionTopic
            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
            26. Extension.extension:comparator
            Slice Namecomparator
            Definition

            R5: Subscription.filterBy.comparator (new:code)

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

            Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

            Control0..1
            TypeExtension
            Requirements

            Element Subscription.filterBy.comparator is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.comparator has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.comparator has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            30. Extension.extension:comparator.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
            Alternate Namesextensions, user content
            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: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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed Valuecomparator
              34. Extension.extension:comparator.value[x]
              Definition

              Comparator applied to this filter parameter.

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

              Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.

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

              Search Comparator Codes applied to 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
              36. Extension.extension:modifier
              Slice Namemodifier
              Definition

              R5: Subscription.filterBy.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 Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

              Control0..1
              TypeExtension
              Requirements

              Element Subscription.filterBy.modifier is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.modifier has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.modifier has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

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

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              40. Extension.extension:modifier.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
              Alternate Namesextensions, user content
              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: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
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed Valuemodifier
                44. Extension.extension:modifier.value[x]
                Definition

                Modifier applied to this filter parameter.

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

                Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.

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

                Search Modifier Code applied to 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
                46. Extension.extension:value
                Slice Namevalue
                Definition

                R5: Subscription.filterBy.value (new:string)

                ShortR5: Literal value or resource path (new)
                Comments

                Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                Control1..1
                TypeExtension
                Requirements

                Element Subscription.filterBy.value is part of an existing definition because parent element Subscription.filterBy requires a cross-version extension. Element Subscription.filterBy.value has a context of Subscription based on following the parent source element upwards and mapping to Subscription. Element Subscription.filterBy.value has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                48. Extension.extension:value.id
                Definition

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

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                50. Extension.extension:value.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
                Alternate Namesextensions, user content
                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:value.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
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Fixed Valuevalue
                  54. Extension.extension:value.value[x]
                  Definition

                  The literal value or resource path as is legal in search - for example, Patient/123 or le1950.

                  ShortLiteral value or resource path
                  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
                  56. 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
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.filterBy
                  58. Extension.value[x]
                  Definition

                  Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                  ShortValue of extension
                  Control0..0
                  TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension