Address class
Address An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
- Annotations
-
- @freezed
Constructors
-
Address({@JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, AddressUse? use, @JsonKey(name: '_use') Element? useElement, AddressType? type, @JsonKey(name: '_type') Element? typeElement, String? text, @JsonKey(name: '_text') Element? textElement, List<String> ? line, @JsonKey(name: '_line') List<Element> ? lineElement, String? city, @JsonKey(name: '_city') Element? cityElement, String? district, @JsonKey(name: '_district') Element? districtElement, String? state, @JsonKey(name: '_state') Element? stateElement, String? postalCode, @JsonKey(name: '_postalCode') Element? postalCodeElement, String? country, @JsonKey(name: '_country') Element? countryElement, Period? period}) -
Address An address expressed using postal conventions (as opposed to
GPS or other location definition formats). This data type may be used
to convey addresses for use in delivering mail as well as for visiting
locations which might not be valid for mail delivery. There are a
variety of postal address formats defined around the world.The
ISO21090-codedString may be used to provide a coded representation of
the contents of strings in an Address.
constfactory
-
Address.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Address.fromJsonString(String source)
-
Acts like a constructor, returns a Address, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Address.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- city → String?
-
city The name of the city, town, suburb, village or other community
or delivery center.
no setterinherited
- cityElement → Element?
-
cityElement ("_city") Extensions for city
no setterinherited
-
copyWith
→ $AddressCopyWith<
Address> -
no setterinherited
- country → String?
-
country Country - a nation as commonly understood or generally
accepted.
no setterinherited
- countryElement → Element?
-
countryElement ("_country") Extensions for country
no setterinherited
- district → String?
-
district The name of the administrative area (county).
no setterinherited
- districtElement → Element?
-
districtElement ("_district") Extensions for district
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") 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.
no setterinherited
- fhirId → String?
-
id Unique id for the element within a resource (for internal
references). This may be any string value that does not contain spaces.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
line
→ List<
String> ? -
line This component contains the house number, apartment number,
street name, street direction, P.O. Box number, delivery hints, and
similar address information.
no setterinherited
-
lineElement
→ List<
Element> ? -
lineElement ("_line") Extensions for line
no setterinherited
- period → Period?
-
period Time period when address was/is in use.
no setterinherited
- postalCode → String?
-
postalCode A postal code designating a region defined by the postal
service.
no setterinherited
- postalCodeElement → Element?
-
postalCodeElement ("_postalCode") Extensions for postalCode
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → String?
-
state 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).
no setterinherited
- stateElement → Element?
-
stateElement ("_state") Extensions for state
no setterinherited
- text → String?
-
text 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.
no setterinherited
- textElement → Element?
-
textElement ("_text") Extensions for text
no setterinherited
- type → AddressType?
-
type Distinguishes between physical addresses (those you can visit)
and mailing addresses (e.g. PO Boxes and care-of addresses). Most
addresses are both.
no setterinherited
- typeElement → Element?
-
typeElement ("_type") Extensions for type
no setterinherited
- use → AddressUse?
-
use The purpose of this address.
no setterinherited
- useElement → Element?
-
useElement ("_use") Extensions for use
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String - Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String - Produces a Yaml formatted String version of the object
-
updateCity(
String city) → Address -
updateCountry(
String country) → Address -
updateDistrict(
String district) → Address -
updateLine(
List< String> line) → Address -
updatePeriod(
Period period) → Address -
updatePostalCode(
String postalCode) → Address -
updateState(
String state) → Address -
updateText(
String text) → Address -
updateType(
AddressType type) → Address -
updateUse(
AddressUse use) → Address - Because this is a common class that's updated
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited