Subscription constructor
- @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.
resourceType
This is a Subscription 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
Extensions for implicitRules
language
The base language in which the resource is written.
languageElement
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, and 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).
status
The status of the subscription, which marks the server state for
managing the subscription.
statusElement
Extensions for status
contact
Contact details for a human to contact about the subscription.
The primary use of this for system administrator troubleshooting.
end
The time for the server to turn the subscription off.
endElement
Extensions for end
reason
A description of why this subscription is defined.
reasonElement
Extensions for reason
criteria
The rules that the server should use to determine when to
generate notifications for this subscription.
criteriaElement
Extensions for criteria
error
A record of the last error that occurred when the server
processed a notification.
errorElement
Extensions for error
channel
Details where to send notifications when resources are received
that meet the criteria.
Implementation
const factory Subscription({
@Default(R4ResourceType.Subscription)
@JsonKey(unknownEnumValue: R4ResourceType.Subscription)
/// [resourceType] This is a Subscription resource
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] Extensions for implicitRules
@JsonKey(name: '_implicitRules') Element? implicitRulesElement,
/// [language] The base language in which the resource is written.
FhirCode? language,
/// [languageElement] 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, and 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,
/// [status] The status of the subscription, which marks the server state for
/// managing the subscription.
FhirCode? status,
/// [statusElement] Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [contact] Contact details for a human to contact about the subscription.
/// The primary use of this for system administrator troubleshooting.
List<ContactPoint>? contact,
/// [end] The time for the server to turn the subscription off.
FhirInstant? end,
/// [endElement] Extensions for end
@JsonKey(name: '_end') Element? endElement,
/// [reason] A description of why this subscription is defined.
String? reason,
/// [reasonElement] Extensions for reason
@JsonKey(name: '_reason') Element? reasonElement,
/// [criteria] The rules that the server should use to determine when to
/// generate notifications for this subscription.
String? criteria,
/// [criteriaElement] Extensions for criteria
@JsonKey(name: '_criteria') Element? criteriaElement,
/// [error] A record of the last error that occurred when the server
/// processed a notification.
String? error,
/// [errorElement] Extensions for error
@JsonKey(name: '_error') Element? errorElement,
/// [channel] Details where to send notifications when resources are received
/// that meet the criteria.
required SubscriptionChannel channel,
}) = _Subscription;