Subscription class

Subscription The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

Subscription({@Default(R5ResourceType.Subscription) @JsonKey(unknownEnumValue: R5ResourceType.Subscription) 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, List<Identifier>? identifier, String? name, @JsonKey(name: '_name') Element? nameElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, required FhirCanonical topic, List<ContactPoint>? contact, FhirInstant? end, @JsonKey(name: '_end') Element? endElement, Reference? managingEntity, String? reason, @JsonKey(name: '_reason') Element? reasonElement, List<SubscriptionFilterBy>? filterBy, required Coding channelType, FhirUrl? endpoint, @JsonKey(name: '_endpoint') Element? endpointElement, List<SubscriptionParameter>? parameter, FhirUnsignedInt? heartbeatPeriod, @JsonKey(name: '_heartbeatPeriod') Element? heartbeatPeriodElement, FhirUnsignedInt? timeout, @JsonKey(name: '_timeout') Element? timeoutElement, FhirCode? contentType, @JsonKey(name: '_contentType') Element? contentTypeElement, FhirCode? content, @JsonKey(name: '_content') Element? contentElement, FhirPositiveInt? maxCount, @JsonKey(name: '_maxCount') Element? maxCountElement})

Subscription The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

const

factory

Subscription.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

Subscription.fromJsonString(String source)

Acts like a constructor, returns a Subscription, accepts a String as an argument, mostly because I got tired of typing it out

factory

Subscription.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

channelType → Coding

channelType The type of channel to send notifications on.

no setter, inherited

contact → List<ContactPoint>?

contact Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

no setter, inherited

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. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

content → FhirCode?

content How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.

no setter, inherited

contentElement → Element?

contentElement ("_content") Extensions for content

no setter, inherited

contentType → FhirCode?

contentType The MIME type to send the payload in - e.g., application/fhir+xml or application/fhir+json. Note that:

no setter, inherited

contentTypeElement → Element?

contentTypeElement ("_contentType") Extensions for contentType

no setter, inherited

copyWith → $SubscriptionCopyWith<Subscription>

no setter, inherited

dbId → int?

no setter, inherited

end → FhirInstant?

end The time for the server to turn the subscription off.

no setter, inherited

endElement → Element?

endElement ("_end") Extensions for end

no setter, inherited

endpoint → FhirUrl?

endpoint The url that describes the actual end-point to send notifications to.

no setter, inherited

endpointElement → Element?

endpointElement ("_endpoint") Extensions for endpoint

no setter, inherited

extension_ → List<FhirExtension>?

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.

no setter, inherited

fhirId → FhirId?

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

no setter, inherited

filterBy → List<SubscriptionFilterBy>?

filterBy The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

heartbeatPeriod → FhirUnsignedInt?

heartbeatPeriod If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.

no setter, inherited

heartbeatPeriodElement → Element?

heartbeatPeriodElement ("_heartbeatPeriod") Extensions for heartbeatPeriod

no setter, inherited

identifier → List<Identifier>?

identifier A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement ("_language") Extensions for language

no setter, inherited

managingEntity → Reference?

managingEntity Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.

no setter, inherited

maxCount → FhirPositiveInt?

maxCount If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.

no setter, inherited

maxCountElement → Element?

maxCountElement ("_maxCount") Extensions for maxCount

no setter, inherited

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 setter, inherited

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

no setter, inherited

name → String?

name A natural language name identifying the subscription.

no setter, inherited

nameElement → Element?

nameElement ("_name") Extensions for name

no setter, inherited

parameter → List<SubscriptionParameter>?

parameter Channel-dependent information to send as part of the notification (e.g., HTTP Headers).

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

reason → String?

reason A description of why this subscription is defined.

no setter, inherited

reasonElement → Element?

reasonElement ("_reason") Extensions for reason

no setter, inherited

resourceType → R5ResourceType

resourceType This is a Subscription resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

status The status of the subscription, which marks the server state for managing the subscription.

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

timeout → FhirUnsignedInt?

timeout If present, the maximum amount of time a server will allow before failing a notification attempt.

no setter, inherited

timeoutElement → Element?

timeoutElement ("_timeout") Extensions for timeout

no setter, inherited

topic → FhirCanonical

topic The reference to the subscription topic to be notified about.

no setter, inherited

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

override

updateContactPointPeriod(Period period, [int index = 0]) → Subscription

updateContactPointRank(FhirPositiveInt rank, [int index = 0]) → Subscription

updateContactPointSystem(ContactPointSystem system, [int index = 0]) → Subscription

updateContactPointUse(ContactPointUse use, [int index = 0]) → Subscription

updateContactPointValue(String value, [int index = 0]) → Subscription

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