SubscriptionTopic constructor

const SubscriptionTopic({
  1. @Default(R4ResourceType.SubscriptionTopic) R4ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') String? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. FhirUri? url,
  14. @JsonKey(name: '_url') Element? urlElement,
  15. List<Identifier>? identifier,
  16. String? version,
  17. @JsonKey(name: '_version') Element? versionElement,
  18. String? title,
  19. @JsonKey(name: '_title') Element? titleElement,
  20. List<FhirCanonical>? derivedFrom,
  21. FhirCode? status,
  22. @JsonKey(name: '_status') Element? statusElement,
  23. FhirBoolean? experimental,
  24. @JsonKey(name: '_experimental') Element? experimentalElement,
  25. FhirDateTime? date,
  26. @JsonKey(name: '_date') Element? dateElement,
  27. String? publisher,
  28. @JsonKey(name: '_publisher') Element? publisherElement,
  29. List<ContactDetail>? contact,
  30. FhirMarkdown? description,
  31. @JsonKey(name: '_description') Element? descriptionElement,
  32. List<UsageContext>? useContext,
  33. List<CodeableConcept>? jurisdiction,
  34. FhirMarkdown? purpose,
  35. @JsonKey(name: '_purpose') Element? purposeElement,
  36. FhirMarkdown? copyright,
  37. @JsonKey(name: '_copyright') Element? copyrightElement,
  38. FhirDate? approvalDate,
  39. @JsonKey(name: '_approvalDate') Element? approvalDateElement,
  40. FhirDate? lastReviewDate,
  41. @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement,
  42. Period? effectivePeriod,
  43. List<SubscriptionTopicResourceTrigger>? resourceTrigger,
  44. List<SubscriptionTopicEventTrigger>? eventTrigger,
  45. List<SubscriptionTopicCanFilterBy>? canFilterBy,
  46. 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.;

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

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

title A short, descriptive, user-friendly title for the SubscriptionTopic, 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 For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.;

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;

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

///
/// [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.;
///
/// [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 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.;
///
/// [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 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. 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 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;
///
/// [title] A short, descriptive, user-friendly title for the SubscriptionTopic, 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] For draft definitions, indicates the date of initial creation.  For active definitions, represents the date of activation.  For withdrawn definitions, indicates the date of withdrawal.;
///
/// [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;
///
/// [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.;
const factory SubscriptionTopic({
  /// [resourceType] This is a SubscriptionTopic resource;
  @Default(R4ResourceType.SubscriptionTopic) R4ResourceType 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') String? 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.;
  List<Resource>? contained,

  /// [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 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.;
  @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 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. 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 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,

  /// [title] A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".;
  String? title,

  /// [titleElement] (_title): Extensions for title;
  @JsonKey(name: '_title') Element? titleElement,
  List<FhirCanonical>? derivedFrom,

  /// [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] For draft definitions, indicates the date of initial creation.  For active definitions, represents the date of activation.  For withdrawn definitions, indicates the date of withdrawal.;
  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,
  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;