Package ca.uhn.hl7v2.model.v24.datatype

Class XTN

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v24.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:

  • [(999)] 999-9999 [X99999][C any text] (TN)
  • telecommunication use code (ID)
  • telecommunication equipment type (ID) (ID)
  • Email address (ST)
  • Country Code (NM)
  • Area/city code (NM)
  • Phone number (NM)
  • Extension (NM)
  • any text (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.

    • get9999999X99999CAnyText

      public TN get9999999X99999CAnyText()
      Returns [(999)] 999-9999 [X99999][C any text] (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getXtn1_9999999X99999CAnyText

      public TN getXtn1_9999999X99999CAnyText()
      Returns [(999)] 999-9999 [X99999][C any text] (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 (ID) (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 (ID) (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.

    • getPhoneNumber

      public NM getPhoneNumber()
      Returns Phone number (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getXtn7_PhoneNumber

      public NM getXtn7_PhoneNumber()
      Returns Phone 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.