Struct ServiceRequestBuilder

pub struct ServiceRequestBuilder { /* private fields */ }

Builder for ServiceRequestInner.

Implementations

impl ServiceRequestBuilder

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

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

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

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

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

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

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

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

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

Identifiers assigned to this order

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the ‘Placer’ in HL7 V2) and the producer of the observations in response to the order (known as the ‘Filler’ in HL7 V2). For further discussion and examples see the resource notes section below.

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

Extension field.

pub fn instantiates_canonical( self, value: Vec<Option<String>>, ) -> ServiceRequestBuilder

Instantiates FHIR protocol or definition

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

The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the Boundaries and Relationships section for PlanDefinition.

pub fn instantiates_canonical_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

pub fn instantiates_uri( self, value: Vec<Option<String>>, ) -> ServiceRequestBuilder

Instantiates external protocol or definition

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

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

pub fn instantiates_uri_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

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

What request fulfills

Plan/proposal/order fulfilled by this request.

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

Extension field.

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

What request replaces

The request takes the place of the referenced completed or terminated request(s).

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

Extension field.

pub fn requisition(self, value: Identifier) -> ServiceRequestBuilder

Composite Request ID

A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

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 requisition_ext(self, value: FieldExtension) -> ServiceRequestBuilder

Extension field.

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

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

The status of the order.

The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.

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

Extension field.

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

ServiceRequestIntent; proposal | plan | directive | order +

Whether the request is a proposal, plan, an original order or a reflex order.

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

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

Extension field.

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

ServiceRequestCategory; Classification of service

A code that classifies the service for searching, sorting and display purposes (e.g. “Surgical Procedure”).

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

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

Extension field.

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

ServiceRequestPriority; routine | urgent | asap | stat

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

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

Extension field.

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

True if service/procedure should not be performed

Set this to true if the record is saying that the service/procedure should NOT be performed.

In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.

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

Extension field.

pub fn code(self, value: CodeableReference) -> ServiceRequestBuilder

ServiceRequestCode; What is being requested/ordered

A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.

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

Extension field.

pub fn order_detail( self, value: Vec<Option<ServiceRequestOrderDetail>>, ) -> ServiceRequestBuilder

Additional order information

Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

For information from the medical record intended to support the delivery of the requested services, use the supportingInformation element.

pub fn order_detail_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

pub fn quantity(self, value: ServiceRequestQuantity) -> ServiceRequestBuilder

Service amount

An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

pub fn quantity_ext( self, value: ServiceRequestQuantityExtension, ) -> ServiceRequestBuilder

Extension field.

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

Individual or Entity the service is ordered for

On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

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

Extension field.

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

What the service request is about, when it is not about the subject of record

The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject’s diet, another service request on the subject, or a body structure such as tumor or implanted device.

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

Extension field.

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

Encounter in which the request was created

An encounter that provides additional information about the healthcare context in which this request is made.

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

Extension field.

pub fn occurrence( self, value: ServiceRequestOccurrence, ) -> ServiceRequestBuilder

When service should occur

The date/time at which the requested service should occur.

pub fn occurrence_ext( self, value: ServiceRequestOccurrenceExtension, ) -> ServiceRequestBuilder

Extension field.

pub fn as_needed(self, value: ServiceRequestAsNeeded) -> ServiceRequestBuilder

Preconditions for service

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example “pain”, “on flare-up”, etc.

pub fn as_needed_ext( self, value: ServiceRequestAsNeededExtension, ) -> ServiceRequestBuilder

Extension field.

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

Date request signed

When the request transitioned to being actionable.

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

Extension field.

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

Who/what is requesting service

The individual who initiated the request and has responsibility for its activation.

This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.

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

Extension field.

pub fn performer_type(self, value: CodeableConcept) -> ServiceRequestBuilder

ServiceRequestParticipantRole; Performer role

Desired type of performer for doing the requested service.

This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.

pub fn performer_type_ext(self, value: FieldExtension) -> ServiceRequestBuilder

Extension field.

pub fn performer(self, value: Vec<Option<Reference>>) -> ServiceRequestBuilder

Requested performer

The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the http://hl7.org/fhir/StructureDefinition/request-performerOrder. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B).

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

Extension field.

pub fn location( self, value: Vec<Option<CodeableReference>>, ) -> ServiceRequestBuilder

ServiceRequestLocation; Requested location

The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.

pub fn location_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

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

ServiceRequestReason; Explanation/Justification for procedure or service

An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use concept.text element if the data is free (uncoded) text as shown in the CT Scan example.

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

Extension field.

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

Associated insurance coverage

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

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

Extension field.

pub fn supporting_info( self, value: Vec<Option<CodeableReference>>, ) -> ServiceRequestBuilder

Additional clinical information

Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as “ask at order entry questions (AOEs)”. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

To represent information about how the services are to be delivered use the instructions element.

pub fn supporting_info_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

pub fn specimen(self, value: Vec<Option<Reference>>) -> ServiceRequestBuilder

Procedure Samples

One or more specimens that the laboratory procedure will use.

The purpose of the ServiceRequest.specimen is to reflect the actual specimen that the requested test/procedure is asked to be performed on, whether the lab already has it or not. References to specimens for purposes other than to perform a test/procedure on should be made using the ServiceRequest.supportingInfo or the Specimen.parent where the Specimen.parent would enable descendency and ServiceRequest.supportingInfo a general reference for context.

pub fn specimen_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

pub fn body_site( self, value: Vec<Option<CodeableConcept>>, ) -> ServiceRequestBuilder

BodySite; Coded location on Body

Anatomic location where the procedure should be performed. This is the target site.

Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure.

pub fn body_site_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

pub fn body_structure(self, value: Reference) -> ServiceRequestBuilder

BodyStructure-based location on the body

Anatomic location where the procedure should be performed. This is the target site.

pub fn body_structure_ext(self, value: FieldExtension) -> ServiceRequestBuilder

Extension field.

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

Comments

Any other notes and comments made about the service request. For example, internal billing notes.

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

Extension field.

pub fn patient_instruction( self, value: Vec<Option<ServiceRequestPatientInstruction>>, ) -> ServiceRequestBuilder

Patient or consumer-oriented instructions

Instructions in terms that are understood by the patient or consumer.

pub fn patient_instruction_ext( self, value: Vec<Option<FieldExtension>>, ) -> ServiceRequestBuilder

Extension field.

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

Request provenance

Key events in the history of the request.

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.

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

Extension field.

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

Builds a new ServiceRequestInner.

Errors

If a required field has not been initialized.

impl ServiceRequestBuilder

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

Finalize building ServiceRequest.

Trait Implementations

impl Default for ServiceRequestBuilder

fn default() -> ServiceRequestBuilder

Returns the “default value” for a type.