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

Class AD

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

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

  • Street Address (ST)
  • Other Designation (ST)
  • City (ST)
  • State or Province (ST)
  • Zip or Postal Code (ST)
  • Country (ID)
  • Address Type (ID)
  • Other Geographic Designation (ST)
See Also:

  • Constructor Details

    • AD

      public AD(Message message)
      Creates a new AD 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 ST getStreetAddress()
      Returns Street Address (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getAd1_StreetAddress

      public ST getAd1_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.

    • getAd2_OtherDesignation

      public ST getAd2_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.

    • getAd3_City

      public ST getAd3_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.

    • getAd4_StateOrProvince

      public ST getAd4_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.

    • getAd5_ZipOrPostalCode

      public ST getAd5_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.

    • getAd6_Country

      public ID getAd6_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.

    • getAd7_AddressType

      public ID getAd7_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.

    • getAd8_OtherGeographicDesignation

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