Struct TaskBuilder

pub struct TaskBuilder { /* private fields */ }

Builder for TaskInner.

Implementations

impl TaskBuilder

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

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

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

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

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

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

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

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

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

Task Instance Identifier

The business identifier for this task.

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

Extension field.

pub fn instantiates_canonical(self, value: String) -> TaskBuilder

Formal definition of task

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

pub fn instantiates_canonical_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn instantiates_uri(self, value: String) -> TaskBuilder

Formal definition of task

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

pub fn instantiates_uri_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

Request fulfilled by this task

BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a “request” resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the “request” resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.

Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for ‘please fulfill’ Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using focus, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).

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

Extension field.

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

Requisition or grouper id

A shared identifier common to multiple independent Task and 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.

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

Extension field.

pub fn part_of(self, value: Vec<Option<Reference>>) -> TaskBuilder

Composite task

Task that this particular task is part of.

This should usually be 0..1.

pub fn part_of_ext(self, value: Vec<Option<FieldExtension>>) -> TaskBuilder

Extension field.

pub fn status(self, value: TaskStatus) -> TaskBuilder

TaskStatus; draft | requested | received | accepted | +

The current status of the task.

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

Extension field.

pub fn status_reason(self, value: CodeableReference) -> TaskBuilder

TaskStatusReason; Reason for current status

An explanation as to why this task is held, failed, was refused, etc.

This applies to the current status. Look at the history of the task to see reasons for past statuses.

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

Extension field.

pub fn business_status(self, value: CodeableConcept) -> TaskBuilder

TaskBusinessStatus; E.g. “Specimen collected”, “IV prepped”

Contains business-specific nuances of the business state.

pub fn business_status_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn intent(self, value: TaskIntent) -> TaskBuilder

TaskIntent; unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

Indicates the “level” of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

In most cases, Tasks will have an intent of “order”.

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

Extension field.

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

TaskPriority; routine | urgent | asap | stat

Indicates how quickly the Task should be addressed with respect to other requests.

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

Extension field.

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

True if Task is prohibiting action

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

The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the ‘do not’ request only applies within the specified time. If a requestedPerformer is specified then the ‘do not’ request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer.

In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. ‘NPO’ (nothing by mouth), ‘DNR’ (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. ‘Do not DNR’).

doNotPerform should ONLY be used with Tasks that are tightly bounded in time or process phase. E.g. ’Do not fulfill the midnight dose of medication X tonight due to the early morning scheduled procedure, where the nurse could reasonably check off ‘Med X not given at midnight as instructed’. Similarly, a decision support proposal that a patient should not be given a standard intake questionnaire (because the patient is cognitively impaired) would be marked as ‘complete’ or ‘rejected’ when the clinician preps the CarePlan or order set after reviewing the decision support results. If there is a need to create a standing order to not do something that can’t be satisfied by a single ‘non-action’, but rather an ongoing refusal to perform the function, MedicationRequest, ServiceRequest or some other form of authorization should be used.

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

Extension field.

pub fn code(self, value: CodeableConcept) -> TaskBuilder

TaskCode; Task Type

A name or code (or both) briefly describing what the task involves.

The title (eg “My Tasks”, “Outstanding Tasks for Patient X”) should go into the code.

pub fn code_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

Human-readable explanation of task

A free-text description of what is to be performed.

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

Extension field.

pub fn focus(self, value: Reference) -> TaskBuilder

What task is acting on

The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

pub fn focus_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn for(self, value: Reference) -> TaskBuilder

Beneficiary of the Task

The entity who benefits from the performance of the service specified in the task (e.g., the patient).

pub fn for_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

Healthcare event during which this task originated

The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

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

Extension field.

pub fn requested_period(self, value: Period) -> TaskBuilder

When the task should be performed

Indicates the start and/or end of the period of time when completion of the task is desired to take place.

This is typically used when the Task is not seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.

pub fn requested_period_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn execution_period(self, value: Period) -> TaskBuilder

Start and end time of execution

Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

pub fn execution_period_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

Task Creation Date

The date and time this task was created.

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

Extension field.

pub fn last_modified(self, value: DateTime) -> TaskBuilder

Task Last Modified Date

The date and time of last modification to this task.

pub fn last_modified_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

Who is asking for task to be done

The creator of the task.

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

Extension field.

pub fn requested_performer( self, value: Vec<Option<CodeableReference>>, ) -> TaskBuilder

TaskPerformerType; Who should perform Task

The kind of participant or specific participant that should perform the task.

pub fn requested_performer_ext( self, value: Vec<Option<FieldExtension>>, ) -> TaskBuilder

Extension field.

pub fn owner(self, value: Reference) -> TaskBuilder

Responsible individual

Party responsible for managing task execution.

Tasks may be created with an owner not yet identified.

pub fn owner_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn performer(self, value: Vec<Option<TaskPerformer>>) -> TaskBuilder

Who or what performed the task

The entity who performed the requested task.

pub fn performer_ext(self, value: Vec<Option<FieldExtension>>) -> TaskBuilder

Extension field.

pub fn location(self, value: Reference) -> TaskBuilder

Where task occurs

Principal physical location where this task is performed.

This should only be specified when the Task to be/being performed happens or is expected to happen primarily within the bounds of a single Location. Other locations (e.g. source, destination, etc.) would either be reflected on the ‘basedOn’ Request or be conveyed as distinct Task.input values.

pub fn location_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

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

TaskReason; Why task is needed

A description, code, or reference indicating why this task needs to be performed.

This will typically not be present for Tasks with a code of ‘please fulfill’ as, for those, the reason for action is conveyed on the Request pointed to by Task.focus. Some types of tasks will not need a ‘reason’. E.g. a request to discharge a patient can be inferred to be ‘because the patient is ready’ and this would not need a reason to be stated on the Task.

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

Extension field.

pub fn insurance(self, value: Vec<Option<Reference>>) -> TaskBuilder

Associated insurance coverage

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

pub fn insurance_ext(self, value: Vec<Option<FieldExtension>>) -> TaskBuilder

Extension field.

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

Comments made about the task

Free-text information captured about the task as it progresses.

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

Extension field.

pub fn relevant_history(self, value: Vec<Option<Reference>>) -> TaskBuilder

Key events in history of the Task

Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

pub fn relevant_history_ext( self, value: Vec<Option<FieldExtension>>, ) -> TaskBuilder

Extension field.

pub fn restriction(self, value: TaskRestriction) -> TaskBuilder

Constraints on fulfillment tasks

If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.

pub fn restriction_ext(self, value: FieldExtension) -> TaskBuilder

Extension field.

pub fn input(self, value: Vec<Option<TaskInput>>) -> TaskBuilder

Information used to perform task

Additional information that may be needed in the execution of the task.

pub fn input_ext(self, value: Vec<Option<FieldExtension>>) -> TaskBuilder

Extension field.

pub fn output(self, value: Vec<Option<TaskOutput>>) -> TaskBuilder

Information produced as part of task

Outputs produced by the Task.

pub fn output_ext(self, value: Vec<Option<FieldExtension>>) -> TaskBuilder

Extension field.

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

Builds a new TaskInner.

Errors

If a required field has not been initialized.

impl TaskBuilder

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

Finalize building Task.

Trait Implementations

impl Default for TaskBuilder

fn default() -> TaskBuilder

Returns the “default value” for a type.