Struct SubscriptionBuilder

pub struct SubscriptionBuilder { /* private fields */ }

Builder for SubscriptionInner.

Implementations

impl SubscriptionBuilder

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

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

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

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

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

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

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

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

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 identifier(self, value: Vec<Option<Identifier>>) -> SubscriptionBuilder

Additional identifiers (business 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.

pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionBuilder

Extension field.

pub fn name(self, value: String) -> SubscriptionBuilder

Human readable name for this subscription

A natural language name identifying the subscription.

pub fn name_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn status(self, value: String) -> SubscriptionBuilder

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

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

A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

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

Extension field.

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

Reference to the subscription topic being subscribed to

The reference to the subscription topic to be notified about.

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

Extension field.

pub fn contact(self, value: Vec<Option<ContactPoint>>) -> SubscriptionBuilder

Contact details for source (e.g. troubleshooting)

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

pub fn contact_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionBuilder

Extension field.

pub fn end(self, value: Instant) -> SubscriptionBuilder

When to automatically delete the subscription

The time for the server to turn the subscription off.

The server is permitted to deviate from this time but should observe it.

pub fn end_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn managing_entity(self, value: Reference) -> SubscriptionBuilder

Entity responsible for Subscription changes

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

pub fn managing_entity_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn reason(self, value: String) -> SubscriptionBuilder

Description of why this subscription was created

A description of why this subscription is defined.

pub fn reason_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn filter_by( self, value: Vec<Option<SubscriptionFilterBy>>, ) -> SubscriptionBuilder

Criteria for narrowing the subscription topic stream

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

pub fn filter_by_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionBuilder

Extension field.

pub fn channel_type(self, value: Coding) -> SubscriptionBuilder

SubscriptionChannelType; Channel type for notifications

The type of channel to send notifications on.

pub fn channel_type_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn endpoint(self, value: String) -> SubscriptionBuilder

Where the channel points to

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

For rest-hook the end-point must be an http: or https: URL; for websockets, ws: or wss:; for email, a mailto: url; and for message the endpoint can be in any form of url the server understands (usually, http/s: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).

pub fn endpoint_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn parameter( self, value: Vec<Option<SubscriptionParameter>>, ) -> SubscriptionBuilder

Channel type

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

Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.

pub fn parameter_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionBuilder

Extension field.

pub fn heartbeat_period(self, value: u32) -> SubscriptionBuilder

Interval in seconds to send ‘heartbeat’ notification

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.

pub fn heartbeat_period_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn timeout(self, value: u32) -> SubscriptionBuilder

Timeout in seconds to attempt notification delivery

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

pub fn timeout_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn content_type(self, value: String) -> SubscriptionBuilder

MimeType; MIME type to send, or omit for no payload

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

• clients may request notifications in a specific FHIR version by using the FHIR Version Parameter - e.g., application/fhir+json; fhirVersion=4.0.

• additional MIME types can be allowed by channels - e.g., text/plain and text/html are defined by the Email channel.

pub fn content_type_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn content(self, value: SubscriptionPayloadContent) -> SubscriptionBuilder

SubscriptionPayloadContent; empty | id-only | full-resource

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.

Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

pub fn content_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

pub fn max_count(self, value: NonZero<u32>) -> SubscriptionBuilder

Maximum number of events that can be combined in a single notification

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.

pub fn max_count_ext(self, value: FieldExtension) -> SubscriptionBuilder

Extension field.

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

Builds a new SubscriptionInner.

Errors

If a required field has not been initialized.

impl SubscriptionBuilder

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

Finalize building Subscription.

Trait Implementations

impl Default for SubscriptionBuilder

fn default() -> SubscriptionBuilder

Returns the “default value” for a type.