Package org.hl7.fhir.r5.model

Class Address

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.DataType
org.hl7.fhir.r5.model.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 DataType implements org.hl7.fhir.instance.model.api.ICompositeType
Address Type: 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.
See Also:

  • Field Details

    • use

      protected Enumeration<Address.AddressUse> use
      The purpose of this address.

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

    • 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, suburb, village or other community or delivery center.

    • district

      protected StringType district
      The name of the administrative area (county).

    • 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 (e.g. 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 Details

    • Address

      public Address()
      Constructor

  • Method Details

    • getUseElement

      public Enumeration<Address.AddressUse> getUseElement()
      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

    • hasUseElement

      public boolean hasUseElement()

    • 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

    • getUse

      public Address.AddressUse getUse()
      Returns:
      The purpose of this address.

    • setUse

      public Address setUse(Address.AddressUse value)
      Parameters:
      value - The purpose of this address.

    • getTypeElement

      public Enumeration<Address.AddressType> getTypeElement()
      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

    • hasTypeElement

      public boolean hasTypeElement()

    • 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 (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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

    • hasTextElement

      public boolean hasTextElement()

    • hasText

      public boolean hasText()

    • setTextElement

      public Address setTextElement(StringType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

    • getText

      public String getText()
      Returns:
      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.

    • setText

      public Address setText(String value)
      Parameters:
      value - 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.

    • getLine

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

    • setLine

      public Address setLine(List<StringType> theLine)
      Returns:
      Returns a reference to this for easy method chaining

    • 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, suburb, 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

    • hasCityElement

      public boolean hasCityElement()

    • hasCity

      public boolean hasCity()

    • setCityElement

      public Address setCityElement(StringType value)
      Parameters:
      value - city (The name of the city, town, suburb, 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, suburb, village or other community or delivery center.

    • setCity

      public Address setCity(String value)
      Parameters:
      value - The name of the city, town, suburb, 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

    • hasDistrictElement

      public boolean hasDistrictElement()

    • hasDistrict

      public boolean hasDistrict()

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

    • hasStateElement

      public boolean hasStateElement()

    • hasState

      public boolean hasState()

    • 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 (e.g. 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 (e.g. 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 (e.g. 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

    • hasPostalCodeElement

      public boolean hasPostalCodeElement()

    • hasPostalCode

      public boolean hasPostalCode()

    • 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

    • hasCountryElement

      public boolean hasCountryElement()

    • hasCountry

      public boolean hasCountry()

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

    • getPeriod

      public Period getPeriod()
      Returns:
      period (Time period when address was/is in use.)

    • hasPeriod

      public boolean hasPeriod()

    • setPeriod

      public Address setPeriod(Period value)
      Parameters:
      value - period (Time period when address was/is in use.)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • 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

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty 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 DataType
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public Address copy()
      Specified by:
      copy in class DataType

    • copyValues

      public void copyValues(Address dst)

    • typedCopy

      protected Address typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element

    • isEmpty

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