SubscriptionTopicCanFilterBy constructor

const SubscriptionTopicCanFilterBy({
  1. @JsonKey(name: 'id') String? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. FhirMarkdown? description,
  5. @JsonKey(name: '_description') Element? descriptionElement,
  6. FhirUri? resource,
  7. @JsonKey(name: '_resource') Element? resourceElement,
  8. String? filterParameter,
  9. @JsonKey(name: '_filterParameter') Element? filterParameterElement,
  10. FhirUri? filterDefinition,
  11. @JsonKey(name: '_filterDefinition') Element? filterDefinitionElement,
  12. List<FhirCode>? comparator,
  13. @JsonKey(name: '_comparator') List<Element>? comparatorElement,
  14. List<FhirCode>? modifier,
  15. @JsonKey(name: '_modifier') List<Element>? modifierElement,
})

SubscriptionTopicCanFilterBy Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.

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

extension_ ("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 managable, 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.

modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

descriptionElement ("_description") Extensions for description

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

resourceElement ("_resource") Extensions for resource

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

filterParameterElement ("_filterParameter") Extensions for filterParameter

filterDefinition 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").

filterDefinitionElement ("_filterDefinition") Extensions for filterDefinition

comparator Comparators allowed for the filter parameter.

comparatorElement ("_comparator") Extensions for comparator

modifier Modifiers allowed for the filter parameter.

modifierElement ("_modifier") Extensions for modifier

Implementation

const factory SubscriptionTopicCanFilterBy({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("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 managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] May be used to represent additional information
  ///  that is not part of the basic definition of the element and that
  ///  modifies the understanding of the element in which it is contained
  ///  and/or the understanding of the containing element's descendants.
  ///  Usually modifier elements provide negation or qualification. To make
  ///  the use of extensions safe and managable, 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.
  ///  Applications processing a resource are required to check for modifier
  ///  extensions.Modifier extensions SHALL NOT change the meaning of any
  ///  elements on Resource or DomainResource (including cannot change the
  ///  meaning of modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [description] Description of how this filtering parameter is intended
  ///  to be used.
  FhirMarkdown? description,

  /// [descriptionElement] ("_description") Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [resource] 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.
  FhirUri? resource,

  /// [resourceElement] ("_resource") Extensions for resource
  @JsonKey(name: '_resource') Element? resourceElement,

  /// [filterParameter] 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.
  String? filterParameter,

  /// [filterParameterElement] ("_filterParameter") Extensions for
  ///  filterParameter
  @JsonKey(name: '_filterParameter') Element? filterParameterElement,

  /// [filterDefinition] 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").
  FhirUri? filterDefinition,

  /// [filterDefinitionElement] ("_filterDefinition") Extensions for
  ///  filterDefinition
  @JsonKey(name: '_filterDefinition') Element? filterDefinitionElement,

  /// [comparator] Comparators allowed for the filter parameter.
  List<FhirCode>? comparator,

  /// [comparatorElement] ("_comparator") Extensions for comparator
  @JsonKey(name: '_comparator') List<Element>? comparatorElement,

  /// [modifier] Modifiers allowed for the filter parameter.
  List<FhirCode>? modifier,

  /// [modifierElement] ("_modifier") Extensions for modifier
  @JsonKey(name: '_modifier') List<Element>? modifierElement,
}) = _SubscriptionTopicCanFilterBy;