Struct ImmunizationBuilder

pub struct ImmunizationBuilder { /* private fields */ }

Builder for ImmunizationInner.

Implementations

impl ImmunizationBuilder

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

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

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

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

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

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

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

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

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

Business identifier

A unique identifier assigned to this immunization record.

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

Extension field.

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

Authority that the immunization event is based on

A plan, order or recommendation fulfilled in whole or in part by this immunization.

Allows tracing of an authorization for the Immunization.

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

Extension field.

pub fn status(self, value: String) -> ImmunizationBuilder

ImmunizationStatus; completed | entered-in-error | not-done

Indicates the current status of the immunization event.

Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

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

Extension field.

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

ImmunizationStatusReason; Reason for current status

Indicates the reason the immunization event was not performed.

This is generally only used for the status of “not-done”. The reason for performing the immunization event is captured in reasonCode, not here.

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

Extension field.

pub fn vaccine_code(self, value: CodeableConcept) -> ImmunizationBuilder

VaccineCode; Vaccine administered

Vaccine that was administered or was to be administered.

The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.

pub fn vaccine_code_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn administered_product( self, value: CodeableReference, ) -> ImmunizationBuilder

Product that was administered

An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.

pub fn administered_product_ext( self, value: FieldExtension, ) -> ImmunizationBuilder

Extension field.

pub fn manufacturer(self, value: CodeableReference) -> ImmunizationBuilder

Vaccine manufacturer

Name of vaccine manufacturer.

pub fn manufacturer_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn lot_number(self, value: String) -> ImmunizationBuilder

Vaccine lot number

Lot number of the vaccine product.

pub fn lot_number_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn expiration_date(self, value: Date) -> ImmunizationBuilder

Vaccine expiration date

Date vaccine batch expires.

pub fn expiration_date_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn patient(self, value: Reference) -> ImmunizationBuilder

Who was immunized

The patient who either received or did not receive the immunization.

pub fn patient_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

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

Encounter immunization was part of

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

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

Extension field.

pub fn supporting_information( self, value: Vec<Option<Reference>>, ) -> ImmunizationBuilder

Additional information in support of the immunization

Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.

pub fn supporting_information_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImmunizationBuilder

Extension field.

pub fn occurrence(self, value: ImmunizationOccurrence) -> ImmunizationBuilder

Vaccine administration date

Date vaccine administered or was to be administered.

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

pub fn occurrence_ext( self, value: ImmunizationOccurrenceExtension, ) -> ImmunizationBuilder

Extension field.

pub fn primary_source(self, value: bool) -> ImmunizationBuilder

Indicates context the data was captured in

Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as ‘secondary reported’ data documented by a third party. A value of ‘true’ means this data originated with the individual/organization which was responsible for the administration of the vaccine.

Reflects the “reliability” of the content.

pub fn primary_source_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn information_source(self, value: CodeableReference) -> ImmunizationBuilder

ImmunizationReportOrigin; Indicates the source of a reported record

Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Typically will not be populated if primarySource = True, not required even if primarySource = False.

pub fn information_source_ext( self, value: FieldExtension, ) -> ImmunizationBuilder

Extension field.

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

Where immunization occurred

The service delivery location where the vaccine administration occurred.

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

Extension field.

pub fn site(self, value: CodeableConcept) -> ImmunizationBuilder

ImmunizationSite; Body site vaccine was administered

Body site where vaccine was administered.

pub fn site_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn route(self, value: CodeableConcept) -> ImmunizationBuilder

ImmunizationRoute; How vaccine entered body

The path by which the vaccine product is taken into the body.

pub fn route_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn dose_quantity(self, value: Quantity) -> ImmunizationBuilder

Amount of vaccine administered

The quantity of vaccine product that was administered.

pub fn dose_quantity_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn performer( self, value: Vec<Option<ImmunizationPerformer>>, ) -> ImmunizationBuilder

Who performed event

Indicates who performed the immunization event.

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

Extension field.

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

Additional immunization notes

Extra information about the immunization that is not conveyed by the other attributes.

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

Extension field.

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

ImmunizationReason; Why immunization occurred

Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.

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

Extension field.

pub fn is_subpotent(self, value: bool) -> ImmunizationBuilder

Dose potency

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

pub fn is_subpotent_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn subpotent_reason( self, value: Vec<Option<CodeableConcept>>, ) -> ImmunizationBuilder

SubpotentReason; Reason for being subpotent

Reason why a dose is considered to be subpotent.

pub fn subpotent_reason_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImmunizationBuilder

Extension field.

pub fn program_eligibility( self, value: Vec<Option<ImmunizationProgramEligibility>>, ) -> ImmunizationBuilder

Patient eligibility for a specific vaccination program

Indicates a patient’s eligibility for a funding program.

pub fn program_eligibility_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImmunizationBuilder

Extension field.

pub fn funding_source(self, value: CodeableConcept) -> ImmunizationBuilder

FundingSource; Funding source for the vaccine

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

pub fn funding_source_ext(self, value: FieldExtension) -> ImmunizationBuilder

Extension field.

pub fn reaction( self, value: Vec<Option<ImmunizationReaction>>, ) -> ImmunizationBuilder

Details of a reaction that follows immunization

Categorical data indicating that an adverse event is associated in time to an immunization.

A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

pub fn reaction_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImmunizationBuilder

Extension field.

pub fn protocol_applied( self, value: Vec<Option<ImmunizationProtocolApplied>>, ) -> ImmunizationBuilder

Protocol followed by the provider

The protocol (set of recommendations) being followed by the provider who administered the dose.

pub fn protocol_applied_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImmunizationBuilder

Extension field.

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

Builds a new ImmunizationInner.

Errors

If a required field has not been initialized.

impl ImmunizationBuilder

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

Finalize building Immunization.

Trait Implementations

impl Default for ImmunizationBuilder

fn default() -> ImmunizationBuilder

Returns the “default value” for a type.