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

Class XTN

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

Represents an HL7 XTN (Extended Telecommunication Number) data type. This type consists of the following components:

  • Telephone Number (ST)
  • Telecommunication Use Code (ID)
  • Telecommunication Equipment Type (ID)
  • Email Address (ST)
  • Country Code (NM)
  • Area/City Code (NM)
  • Local Number (NM)
  • Extension (NM)
  • Any Text (ST)
  • Extension Prefix (ST)
  • Speed Dial Code (ST)
  • Unformatted Telephone number (ST)
See Also:

  • Constructor Details

    • XTN

      public XTN(Message message)
      Creates a new XTN 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.

    • getTelephoneNumber

      public ST getTelephoneNumber()
      Returns Telephone Number (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getXtn1_TelephoneNumber

      public ST getXtn1_TelephoneNumber()
      Returns Telephone Number (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getTelecommunicationUseCode

      public ID getTelecommunicationUseCode()
      Returns Telecommunication Use Code (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getXtn2_TelecommunicationUseCode

      public ID getXtn2_TelecommunicationUseCode()
      Returns Telecommunication Use Code (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getTelecommunicationEquipmentType

      public ID getTelecommunicationEquipmentType()
      Returns Telecommunication Equipment Type (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getXtn3_TelecommunicationEquipmentType

      public ID getXtn3_TelecommunicationEquipmentType()
      Returns Telecommunication Equipment Type (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getEmailAddress

      public ST getEmailAddress()
      Returns Email Address (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getXtn4_EmailAddress

      public ST getXtn4_EmailAddress()
      Returns Email Address (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getCountryCode

      public NM getCountryCode()
      Returns Country Code (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getXtn5_CountryCode

      public NM getXtn5_CountryCode()
      Returns Country Code (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getAreaCityCode

      public NM getAreaCityCode()
      Returns Area/City Code (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getXtn6_AreaCityCode

      public NM getXtn6_AreaCityCode()
      Returns Area/City Code (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getLocalNumber

      public NM getLocalNumber()
      Returns Local Number (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getXtn7_LocalNumber

      public NM getXtn7_LocalNumber()
      Returns Local Number (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getExtension

      public NM getExtension()
      Returns Extension (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getXtn8_Extension

      public NM getXtn8_Extension()
      Returns Extension (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getAnyText

      public ST getAnyText()
      Returns Any Text (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getXtn9_AnyText

      public ST getXtn9_AnyText()
      Returns Any Text (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getExtensionPrefix

      public ST getExtensionPrefix()
      Returns Extension Prefix (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getXtn10_ExtensionPrefix

      public ST getXtn10_ExtensionPrefix()
      Returns Extension Prefix (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getSpeedDialCode

      public ST getSpeedDialCode()
      Returns Speed Dial Code (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getXtn11_SpeedDialCode

      public ST getXtn11_SpeedDialCode()
      Returns Speed Dial Code (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getUnformattedTelephoneNumber

      public ST getUnformattedTelephoneNumber()
      Returns Unformatted Telephone number (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getXtn12_UnformattedTelephoneNumber

      public ST getXtn12_UnformattedTelephoneNumber()
      Returns Unformatted Telephone number (component 12). This is a convenience method that saves you from casting and handling an exception.