Struct CommunicationRequestBuilder

pub struct CommunicationRequestBuilder { /* private fields */ }

Builder for CommunicationRequestInner.

Implementations

impl CommunicationRequestBuilder

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

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

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

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

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

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

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

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

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

Unique identifier

Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

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

Extension field.

pub fn based_on( self, value: Vec<Option<Reference>>, ) -> CommunicationRequestBuilder

Fulfills plan or proposal

A plan or proposal that is fulfilled in whole or in part by this request.

pub fn based_on_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn replaces( self, value: Vec<Option<Reference>>, ) -> CommunicationRequestBuilder

Request(s) replaced by this request

Completed or terminated request(s) whose function is taken by this new request.

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

pub fn replaces_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn group_identifier(self, value: Identifier) -> CommunicationRequestBuilder

Composite request this is part of

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Requests are linked either by a “basedOn” relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

pub fn group_identifier_ext( self, value: FieldExtension, ) -> CommunicationRequestBuilder

Extension field.

pub fn status(self, value: RequestStatus) -> CommunicationRequestBuilder

CommunicationRequestStatus; draft | active | on-hold | revoked | completed | entered-in-error | unknown

The status of the proposal or order.

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

Extension field.

pub fn status_reason( self, value: CodeableConcept, ) -> CommunicationRequestBuilder

CommunicationRequestStatusReason; Reason for current status

Captures the reason for the current state of the CommunicationRequest.

This is generally only used for “exception” statuses such as “on-hold” or “revoked”. The reason why the CommunicationRequest was created at all is captured in reasonCode, not here.

pub fn status_reason_ext( self, value: FieldExtension, ) -> CommunicationRequestBuilder

Extension field.

pub fn intent(self, value: RequestIntent) -> CommunicationRequestBuilder

CommunicationRequestIntent; proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

This element is expected to be immutable. E.g. A “proposal” instance should never change to be a “plan” instance or “order” instance. Instead, a new instance ‘basedOn’ the prior instance should be created with the new ‘intent’ value.

One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an “order” might later be clarified to be a “filler-order”. Or, in rarer cases (to meet recipient constraints), the reverse might also occur.

pub fn intent_ext(self, value: FieldExtension) -> CommunicationRequestBuilder

Extension field.

pub fn category( self, value: Vec<Option<CodeableConcept>>, ) -> CommunicationRequestBuilder

CommunicationCategory; Message category

The type of message to be sent such as alert, notification, reminder, instruction, etc.

There may be multiple axes of categorization and one communication request may serve multiple purposes.

pub fn category_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn priority(self, value: RequestPriority) -> CommunicationRequestBuilder

CommunicationPriority; routine | urgent | asap | stat

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

pub fn priority_ext(self, value: FieldExtension) -> CommunicationRequestBuilder

Extension field.

pub fn do_not_perform(self, value: bool) -> CommunicationRequestBuilder

True if request is prohibiting action

If true indicates that the CommunicationRequest is asking for the specified action to not occur.

The attributes provided with the request qualify what is not to be done.

pub fn do_not_perform_ext( self, value: FieldExtension, ) -> CommunicationRequestBuilder

Extension field.

pub fn medium( self, value: Vec<Option<CodeableConcept>>, ) -> CommunicationRequestBuilder

CommunicationMedium; A channel of communication

A channel that was used for this communication (e.g. email, fax).

pub fn medium_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn subject(self, value: Reference) -> CommunicationRequestBuilder

Focus of message

The patient or group that is the focus of this communication request.

pub fn subject_ext(self, value: FieldExtension) -> CommunicationRequestBuilder

Extension field.

pub fn about(self, value: Vec<Option<Reference>>) -> CommunicationRequestBuilder

Resources that pertain to this communication request

Other resources that pertain to this communication request and to which this communication request should be associated.

Don’t use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

pub fn about_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn encounter(self, value: Reference) -> CommunicationRequestBuilder

The Encounter during which this CommunicationRequest was created

The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

pub fn encounter_ext(self, value: FieldExtension) -> CommunicationRequestBuilder

Extension field.

pub fn payload( self, value: Vec<Option<CommunicationRequestPayload>>, ) -> CommunicationRequestBuilder

Message payload

Text, attachment(s), or resource(s) to be communicated to the recipient.

pub fn payload_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn occurrence( self, value: CommunicationRequestOccurrence, ) -> CommunicationRequestBuilder

When scheduled

The time when this communication is to occur.

pub fn occurrence_ext( self, value: CommunicationRequestOccurrenceExtension, ) -> CommunicationRequestBuilder

Extension field.

pub fn authored_on(self, value: DateTime) -> CommunicationRequestBuilder

When request transitioned to being actionable

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

pub fn authored_on_ext( self, value: FieldExtension, ) -> CommunicationRequestBuilder

Extension field.

pub fn requester(self, value: Reference) -> CommunicationRequestBuilder

Who asks for the information to be shared

The device, individual, or organization who asks for the information to be shared.

pub fn requester_ext(self, value: FieldExtension) -> CommunicationRequestBuilder

Extension field.

pub fn recipient( self, value: Vec<Option<Reference>>, ) -> CommunicationRequestBuilder

Who to share the information with

The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

pub fn recipient_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn information_provider( self, value: Vec<Option<Reference>>, ) -> CommunicationRequestBuilder

Who should share the information

The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

pub fn information_provider_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn reason( self, value: Vec<Option<CodeableReference>>, ) -> CommunicationRequestBuilder

CommunicationReason; Why is communication needed?

Describes why the request is being made in coded or textual form.

Textual reasons can be captured using reasonCode.text.

pub fn reason_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

pub fn note(self, value: Vec<Option<Annotation>>) -> CommunicationRequestBuilder

Comments made about communication request

Comments made about the request by the requester, sender, recipient, subject or other participants.

pub fn note_ext( self, value: Vec<Option<FieldExtension>>, ) -> CommunicationRequestBuilder

Extension field.

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

Builds a new CommunicationRequestInner.

Errors

If a required field has not been initialized.

impl CommunicationRequestBuilder

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

Finalize building CommunicationRequest.

Trait Implementations

impl Default for CommunicationRequestBuilder

fn default() -> CommunicationRequestBuilder

Returns the “default value” for a type.