Struct AddressBuilder

pub struct AddressBuilder { /* private fields */ }

Builder for AddressInner.

Implementations

impl AddressBuilder

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

Unique id for inter-element referencing

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

pub fn extension(self, value: Vec<Extension>) -> AddressBuilder

Additional content defined by implementations

May be used to represent additional information that is not part of the basic definition of the element. 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 use(self, value: AddressUse) -> AddressBuilder

AddressUse; home | work | temp | old | billing - purpose of this address

The purpose of this address.

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

pub fn use_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn type(self, value: AddressType) -> AddressBuilder

AddressType; postal | physical | both

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

The definition of Address states that “address is intended to describe postal addresses, not physical locations”. However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

pub fn type_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn text(self, value: String) -> AddressBuilder

Text representation of the address

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn’t found in a part.

pub fn text_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn line(self, value: Vec<Option<String>>) -> AddressBuilder

Street name, number, direction & P.O. Box etc.

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

pub fn line_ext(self, value: Vec<Option<FieldExtension>>) -> AddressBuilder

Extension field.

pub fn city(self, value: String) -> AddressBuilder

Name of city, town etc.

The name of the city, town, suburb, village or other community or delivery center.

pub fn city_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn district(self, value: String) -> AddressBuilder

District name (aka county)

The name of the administrative area (county).

District is sometimes known as county, but in some regions ‘county’ is used in place of city (municipality), so county name should be conveyed in city instead.

pub fn district_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn state(self, value: String) -> AddressBuilder

Sub-unit of country (abbreviations ok)

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

pub fn state_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn postal_code(self, value: String) -> AddressBuilder

Postal code for area

A postal code designating a region defined by the postal service.

pub fn postal_code_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn country(self, value: String) -> AddressBuilder

Country (e.g. may be ISO 3166 2 or 3 letter code)

Country - a nation as commonly understood or generally accepted.

ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

pub fn country_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

pub fn period(self, value: Period) -> AddressBuilder

Time period when address was/is in use

Time period when address was/is in use.

pub fn period_ext(self, value: FieldExtension) -> AddressBuilder

Extension field.

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

Builds a new AddressInner.

Errors

If a required field has not been initialized.

impl AddressBuilder

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

Finalize building Address.

Trait Implementations

impl Default for AddressBuilder

fn default() -> AddressBuilder

Returns the “default value” for a type.