Struct SubscriptionTopicBuilder

pub struct SubscriptionTopicBuilder { /* private fields */ }

Builder for SubscriptionTopicInner.

Implementations

impl SubscriptionTopicBuilder

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

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

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

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

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

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

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

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>, ) -> SubscriptionTopicBuilder

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 url(self, value: String) -> SubscriptionTopicBuilder

Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)

An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.

Can be a urn:uuid: or a urn:oid: but real http/s: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases.

When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the derivedFromCanonical should be filled out with the unique uri as defined in the IG.

When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG.

pub fn url_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn identifier( self, value: Vec<Option<Identifier>>, ) -> SubscriptionTopicBuilder

Business identifier for subscription topic

Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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

Extension field.

pub fn version(self, value: String) -> SubscriptionTopicBuilder

Business version of the subscription topic

The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

There may be multiple different instances of a subscription topic that have the same identifier but different versions.

pub fn version_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn version_algorithm( self, value: SubscriptionTopicVersionAlgorithm, ) -> SubscriptionTopicBuilder

How to compare versions

Indicates the mechanism used to compare versions to determine which is more current.

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can’t be successfully be determined.

pub fn version_algorithm_ext( self, value: SubscriptionTopicVersionAlgorithmExtension, ) -> SubscriptionTopicBuilder

Extension field.

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

Name for this subscription topic (computer friendly)

A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation.

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

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

Extension field.

pub fn title(self, value: String) -> SubscriptionTopicBuilder

Name for this subscription topic (human friendly)

A short, descriptive, user-friendly title for the subscription topic. For example, “admission”.

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

pub fn title_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn derived_from( self, value: Vec<Option<String>>, ) -> SubscriptionTopicBuilder

Based on FHIR protocol or definition

The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

pub fn derived_from_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn status(self, value: PublicationStatus) -> SubscriptionTopicBuilder

PublicationStatus; draft | active | retired | unknown

The current state of the SubscriptionTopic.

A nominal state-transition diagram can be found in the Definition pattern documentation

Unknown does not represent “other” - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

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

Extension field.

pub fn experimental(self, value: bool) -> SubscriptionTopicBuilder

If for testing purposes, not real usage

A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Allows filtering of SubscriptionTopic that are appropriate for use vs. not.

pub fn experimental_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn date(self, value: DateTime) -> SubscriptionTopicBuilder

Date status first applied

The date (and optionally time) when the subscription topic was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the subscription topic changes.

See guidance around (not) making local changes to elements here.

pub fn date_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn publisher(self, value: String) -> SubscriptionTopicBuilder

The name of the individual or organization that published the SubscriptionTopic

Helps establish the “authority/credibility” of the SubscriptionTopic. May also allow for contact.

pub fn publisher_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn contact( self, value: Vec<Option<ContactDetail>>, ) -> SubscriptionTopicBuilder

Contact details for the publisher

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

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

Extension field.

pub fn description(self, value: String) -> SubscriptionTopicBuilder

Natural language description of the SubscriptionTopic

A free text natural language description of the Topic from the consumer’s perspective.

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

pub fn description_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn use_context( self, value: Vec<Option<UsageContext>>, ) -> SubscriptionTopicBuilder

Content intends to support these contexts

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

pub fn use_context_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn jurisdiction( self, value: Vec<Option<CodeableConcept>>, ) -> SubscriptionTopicBuilder

Jurisdiction; Intended jurisdiction of the SubscriptionTopic (if applicable)

A jurisdiction in which the Topic is intended to be used.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new ‘jurisdiction’ code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

pub fn jurisdiction_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn purpose(self, value: String) -> SubscriptionTopicBuilder

Why this SubscriptionTopic is defined

Explains why this Topic is needed and why it has been designed as it has.

This element does not describe the usage of the Topic. Rather it is for traceability of ’‘why’’ the resource is either needed or ’‘why’’ it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Topic.

pub fn purpose_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn copyright(self, value: String) -> SubscriptionTopicBuilder

Use and/or publishing restrictions

A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.

…

pub fn copyright_ext(self, value: FieldExtension) -> SubscriptionTopicBuilder

Extension field.

pub fn copyright_label(self, value: String) -> SubscriptionTopicBuilder

Copyright holder and year(s)

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general ‘copyright’ element.

pub fn copyright_label_ext( self, value: FieldExtension, ) -> SubscriptionTopicBuilder

Extension field.

pub fn approval_date(self, value: Date) -> SubscriptionTopicBuilder

When SubscriptionTopic is/was approved by publisher

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

The date may be more recent than the approval date because of minor changes / editorial corrections.

pub fn approval_date_ext( self, value: FieldExtension, ) -> SubscriptionTopicBuilder

Extension field.

pub fn last_review_date(self, value: Date) -> SubscriptionTopicBuilder

Date the Subscription Topic was last reviewed by the publisher

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn’t change the original approval date.

If specified, this is usually after the approval date.

pub fn last_review_date_ext( self, value: FieldExtension, ) -> SubscriptionTopicBuilder

Extension field.

pub fn effective_period(self, value: Period) -> SubscriptionTopicBuilder

The effective date range for the SubscriptionTopic

The period during which the SubscriptionTopic content was or is planned to be effective.

The effective period for a SubscriptionTopic determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

pub fn effective_period_ext( self, value: FieldExtension, ) -> SubscriptionTopicBuilder

Extension field.

pub fn resource_trigger( self, value: Vec<Option<SubscriptionTopicResourceTrigger>>, ) -> SubscriptionTopicBuilder

Definition of a resource-based trigger for the subscription topic

A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

pub fn resource_trigger_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn event_trigger( self, value: Vec<Option<SubscriptionTopicEventTrigger>>, ) -> SubscriptionTopicBuilder

Event definitions the SubscriptionTopic

Event definition which can be used to trigger the SubscriptionTopic.

pub fn event_trigger_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn can_filter_by( self, value: Vec<Option<SubscriptionTopicCanFilterBy>>, ) -> SubscriptionTopicBuilder

Properties by which a Subscription can filter notifications from the SubscriptionTopic

List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

pub fn can_filter_by_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

pub fn notification_shape( self, value: Vec<Option<SubscriptionTopicNotificationShape>>, ) -> SubscriptionTopicBuilder

Properties for describing the shape of notifications generated by this topic

List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

pub fn notification_shape_ext( self, value: Vec<Option<FieldExtension>>, ) -> SubscriptionTopicBuilder

Extension field.

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

Builds a new SubscriptionTopicInner.

Errors

If a required field has not been initialized.

impl SubscriptionTopicBuilder

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

Finalize building SubscriptionTopic.

Trait Implementations

impl Default for SubscriptionTopicBuilder

fn default() -> SubscriptionTopicBuilder

Returns the “default value” for a type.