SubscriptionTopic constructor

const SubscriptionTopic({ @Default(R5ResourceType.SubscriptionTopic) @JsonKey(unknownEnumValue: R5ResourceType.SubscriptionTopic) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, List<Identifier>? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, List<FhirCanonical>? derivedFrom, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<SubscriptionTopicResourceTrigger>? resourceTrigger, List<SubscriptionTopicEventTrigger>? eventTrigger, List<SubscriptionTopicCanFilterBy>? canFilterBy, List<SubscriptionTopicNotificationShape>? notificationShape, })

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

resourceType This is a SubscriptionTopic resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

text A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the resource. 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 resource and that modifies the understanding of the element that contains it 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 is allowed to 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).

url An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.

urlElement ("_url") Extensions for url

identifier Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

version The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

versionElement ("_version") Extensions for version

versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.

name A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation.

nameElement ("_name") Extensions for name

title A short, descriptive, user-friendly title for the subscription topic. For example, "admission".

titleElement ("_title") Extensions for title

status The current state of the SubscriptionTopic.

statusElement ("_status") Extensions for status

experimental A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

experimentalElement ("_experimental") Extensions for experimental

date The date (and optionally time) when the subscription topic was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the subscription topic changes.

dateElement ("_date") Extensions for date

publisher Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.

publisherElement ("_publisher") Extensions for publisher

contact Contact details to assist a user in finding and communicating with the publisher.

description A free text natural language description of the Topic from the consumer's perspective.

descriptionElement ("_description") Extensions for description

useContext The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

jurisdiction A jurisdiction in which the Topic is intended to be used.

purpose Explains why this Topic is needed and why it has been designed as it has.

purposeElement ("_purpose") Extensions for purpose

copyright A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.

copyrightElement ("_copyright") Extensions for copyright

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

derivedFrom The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

approvalDate The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

approvalDateElement ("_approvalDate") Extensions for approvalDate

lastReviewDate The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate

effectivePeriod The period during which the SubscriptionTopic content was or is planned to be effective.

resourceTrigger A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

eventTrigger Event definition which can be used to trigger the SubscriptionTopic.

canFilterBy List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

notificationShape List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

Implementation

const factory SubscriptionTopic({
  /// [resourceType] This is a SubscriptionTopic resource
  @Default(R5ResourceType.SubscriptionTopic)
  @JsonKey(unknownEnumValue: R5ResourceType.SubscriptionTopic)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [meta] The metadata about the resource. This is content that is
  ///  maintained by the infrastructure. Changes to the content might not
  ///  always be associated with version changes to the resource.
  FhirMeta? meta,

  /// [implicitRules] A reference to a set of rules that were followed when
  ///  the resource was constructed, and which must be understood when
  ///  processing the content. Often, this is a reference to an
  ///  implementation guide that defines the special rules along with other
  ///  profiles etc.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] A human-readable narrative that contains a summary of the
  ///  resource and can be used to represent the content of the resource to a
  ///  human. The narrative need not encode all the structured data, but is
  ///  required to contain sufficient detail to make it "clinically safe" for
  ///  a human to just read the narrative. Resource definitions may define
  ///  what content should be represented in the narrative to ensure clinical
  ///  safety.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  ///  from the resource that contains them - they cannot be identified
  ///  independently, nor can they have their own independent transaction
  ///  scope. This is allowed to be a Parameters resource if and only if it
  ///  is referenced by a resource that provides context/meaning.
  List<Resource>? contained,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the resource.
  ///  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 resource and that
  ///  modifies the understanding of the element that contains it 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 is allowed to 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,

  /// [url] An absolute URI that is used to identify this subscription topic
  ///  when it is referenced in a specification, model, design or an
  ///  instance; also called its canonical identifier. This SHOULD be
  ///  globally unique and SHOULD be a literal address at which an
  ///  authoritative instance of this subscription topic is (or will be)
  ///  published. This URL can be the target of a canonical reference. It
  ///  SHALL remain the same when the subscription topic is stored on
  ///  different servers.
  FhirUri? url,

  /// [urlElement] ("_url") Extensions for url
  @JsonKey(name: '_url') Element? urlElement,

  /// [identifier] Business identifiers assigned to this subscription topic
  ///  by the performer and/or other systems.  These identifiers remain
  ///  constant as the resource is updated and propagates from server to
  ///  server.
  List<Identifier>? identifier,

  /// [version] The identifier that is used to identify this version of the
  ///  subscription topic when it is referenced in a specification, model,
  ///  design or instance. This is an arbitrary value managed by the Topic
  ///  author and is not expected to be globally unique. For example, it
  ///  might be a timestamp (e.g. yyyymmdd) if a managed version is not
  ///  available. There is also no expectation that versions are orderable.
  String? version,

  /// [versionElement] ("_version") Extensions for version
  @JsonKey(name: '_version') Element? versionElement,

  /// [versionAlgorithmString] Indicates the mechanism used to compare
  ///  versions to determine which is more current.
  String? versionAlgorithmString,

  /// [versionAlgorithmStringElement] ("_versionAlgorithmString") Extensions
  ///  for versionAlgorithmString
  @JsonKey(name: '_versionAlgorithmString')
  Element? versionAlgorithmStringElement,

  /// [versionAlgorithmCoding] Indicates the mechanism used to compare
  ///  versions to determine which is more current.
  Coding? versionAlgorithmCoding,

  /// [name] A natural language name identifying the subscription topic This
  ///  name should be usable as an identifier for the module by machine
  ///  processing applications such as code generation.
  String? name,

  /// [nameElement] ("_name") Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [title] A short, descriptive, user-friendly title for the subscription
  ///  topic.  For example, "admission".
  String? title,

  /// [titleElement] ("_title") Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [status] The current state of the SubscriptionTopic.
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [experimental] A flag to indicate that this TopSubscriptionTopicic is
  ///  authored for testing purposes (or education/evaluation/marketing), and
  ///  is not intended to be used for genuine usage.
  FhirBoolean? experimental,

  /// [experimentalElement] ("_experimental") Extensions for experimental
  @JsonKey(name: '_experimental') Element? experimentalElement,

  /// [date] The date (and optionally time) when the subscription topic was
  ///  last significantly changed. The date must change when the business
  ///  version changes and it must change if the status code changes. In
  ///  addition, it should change when the substantive content of the
  ///  subscription topic changes.
  FhirDateTime? date,

  /// [dateElement] ("_date") Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [publisher] Helps establish the "authority/credibility" of the
  ///  SubscriptionTopic.  May also allow for contact.
  String? publisher,

  /// [publisherElement] ("_publisher") Extensions for publisher
  @JsonKey(name: '_publisher') Element? publisherElement,

  /// [contact] Contact details to assist a user in finding and communicating
  ///  with the publisher.
  List<ContactDetail>? contact,

  /// [description] A free text natural language description of the Topic
  ///  from the consumer's perspective.
  FhirMarkdown? description,

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

  /// [useContext] The content was developed with a focus and intent of
  ///  supporting the contexts that are listed. These terms may be used to
  ///  assist with indexing and searching of code system definitions.
  List<UsageContext>? useContext,

  /// [jurisdiction] A jurisdiction in which the Topic is intended to be used.
  List<CodeableConcept>? jurisdiction,

  /// [purpose] Explains why this Topic is needed and why it has been
  ///  designed as it has.
  FhirMarkdown? purpose,

  /// [purposeElement] ("_purpose") Extensions for purpose
  @JsonKey(name: '_purpose') Element? purposeElement,

  /// [copyright] A copyright statement relating to the SubscriptionTopic
  ///  and/or its contents. Copyright statements are generally legal
  ///  restrictions on the use and publishing of the SubscriptionTopic.
  FhirMarkdown? copyright,

  /// [copyrightElement] ("_copyright") Extensions for copyright
  @JsonKey(name: '_copyright') Element? copyrightElement,

  /// [copyrightLabel] A short string (<50 characters), suitable for
  ///  inclusion in a page footer that identifies the copyright holder,
  ///  effective period, and optionally whether rights are resctricted. (e.g.
  ///  'All rights reserved', 'Some rights reserved').
  String? copyrightLabel,

  /// [copyrightLabelElement] ("_copyrightLabel") Extensions for
  ///  copyrightLabel
  @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement,

  /// [derivedFrom] The canonical URL pointing to another FHIR-defined
  ///  SubscriptionTopic that is adhered to in whole or in part by this
  ///  SubscriptionTopic.
  List<FhirCanonical>? derivedFrom,

  /// [approvalDate] The date on which the asset content was approved by the
  ///  publisher. Approval happens once when the content is officially
  ///  approved for usage.
  FhirDate? approvalDate,

  /// [approvalDateElement] ("_approvalDate") Extensions for approvalDate
  @JsonKey(name: '_approvalDate') Element? approvalDateElement,

  /// [lastReviewDate] The date on which the asset content was last reviewed.
  ///  Review happens periodically after that, but doesn't change the
  ///  original approval date.
  FhirDate? lastReviewDate,

  /// [lastReviewDateElement] ("_lastReviewDate") Extensions for
  ///  lastReviewDate
  @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,

  /// [effectivePeriod] The period during which the SubscriptionTopic content
  ///  was or is planned to be effective.
  Period? effectivePeriod,

  /// [resourceTrigger] A definition of a resource-based event that triggers
  ///  a notification based on the SubscriptionTopic. The criteria may be
  ///  just a human readable description and/or a full FHIR search string or
  ///  FHIRPath expression. Multiple triggers are considered OR joined (e.g.,
  ///  a resource update matching ANY of the definitions will trigger a
  ///  notification).
  List<SubscriptionTopicResourceTrigger>? resourceTrigger,

  /// [eventTrigger] Event definition which can be used to trigger the
  ///  SubscriptionTopic.
  List<SubscriptionTopicEventTrigger>? eventTrigger,

  /// [canFilterBy] List of properties by which Subscriptions on the
  ///  SubscriptionTopic can be filtered. May be defined Search Parameters
  ///  (e.g., Encounter.patient) or parameters defined within this
  ///  SubscriptionTopic context (e.g., hub.event).
  List<SubscriptionTopicCanFilterBy>? canFilterBy,

  /// [notificationShape] List of properties to describe the shape (e.g.,
  ///  resources) included in notifications from this Subscription Topic.
  List<SubscriptionTopicNotificationShape>? notificationShape,
}) = _SubscriptionTopic;