Subscription class
Subscription The subscription resource is used to define a push-based
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Subscription({@Default(R4ResourceType.Subscription) @JsonKey(unknownEnumValue: R4ResourceType.Subscription) 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, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, List<ContactPoint> ? contact, FhirInstant? end, @JsonKey(name: '_end') Element? endElement, String? reason, @JsonKey(name: '_reason') Element? reasonElement, String? criteria, @JsonKey(name: '_criteria') Element? criteriaElement, String? error, @JsonKey(name: '_error') Element? errorElement, required SubscriptionChannel channel}) -
Subscription The subscription resource is used to define a push-based
subscription from a server to another system. Once a subscription is
registered with the server, the server checks every resource that is
created or updated, and if the resource matches the given criteria, it
sends a message on the defined "channel" so that another system can take
an appropriate action.
constfactory
-
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
- channel → SubscriptionChannel
-
channel Details where to send notifications when resources are received
that meet the criteria.
no setterinherited
-
contact
→ List<
ContactPoint> ? -
contact Contact details for a human to contact about the subscription.
The primary use of this for system administrator troubleshooting.
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, and nor can they have their own independent transaction
scope.
no setterinherited
-
copyWith
→ $SubscriptionCopyWith<
Subscription> -
no setterinherited
- criteria → String?
-
criteria The rules that the server should use to determine when to
generate notifications for this subscription.
no setterinherited
- criteriaElement → Element?
-
criteriaElement Extensions for criteria
no setterinherited
- dbId → int?
-
no setterinherited
- end → FhirInstant?
-
end The time for the server to turn the subscription off.
no setterinherited
- endElement → Element?
-
endElement Extensions for end
no setterinherited
- error → String?
-
error A record of the last error that occurred when the server
processed a notification.
no setterinherited
- errorElement → Element?
-
errorElement Extensions for error
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
- 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 Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
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
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- reason → String?
-
reason A description of why this subscription is defined.
no setterinherited
- reasonElement → Element?
-
reasonElement Extensions for reason
no setterinherited
- resourceType → R4ResourceType
-
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 status of the subscription, which marks the server state for
managing the subscription.
no setterinherited
- statusElement → Element?
-
statusElement 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
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
-
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