Class AddressDt

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

    public class AddressDt
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.ICompositeDatatype
    HAPI/FHIR AddressDt Datatype ()

    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

    See Also:
    Serialized Form
    • Constructor Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUseElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AddressUseEnumgetUseElement()
        Gets the value(s) for use (). creating it if it does not exist. Will not return null.

        Definition: The purpose of this address

      • getUse

        public String getUse()
        Gets the value(s) for use (). creating it if it does not exist. This method may return null.

        Definition: The purpose of this address

      • setUse

        public AddressDt setUse​(ca.uhn.fhir.model.primitive.BoundCodeDt<AddressUseEnum> theValue)
        Sets the value(s) for use ()

        Definition: The purpose of this address

      • getTypeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AddressTypeEnumgetTypeElement()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

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

      • getType

        public String getType()
        Gets the value(s) for type (). creating it if it does not exist. This method may return null.

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

      • setType

        public AddressDt setType​(ca.uhn.fhir.model.primitive.BoundCodeDt<AddressTypeEnum> theValue)
        Sets the value(s) for type ()

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

      • setType

        public AddressDt setType​(AddressTypeEnum theValue)
        Sets the value(s) for type ()

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

      • getTextElement

        public ca.uhn.fhir.model.primitive.StringDt getTextElement()
        Gets the value(s) for text (). creating it if it does not exist. Will not return null.

        Definition: A full text representation of the address

      • getText

        public String getText()
        Gets the value(s) for text (). creating it if it does not exist. This method may return null.

        Definition: A full text representation of the address

      • setText

        public AddressDt setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for text ()

        Definition: A full text representation of the address

      • setText

        public AddressDt setText​(String theString)
        Sets the value for text ()

        Definition: A full text representation of the address

      • getLine

        public List<ca.uhn.fhir.model.primitive.StringDt> getLine()
        Gets the value(s) for line (). 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<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for line ()

        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 ca.uhn.fhir.model.primitive.StringDt addLine()
        Adds and returns a new value for line ()

        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​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for line ()

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

        Parameters:
        theValue - The line to add (must not be null)
      • getLineFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getLineFirstRep()
        Gets the first repetition for line (), 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 ()

        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.
      • getCityElement

        public ca.uhn.fhir.model.primitive.StringDt getCityElement()
        Gets the value(s) for city (). 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

      • getCity

        public String getCity()
        Gets the value(s) for city (). creating it if it does not exist. This method may return null.

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

      • setCity

        public AddressDt setCity​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for city ()

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

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

      • getDistrictElement

        public ca.uhn.fhir.model.primitive.StringDt getDistrictElement()
        Gets the value(s) for district (). creating it if it does not exist. Will not return null.

        Definition: The name of the administrative area (county)

      • getDistrict

        public String getDistrict()
        Gets the value(s) for district (). creating it if it does not exist. This method may return null.

        Definition: The name of the administrative area (county)

      • setDistrict

        public AddressDt setDistrict​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for district ()

        Definition: The name of the administrative area (county)

      • setDistrict

        public AddressDt setDistrict​(String theString)
        Sets the value for district ()

        Definition: The name of the administrative area (county)

      • getStateElement

        public ca.uhn.fhir.model.primitive.StringDt getStateElement()
        Gets the value(s) for state (). 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)

      • getState

        public String getState()
        Gets the value(s) for state (). creating it if it does not exist. This method may 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for state ()

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

        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)

      • getPostalCodeElement

        public ca.uhn.fhir.model.primitive.StringDt getPostalCodeElement()
        Gets the value(s) for postalCode (). creating it if it does not exist. Will not return null.

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

      • getPostalCode

        public String getPostalCode()
        Gets the value(s) for postalCode (). creating it if it does not exist. This method may return null.

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

      • setPostalCode

        public AddressDt setPostalCode​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for postalCode ()

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

      • setPostalCode

        public AddressDt setPostalCode​(String theString)
        Sets the value for postalCode ()

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

      • getCountryElement

        public ca.uhn.fhir.model.primitive.StringDt getCountryElement()
        Gets the value(s) for country (). creating it if it does not exist. Will not return null.

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

      • getCountry

        public String getCountry()
        Gets the value(s) for country (). creating it if it does not exist. This method may return null.

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

      • setCountry

        public AddressDt setCountry​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for country ()

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

      • setCountry

        public AddressDt setCountry​(String theString)
        Sets the value for country ()

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

      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (). 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 ()

        Definition: Time period when address was/is in use