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

Class XON

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

Represents an HL7 XON (Extended Composite Name and Identification Number for Organizations) data type. This type consists of the following components:

  • Organization Name (ST)
  • Organization Name Type Code (IS)
  • ID Number (NM)
  • Check Digit (NM)
  • Check Digit Scheme (ID)
  • Assigning Authority (HD)
  • Identifier Type Code (ID)
  • Assigning Facility (HD)
  • Name Representation Code (ID)
  • Organization Identifier (ST)
See Also:

  • Constructor Details

    • XON

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

    • getOrganizationName

      public ST getOrganizationName()
      Returns Organization Name (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getXon1_OrganizationName

      public ST getXon1_OrganizationName()
      Returns Organization Name (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getOrganizationNameTypeCode

      public IS getOrganizationNameTypeCode()
      Returns Organization Name Type Code (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getXon2_OrganizationNameTypeCode

      public IS getXon2_OrganizationNameTypeCode()
      Returns Organization Name Type Code (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getIDNumber

      public NM getIDNumber()
      Returns ID Number (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getXon3_IDNumber

      public NM getXon3_IDNumber()
      Returns ID Number (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getCheckDigit

      public NM getCheckDigit()
      Returns Check Digit (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getXon4_CheckDigit

      public NM getXon4_CheckDigit()
      Returns Check Digit (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getCheckDigitScheme

      public ID getCheckDigitScheme()
      Returns Check Digit Scheme (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getXon5_CheckDigitScheme

      public ID getXon5_CheckDigitScheme()
      Returns Check Digit Scheme (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningAuthority

      public HD getAssigningAuthority()
      Returns Assigning Authority (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getXon6_AssigningAuthority

      public HD getXon6_AssigningAuthority()
      Returns Assigning Authority (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getIdentifierTypeCode

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

    • getXon7_IdentifierTypeCode

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

    • getAssigningFacility

      public HD getAssigningFacility()
      Returns Assigning Facility (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getXon8_AssigningFacility

      public HD getXon8_AssigningFacility()
      Returns Assigning Facility (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getNameRepresentationCode

      public ID getNameRepresentationCode()
      Returns Name Representation Code (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getXon9_NameRepresentationCode

      public ID getXon9_NameRepresentationCode()
      Returns Name Representation Code (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getOrganizationIdentifier

      public ST getOrganizationIdentifier()
      Returns Organization Identifier (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getXon10_OrganizationIdentifier

      public ST getXon10_OrganizationIdentifier()
      Returns Organization Identifier (component 10). This is a convenience method that saves you from casting and handling an exception.