Struct MessageHeaderBuilder

pub struct MessageHeaderBuilder { /* private fields */ }

Builder for MessageHeaderInner.

Implementations

impl MessageHeaderBuilder

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

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

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

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

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

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

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

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

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 event(self, value: MessageHeaderEvent) -> MessageHeaderBuilder

Event code or link to EventDefinition

Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.

pub fn event_ext( self, value: MessageHeaderEventExtension, ) -> MessageHeaderBuilder

Extension field.

pub fn destination( self, value: Vec<Option<MessageHeaderDestination>>, ) -> MessageHeaderBuilder

Message destination application(s)

The destination application which the message is intended for.

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

pub fn destination_ext( self, value: Vec<Option<FieldExtension>>, ) -> MessageHeaderBuilder

Extension field.

pub fn sender(self, value: Reference) -> MessageHeaderBuilder

Real world sender of the message

Identifies the sending system to allow the use of a trust relationship.

Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Proposing to remove and rely on Task to convey this information.

pub fn sender_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

pub fn author(self, value: Reference) -> MessageHeaderBuilder

The source of the decision

The logical author of the message - the personor device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

Usually only for the request but can be used in a response.Proposing to remove and rely on Task to convey this information.

pub fn author_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

pub fn source(self, value: MessageHeaderSource) -> MessageHeaderBuilder

Message source application

The source application from which this message originated.

pub fn source_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

pub fn responsible(self, value: Reference) -> MessageHeaderBuilder

Final responsibility for event

The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

Usually only for the request but can be used in a response.Proposing to remove and rely on Task to convey this information.

pub fn responsible_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

pub fn reason(self, value: CodeableConcept) -> MessageHeaderBuilder

EventReason; Cause of event

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

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

Extension field.

pub fn response(self, value: MessageHeaderResponse) -> MessageHeaderBuilder

If this is a reply to prior message

Information about the message that this message is a response to. Only present if this message is a response.

pub fn response_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

pub fn focus(self, value: Vec<Option<Reference>>) -> MessageHeaderBuilder

The actual content of the message

The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.

The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.

pub fn focus_ext( self, value: Vec<Option<FieldExtension>>, ) -> MessageHeaderBuilder

Extension field.

pub fn definition(self, value: String) -> MessageHeaderBuilder

Link to the definition for this message

Permanent link to the MessageDefinition for this message.

pub fn definition_ext(self, value: FieldExtension) -> MessageHeaderBuilder

Extension field.

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

Builds a new MessageHeaderInner.

Errors

If a required field has not been initialized.

impl MessageHeaderBuilder

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

Finalize building MessageHeader.

Trait Implementations

impl Default for MessageHeaderBuilder

fn default() -> MessageHeaderBuilder

Returns the “default value” for a type.