Class Address

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

    public class Address
    extends Type
    implements org.hl7.fhir.instance.model.api.ICompositeType
    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.
    See Also:
    Serialized Form
    • Field Detail

      • type

        protected Enumeration<Address.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.
      • text

        protected StringType text
        A full text representation of the address.
      • line

        protected List<StringType> line
        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
      • city

        protected StringType city
        The name of the city, town, village or other community or delivery center.
      • state

        protected StringType 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 (i.e. US 2 letter state codes).
      • postalCode

        protected StringType postalCode
        A postal code designating a region defined by the postal service.
      • country

        protected StringType country
        Country - a nation as commonly understood or generally accepted.
      • period

        protected Period period
        Time period when address was/is in use.
    • Constructor Detail

      • Address

        public Address()
        Constructor
    • Method Detail

      • getUseElement

        public Enumeration<Address.AddressUsegetUseElement()
        Returns:
        use (The purpose of this address.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
      • hasUse

        public boolean hasUse()
      • setUseElement

        public Address setUseElement​(Enumeration<Address.AddressUse> value)
        Parameters:
        value - use (The purpose of this address.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
      • getTypeElement

        public Enumeration<Address.AddressTypegetTypeElement()
        Returns:
        type (Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
      • hasType

        public boolean hasType()
      • setTypeElement

        public Address setTypeElement​(Enumeration<Address.AddressType> value)
        Parameters:
        value - type (Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
      • getType

        public Address.AddressType getType()
        Returns:
        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 Address setType​(Address.AddressType value)
        Parameters:
        value - 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 StringType getTextElement()
        Returns:
        text (A full text representation of the address.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
      • hasText

        public boolean hasText()
      • setTextElement

        public Address setTextElement​(StringType value)
        Parameters:
        value - text (A full text representation of the address.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
      • getText

        public String getText()
        Returns:
        A full text representation of the address.
      • setText

        public Address setText​(String value)
        Parameters:
        value - A full text representation of the address.
      • getLine

        public List<StringTypegetLine()
        Returns:
        line (This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.)
      • hasLine

        public boolean hasLine()
      • addLineElement

        public StringType addLineElement()
        Returns:
        line (This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.)
      • addLine

        public Address addLine​(String value)
        Parameters:
        value - line (This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.)
      • hasLine

        public boolean hasLine​(String value)
        Parameters:
        value - line (This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.)
      • getCityElement

        public StringType getCityElement()
        Returns:
        city (The name of the city, town, village or other community or delivery center.). This is the underlying object with id, value and extensions. The accessor "getCity" gives direct access to the value
      • hasCity

        public boolean hasCity()
      • setCityElement

        public Address setCityElement​(StringType value)
        Parameters:
        value - city (The name of the city, town, village or other community or delivery center.). This is the underlying object with id, value and extensions. The accessor "getCity" gives direct access to the value
      • getCity

        public String getCity()
        Returns:
        The name of the city, town, village or other community or delivery center.
      • setCity

        public Address setCity​(String value)
        Parameters:
        value - The name of the city, town, village or other community or delivery center.
      • getDistrictElement

        public StringType getDistrictElement()
        Returns:
        district (The name of the administrative area (county).). This is the underlying object with id, value and extensions. The accessor "getDistrict" gives direct access to the value
      • setDistrictElement

        public Address setDistrictElement​(StringType value)
        Parameters:
        value - district (The name of the administrative area (county).). This is the underlying object with id, value and extensions. The accessor "getDistrict" gives direct access to the value
      • getDistrict

        public String getDistrict()
        Returns:
        The name of the administrative area (county).
      • setDistrict

        public Address setDistrict​(String value)
        Parameters:
        value - The name of the administrative area (county).
      • getStateElement

        public StringType getStateElement()
        Returns:
        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 (i.e. US 2 letter state codes).). This is the underlying object with id, value and extensions. The accessor "getState" gives direct access to the value
      • setStateElement

        public Address setStateElement​(StringType value)
        Parameters:
        value - 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 (i.e. US 2 letter state codes).). This is the underlying object with id, value and extensions. The accessor "getState" gives direct access to the value
      • getState

        public String getState()
        Returns:
        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 Address setState​(String value)
        Parameters:
        value - 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 StringType getPostalCodeElement()
        Returns:
        postalCode (A postal code designating a region defined by the postal service.). This is the underlying object with id, value and extensions. The accessor "getPostalCode" gives direct access to the value
      • setPostalCodeElement

        public Address setPostalCodeElement​(StringType value)
        Parameters:
        value - postalCode (A postal code designating a region defined by the postal service.). This is the underlying object with id, value and extensions. The accessor "getPostalCode" gives direct access to the value
      • getPostalCode

        public String getPostalCode()
        Returns:
        A postal code designating a region defined by the postal service.
      • setPostalCode

        public Address setPostalCode​(String value)
        Parameters:
        value - A postal code designating a region defined by the postal service.
      • getCountryElement

        public StringType getCountryElement()
        Returns:
        country (Country - a nation as commonly understood or generally accepted.). This is the underlying object with id, value and extensions. The accessor "getCountry" gives direct access to the value
      • setCountryElement

        public Address setCountryElement​(StringType value)
        Parameters:
        value - country (Country - a nation as commonly understood or generally accepted.). This is the underlying object with id, value and extensions. The accessor "getCountry" gives direct access to the value
      • getCountry

        public String getCountry()
        Returns:
        Country - a nation as commonly understood or generally accepted.
      • setCountry

        public Address setCountry​(String value)
        Parameters:
        value - Country - a nation as commonly understood or generally accepted.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • addChild

        public Base addChild​(String name)
                      throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • fhirType

        public String fhirType()
        Specified by:
        fhirType in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        fhirType in class Element
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element