Struct SubscriptionStatusBuilder

pub struct SubscriptionStatusBuilder { /* private fields */ }

Builder for SubscriptionStatusInner.

Implementations

impl SubscriptionStatusBuilder

pub fn id(self, value: String) -> SubscriptionStatusBuilder

Logical id of this artifact

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

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

pub fn meta(self, value: Meta) -> SubscriptionStatusBuilder

Metadata about the resource

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.

pub fn implicit_rules(self, value: String) -> SubscriptionStatusBuilder

A set of rules under which this content was created

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

pub fn language(self, value: String) -> SubscriptionStatusBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

pub fn text(self, value: Narrative) -> SubscriptionStatusBuilder

Text summary of the resource, for human interpretation

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 resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

pub fn contained(self, value: Vec<Resource>) -> SubscriptionStatusBuilder

Contained, inline Resources

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.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

pub fn extension(self, value: Vec<Extension>) -> SubscriptionStatusBuilder

Additional content defined by implementations

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn modifier_extension( self, value: Vec<Extension>, ) -> SubscriptionStatusBuilder

Extensions that cannot be ignored

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

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn status(self, value: SubscriptionStatus) -> SubscriptionStatusBuilder

SubscriptionStatus; requested | active | error | off | entered-in-error

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

pub fn status_ext(self, value: FieldExtension) -> SubscriptionStatusBuilder

Extension field.

pub fn type( self, value: SubscriptionNotificationType, ) -> SubscriptionStatusBuilder

SubscriptionNotificationType; handshake | heartbeat | event-notification | query-status | query-event

The type of event being conveyed with this notification.

pub fn type_ext(self, value: FieldExtension) -> SubscriptionStatusBuilder

Extension field.

pub fn events_since_subscription_start( self, value: Integer64, ) -> SubscriptionStatusBuilder

Events since the Subscription was created

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.

pub fn events_since_subscription_start_ext( self, value: FieldExtension, ) -> SubscriptionStatusBuilder

Extension field.

pub fn notification_event( self, value: Vec<Option<SubscriptionStatusNotificationEvent>>, ) -> SubscriptionStatusBuilder

Detailed information about any events relevant to this notification

Detailed information about events relevant to this subscription notification.

pub fn notification_event_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionStatusBuilder

Extension field.

pub fn subscription(self, value: Reference) -> SubscriptionStatusBuilder

Reference to the Subscription responsible for this notification

The reference to the Subscription which generated this notification.

pub fn subscription_ext( self, value: FieldExtension, ) -> SubscriptionStatusBuilder

Extension field.

pub fn topic(self, value: String) -> SubscriptionStatusBuilder

Reference to the SubscriptionTopic this notification relates to

The reference to the SubscriptionTopic for the Subscription which generated this notification.

This value SHOULD NOT be present when using empty payloads, MAY be present when using id-only payloads, and SHOULD be present when using full-resource payloads.

pub fn topic_ext(self, value: FieldExtension) -> SubscriptionStatusBuilder

Extension field.

pub fn error( self, value: Vec<Option<CodeableConcept>>, ) -> SubscriptionStatusBuilder

SubscriptionError; List of errors on the subscription

A record of errors that occurred when the server processed a notification.

Recommended practice: clear errors when status is updated.

pub fn error_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionStatusBuilder

Extension field.

pub fn build_inner(self) -> Result<SubscriptionStatusInner, BuilderError>

Builds a new SubscriptionStatusInner.

Errors

If a required field has not been initialized.

impl SubscriptionStatusBuilder

pub fn build(self) -> Result<SubscriptionStatus, BuilderError>

Finalize building SubscriptionStatus.

Trait Implementations

impl Default for SubscriptionStatusBuilder

fn default() -> SubscriptionStatusBuilder

Returns the “default value” for a type.