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

Class XON

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v24.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) (NM)
  • check digit (NM) (ST)
  • code identifying the check digit scheme employed (ID)
  • assigning authority (HD)
  • identifier type code (IS) (IS)
  • assigning facility ID (HD)
  • Name Representation code (ID)
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 (NM) (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 (NM) (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getCheckDigit

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

    • getXon4_CheckDigit

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

    • getCodeIdentifyingTheCheckDigitSchemeEmployed

      public ID getCodeIdentifyingTheCheckDigitSchemeEmployed()
      Returns code identifying the check digit scheme employed (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getXon5_CodeIdentifyingTheCheckDigitSchemeEmployed

      public ID getXon5_CodeIdentifyingTheCheckDigitSchemeEmployed()
      Returns code identifying the check digit scheme employed (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 IS getIdentifierTypeCode()
      Returns identifier type code (IS) (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getXon7_IdentifierTypeCode

      public IS getXon7_IdentifierTypeCode()
      Returns identifier type code (IS) (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getAssigningFacilityID

      public HD getAssigningFacilityID()
      Returns assigning facility ID (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getXon8_AssigningFacilityID

      public HD getXon8_AssigningFacilityID()
      Returns assigning facility ID (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.