SubscriptionStatus constructor
- @Default(R4ResourceType.SubscriptionStatus) 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,
- FhirCode? type,
- @JsonKey(name: '_type') Element? typeElement,
- FhirInteger64? eventsSinceSubscriptionStart,
- @JsonKey(name: '_eventsSinceSubscriptionStart') Element? eventsSinceSubscriptionStartElement,
- List<
SubscriptionStatusNotificationEvent> ? notificationEvent, - required Reference subscription,
- FhirCanonical? topic,
- List<
CodeableConcept> ? error,
SubscriptionStatus The SubscriptionStatus resource describes the state of a Subscription during notifications.
resourceType
This is a SubscriptionStatus 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).;
status
The status of the subscription, which marks the server state for managing the subscription.;
statusElement
(_status): Extensions for status;
type
The type of event being conveyed with this notificaiton.;
typeElement
(_type): Extensions for type;
eventsSinceSubscriptionStart
The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.;
eventsSinceSubscriptionStartElement
(_eventsSinceSubscriptionStart): Extensions for eventsSinceSubscriptionStart;
notificationEvent
Detailed information about events relevant to this subscription notification.;
subscription
The reference to the Subscription which generated this notification.;
topic
The reference to the SubscriptionTopic for the Subscription which generated this notification.;
error
A record of errors that occurred when the server processed a notification.;
Implementation
///
/// [resourceType] This is a SubscriptionStatus 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).;
///
/// [status] The status of the subscription, which marks the server state for managing the subscription.;
///
/// [statusElement] (_status): Extensions for status;
///
/// [type] The type of event being conveyed with this notificaiton.;
///
/// [typeElement] (_type): Extensions for type;
///
/// [eventsSinceSubscriptionStart] The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.;
///
/// [eventsSinceSubscriptionStartElement] (_eventsSinceSubscriptionStart): Extensions for eventsSinceSubscriptionStart;
///
/// [notificationEvent] Detailed information about events relevant to this subscription notification.;
///
/// [subscription] The reference to the Subscription which generated this notification.;
///
/// [topic] The reference to the SubscriptionTopic for the Subscription which generated this notification.;
///
/// [error] A record of errors that occurred when the server processed a notification.;
const factory SubscriptionStatus({
/// [resourceType] This is a SubscriptionStatus resource;
@Default(R4ResourceType.SubscriptionStatus) 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,
/// [status] The status of the subscription, which marks the server state for managing the subscription.;
FhirCode? status,
/// [statusElement] (_status): Extensions for status;
@JsonKey(name: '_status') Element? statusElement,
/// [type] The type of event being conveyed with this notificaiton.;
FhirCode? type,
/// [typeElement] (_type): Extensions for type;
@JsonKey(name: '_type') Element? typeElement,
/// [eventsSinceSubscriptionStart] The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.;
FhirInteger64? eventsSinceSubscriptionStart,
@JsonKey(name: '_eventsSinceSubscriptionStart')
/// [eventsSinceSubscriptionStartElement] (_eventsSinceSubscriptionStart): Extensions for eventsSinceSubscriptionStart;
Element? eventsSinceSubscriptionStartElement,
/// [notificationEvent] Detailed information about events relevant to this subscription notification.;
List<SubscriptionStatusNotificationEvent>? notificationEvent,
/// [subscription] The reference to the Subscription which generated this notification.;
required Reference subscription,
/// [topic] The reference to the SubscriptionTopic for the Subscription which generated this notification.;
FhirCanonical? topic,
/// [error] A record of errors that occurred when the server processed a notification.;
List<CodeableConcept>? error,
}) = _SubscriptionStatus;