ca.uhn.fhir.model.dstu.composite

Class AddressDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.composite.AddressDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions

public class AddressDt
extends BaseIdentifiableElement
implements ICompositeDatatype

HAPI/FHIR AddressDt Datatype (A postal address)

Definition: There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world

Requirements: Need to be able to record postal addresses, along with notes about their use

Constructor Summary

Constructors

Constructor and Description
AddressDt() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
StringDt	addLine() Adds and returns a new value for line (Street name, number, direction & P.O.
AddressDt	addLine(String theString) Adds a new value for line (Street name, number, direction & P.O.
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
StringDt	getCity() Gets the value(s) for city (Name of city, town etc.).
StringDt	getCountry() Gets the value(s) for country (Country (can be ISO 3166 3 letter code)).
List<StringDt>	getLine() Gets the value(s) for line (Street name, number, direction & P.O.
StringDt	getLineFirstRep() Gets the first repetition for line (Street name, number, direction & P.O.
PeriodDt	getPeriod() Gets the value(s) for period (Time period when address was/is in use).
StringDt	getState() Gets the value(s) for state (Sub-unit of country (abreviations ok)).
StringDt	getText() Gets the value(s) for text (Text representation of the address).
BoundCodeDt<AddressUseEnum>	getUse() Gets the value(s) for use (home | work | temp | old - purpose of this address).
StringDt	getZip() Gets the value(s) for zip (Postal code for area).
boolean	isEmpty()
AddressDt	setCity(String theString) Sets the value for city (Name of city, town etc.)
AddressDt	setCity(StringDt theValue) Sets the value(s) for city (Name of city, town etc.)
AddressDt	setCountry(String theString) Sets the value for country (Country (can be ISO 3166 3 letter code))
AddressDt	setCountry(StringDt theValue) Sets the value(s) for country (Country (can be ISO 3166 3 letter code))
AddressDt	setLine(List<StringDt> theValue) Sets the value(s) for line (Street name, number, direction & P.O.
AddressDt	setPeriod(PeriodDt theValue) Sets the value(s) for period (Time period when address was/is in use)
AddressDt	setState(String theString) Sets the value for state (Sub-unit of country (abreviations ok))
AddressDt	setState(StringDt theValue) Sets the value(s) for state (Sub-unit of country (abreviations ok))
AddressDt	setText(String theString) Sets the value for text (Text representation of the address)
AddressDt	setText(StringDt theValue) Sets the value(s) for text (Text representation of the address)
AddressDt	setUse(AddressUseEnum theValue) Sets the value(s) for use (home | work | temp | old - purpose of this address)
AddressDt	setUse(BoundCodeDt<AddressUseEnum> theValue) Sets the value(s) for use (home | work | temp | old - purpose of this address)
AddressDt	setZip(String theString) Sets the value for zip (Postal code for area)
AddressDt	setZip(StringDt theValue) Sets the value(s) for zip (Postal code for area)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressDt

public AddressDt()

Constructor

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getUse

public BoundCodeDt<AddressUseEnum> getUse()

Gets the value(s) for use (home | work | temp | old - purpose of this address). creating it if it does not exist. Will not return null.

Definition: The purpose of this address

setUse

public AddressDt setUse(BoundCodeDt<AddressUseEnum> theValue)

Sets the value(s) for use (home | work | temp | old - purpose of this address)

Definition: The purpose of this address

setUse

public AddressDt setUse(AddressUseEnum theValue)

Sets the value(s) for use (home | work | temp | old - purpose of this address)

Definition: The purpose of this address

getText

public StringDt getText()

Gets the value(s) for text (Text representation of the address). creating it if it does not exist. Will not return null.

Definition: A full text representation of the address

setText

public AddressDt setText(StringDt theValue)

Sets the value(s) for text (Text representation of the address)

Definition: A full text representation of the address

setText

public AddressDt setText(String theString)

Sets the value for text (Text representation of the address)

Definition: A full text representation of the address

getLine

public List<StringDt> getLine()

Gets the value(s) for line (Street name, number, direction & P.O. Box etc). creating it if it does not exist. Will not return null.

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

setLine

public AddressDt setLine(List<StringDt> theValue)

Sets the value(s) for line (Street name, number, direction & P.O. Box etc)

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

addLine

public StringDt addLine()

Adds and returns a new value for line (Street name, number, direction & P.O. Box etc)

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

getLineFirstRep

public StringDt getLineFirstRep()

Gets the first repetition for line (Street name, number, direction & P.O. Box etc), creating it if it does not already exist.

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

addLine

public AddressDt addLine(String theString)

Adds a new value for line (Street name, number, direction & P.O. Box etc)

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

Returns:

Returns a reference to this object, to allow for simple chaining.

getCity

public StringDt getCity()

Gets the value(s) for city (Name of city, town etc.). creating it if it does not exist. Will not return null.

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

setCity

public AddressDt setCity(StringDt theValue)

Sets the value(s) for city (Name of city, town etc.)

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

setCity

public AddressDt setCity(String theString)

Sets the value for city (Name of city, town etc.)

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

getState

public StringDt getState()

Gets the value(s) for state (Sub-unit of country (abreviations ok)). creating it if it does not exist. Will not return null.

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

setState

public AddressDt setState(StringDt theValue)

Sets the value(s) for state (Sub-unit of country (abreviations ok))

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

setState

public AddressDt setState(String theString)

Sets the value for state (Sub-unit of country (abreviations ok))

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

getZip

public StringDt getZip()

Gets the value(s) for zip (Postal code for area). creating it if it does not exist. Will not return null.

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

setZip

public AddressDt setZip(StringDt theValue)

Sets the value(s) for zip (Postal code for area)

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

setZip

public AddressDt setZip(String theString)

Sets the value for zip (Postal code for area)

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

getCountry

public StringDt getCountry()

Gets the value(s) for country (Country (can be ISO 3166 3 letter code)). creating it if it does not exist. Will not return null.

Definition: Country - a nation as commonly understood or generally accepted

setCountry

public AddressDt setCountry(StringDt theValue)

Sets the value(s) for country (Country (can be ISO 3166 3 letter code))

Definition: Country - a nation as commonly understood or generally accepted

setCountry

public AddressDt setCountry(String theString)

Sets the value for country (Country (can be ISO 3166 3 letter code))

Definition: Country - a nation as commonly understood or generally accepted

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (Time period when address was/is in use). creating it if it does not exist. Will not return null.

Definition: Time period when address was/is in use

setPeriod

public AddressDt setPeriod(PeriodDt theValue)

Sets the value(s) for period (Time period when address was/is in use)

Definition: Time period when address was/is in use