Package ca.uhn.hl7v2.model.v22.datatype

Class AD

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v22.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 (ID)
  • country (ID)
  • 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 ID 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 ID 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.

    • getType

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

    • getAd7_Type

      public ID getAd7_Type()
      Returns 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.