SubscriptionTopic class
SubscriptionTopic Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
SubscriptionTopic({@Default(R4ResourceType.SubscriptionTopic) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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? title, @JsonKey(name: '_title') Element? titleElement, List<FhirCanonical> ? derivedFrom, 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, 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.
constfactory
-
SubscriptionTopic.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- SubscriptionTopic.fromJsonString(String source)
-
Acts like a constructor, returns a SubscriptionTopic, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- SubscriptionTopic.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- approvalDate → FhirDate?
-
no setterinherited
- approvalDateElement → Element?
-
no setterinherited
-
canFilterBy
→ List<
SubscriptionTopicCanFilterBy> ? -
no setterinherited
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating with the publisher.;
no setterinherited
-
contained
→ List<
Resource> ? -
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.;
no setterinherited
- copyright → FhirMarkdown?
-
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.;
no setterinherited
- copyrightElement → Element?
-
copyrightElement (_copyright): Extensions for copyright;
no setterinherited
-
copyWith
→ $SubscriptionTopicCopyWith<
SubscriptionTopic> -
no setterinherited
- date → FhirDateTime?
-
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.;
no setterinherited
- dateElement → Element?
-
dateElement (_date): Extensions for date;
no setterinherited
- dbId → int?
-
no setterinherited
-
derivedFrom
→ List<
FhirCanonical> ? -
no setterinherited
- description → FhirMarkdown?
-
description A free text natural language description of the Topic from the consumer's perspective.;
no setterinherited
- descriptionElement → Element?
-
descriptionElement (_description): Extensions for description;
no setterinherited
- effectivePeriod → Period?
-
no setterinherited
-
eventTrigger
→ List<
SubscriptionTopicEventTrigger> ? -
no setterinherited
- experimental → FhirBoolean?
-
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.;
no setterinherited
- experimentalElement → Element?
-
experimentalElement (_experimental): Extensions for experimental;
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.;
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
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.;
no setterinherited
- implicitRules → FhirUri?
-
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.;
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement (_implicitRules): Extensions for implicitRules;
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A jurisdiction in which the Topic is intended to be used.;
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.;
no setterinherited
- languageElement → Element?
-
languageElement (_language): Extensions for language;
no setterinherited
- lastReviewDate → FhirDate?
-
no setterinherited
- lastReviewDateElement → Element?
-
no setterinherited
- meta → FhirMeta?
-
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.;
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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).;
no setterinherited
-
notificationShape
→ List<
SubscriptionTopicNotificationShape> ? -
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- publisher → String?
-
publisher Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.;
no setterinherited
- publisherElement → Element?
-
publisherElement (_publisher): Extensions for publisher;
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explains why this Topic is needed and why it has been designed as it has.;
no setterinherited
- purposeElement → Element?
-
purposeElement (_purpose): Extensions for purpose;
no setterinherited
-
resourceTrigger
→ List<
SubscriptionTopicResourceTrigger> ? -
no setterinherited
- resourceType → R4ResourceType
-
resourceType This is a SubscriptionTopic resource;
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The current state of the SubscriptionTopic.;
no setterinherited
- statusElement → Element?
-
statusElement (_status): Extensions for status;
no setterinherited
- text → Narrative?
-
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.;
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".;
no setterinherited
- titleElement → Element?
-
titleElement (_title): Extensions for title;
no setterinherited
- url → FhirUri?
-
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.;
no setterinherited
- urlElement → Element?
-
urlElement (_url): Extensions for url;
no setterinherited
-
useContext
→ List<
UsageContext> ? -
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.;
no setterinherited
- version → String?
-
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.;
no setterinherited
- versionElement → Element?
-
versionElement (_version): Extensions for version;
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited