Package ca.uhn.hl7v2.model.v251.datatype

Class XAD

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v251.datatype.XAD
All Implemented Interfaces:
Composite, Type, Visitable, Serializable
public class XAD extends AbstractComposite

Represents an HL7 XAD (Extended Address) data type. This type consists of the following components:

  • Street Address (SAD)
  • Other Designation (ST)
  • City (ST)
  • State or Province (ST)
  • Zip or Postal Code (ST)
  • Country (ID)
  • Address Type (ID)
  • Other Geographic Designation (ST)
  • County/Parish Code (IS)
  • Census Tract (IS)
  • Address Representation Code (ID)
  • Address Validity Range (DR)
  • Effective Date (TS)
  • Expiration Date (TS)
See Also:

  • Constructor Details

    • XAD

      public XAD(Message message)
      Creates a new XAD type

  • Method Details

    • getComponents

      public Type[] getComponents()
      Returns an array containing the data elements.

    • getComponent

      public Type getComponent(int number) throws DataTypeException
      Returns an individual data component.
      Parameters:
      number - The component number (0-indexed)
      Throws:
      DataTypeException - if the given element number is out of range.

    • getStreetAddress

      public SAD getStreetAddress()
      Returns Street Address (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getXad1_StreetAddress

      public SAD getXad1_StreetAddress()
      Returns Street Address (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getOtherDesignation

      public ST getOtherDesignation()
      Returns Other Designation (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getXad2_OtherDesignation

      public ST getXad2_OtherDesignation()
      Returns Other Designation (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getCity

      public ST getCity()
      Returns City (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getXad3_City

      public ST getXad3_City()
      Returns City (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getStateOrProvince

      public ST getStateOrProvince()
      Returns State or Province (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getXad4_StateOrProvince

      public ST getXad4_StateOrProvince()
      Returns State or Province (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getZipOrPostalCode

      public ST getZipOrPostalCode()
      Returns Zip or Postal Code (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getXad5_ZipOrPostalCode

      public ST getXad5_ZipOrPostalCode()
      Returns Zip or Postal Code (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getCountry

      public ID getCountry()
      Returns Country (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getXad6_Country

      public ID getXad6_Country()
      Returns Country (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getAddressType

      public ID getAddressType()
      Returns Address Type (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getXad7_AddressType

      public ID getXad7_AddressType()
      Returns Address Type (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getOtherGeographicDesignation

      public ST getOtherGeographicDesignation()
      Returns Other Geographic Designation (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getXad8_OtherGeographicDesignation

      public ST getXad8_OtherGeographicDesignation()
      Returns Other Geographic Designation (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getCountyParishCode

      public IS getCountyParishCode()
      Returns County/Parish Code (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getXad9_CountyParishCode

      public IS getXad9_CountyParishCode()
      Returns County/Parish Code (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getCensusTract

      public IS getCensusTract()
      Returns Census Tract (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getXad10_CensusTract

      public IS getXad10_CensusTract()
      Returns Census Tract (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getAddressRepresentationCode

      public ID getAddressRepresentationCode()
      Returns Address Representation Code (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getXad11_AddressRepresentationCode

      public ID getXad11_AddressRepresentationCode()
      Returns Address Representation Code (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getAddressValidityRange

      public DR getAddressValidityRange()
      Returns Address Validity Range (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getXad12_AddressValidityRange

      public DR getXad12_AddressValidityRange()
      Returns Address Validity Range (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getEffectiveDate

      public TS getEffectiveDate()
      Returns Effective Date (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getXad13_EffectiveDate

      public TS getXad13_EffectiveDate()
      Returns Effective Date (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getExpirationDate

      public TS getExpirationDate()
      Returns Expiration Date (component 14). This is a convenience method that saves you from casting and handling an exception.

    • getXad14_ExpirationDate

      public TS getXad14_ExpirationDate()
      Returns Expiration Date (component 14). This is a convenience method that saves you from casting and handling an exception.