Package ca.uhn.hl7v2.model.v22.segment

Class GT1

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.GT1
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class GT1 extends AbstractSegment

Represents an HL7 GT1 message segment (GUARANTOR). This segment has the following fields:

  • GT1-1: Set ID - guarantor (SI)
  • GT1-2: Guarantor number (CK) optional
  • GT1-3: Guarantor name (PN)
  • GT1-4: Guarantor spouse name (PN) optional
  • GT1-5: Guarantor address (AD) optional
  • GT1-6: Guarantor phone number - home (TN) optional repeating
  • GT1-7: Guarantor phone number - business (TN) optional repeating
  • GT1-8: Guarantor date of birth (DT) optional
  • GT1-9: Guarantor sex (ID) optional
  • GT1-10: Guarantor type (ID) optional
  • GT1-11: Guarantor relationship (ID) optional
  • GT1-12: Guarantor social security number (ST) optional
  • GT1-13: Guarantor date - begin (DT) optional
  • GT1-14: Guarantor date - end (DT) optional
  • GT1-15: Guarantor priority (NM) optional
  • GT1-16: Guarantor employer name (ST) optional
  • GT1-17: Guarantor employer address (AD) optional
  • GT1-18: Guarantor employ phone number (TN) optional repeating
  • GT1-19: Guarantor employee ID number (ST) optional
  • GT1-20: Guarantor employment status (ID) optional
  • GT1-21: Guarantor organization (ST) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDGuarantor

      public SI getSetIDGuarantor()
      Returns GT1-1: "Set ID - guarantor" - creates it if necessary

    • getGt11_SetIDGuarantor

      public SI getGt11_SetIDGuarantor()
      Returns GT1-1: "Set ID - guarantor" - creates it if necessary

    • getGuarantorNumber

      public CK getGuarantorNumber()
      Returns GT1-2: "Guarantor number" - creates it if necessary

    • getGt12_GuarantorNumber

      public CK getGt12_GuarantorNumber()
      Returns GT1-2: "Guarantor number" - creates it if necessary

    • getGuarantorName

      public PN getGuarantorName()
      Returns GT1-3: "Guarantor name" - creates it if necessary

    • getGt13_GuarantorName

      public PN getGt13_GuarantorName()
      Returns GT1-3: "Guarantor name" - creates it if necessary

    • getGuarantorSpouseName

      public PN getGuarantorSpouseName()
      Returns GT1-4: "Guarantor spouse name" - creates it if necessary

    • getGt14_GuarantorSpouseName

      public PN getGt14_GuarantorSpouseName()
      Returns GT1-4: "Guarantor spouse name" - creates it if necessary

    • getGuarantorAddress

      public AD getGuarantorAddress()
      Returns GT1-5: "Guarantor address" - creates it if necessary

    • getGt15_GuarantorAddress

      public AD getGt15_GuarantorAddress()
      Returns GT1-5: "Guarantor address" - creates it if necessary

    • getGuarantorPhoneNumberHome

      public TN[] getGuarantorPhoneNumberHome()
      Returns all repetitions of Guarantor phone number - home (GT1-6).

    • getGt16_GuarantorPhoneNumberHome

      public TN[] getGt16_GuarantorPhoneNumberHome()
      Returns all repetitions of Guarantor phone number - home (GT1-6).

    • getGuarantorPhoneNumberHomeReps

      public int getGuarantorPhoneNumberHomeReps()
      Returns a count of the current number of repetitions of Guarantor phone number - home (GT1-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getGuarantorPhoneNumberHome

      public TN getGuarantorPhoneNumberHome(int rep)
      Returns a specific repetition of GT1-6: "Guarantor phone number - home" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt16_GuarantorPhoneNumberHome

      public TN getGt16_GuarantorPhoneNumberHome(int rep)
      Returns a specific repetition of GT1-6: "Guarantor phone number - home" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt16_GuarantorPhoneNumberHomeReps

      public int getGt16_GuarantorPhoneNumberHomeReps()
      Returns a count of the current number of repetitions of Guarantor phone number - home (GT1-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertGuarantorPhoneNumberHome

      public TN insertGuarantorPhoneNumberHome(int rep) throws HL7Exception
      Inserts a repetition of GT1-6: "Guarantor phone number - home" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGt16_GuarantorPhoneNumberHome

      public TN insertGt16_GuarantorPhoneNumberHome(int rep) throws HL7Exception
      Inserts a repetition of GT1-6: "Guarantor phone number - home" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGuarantorPhoneNumberHome

      public TN removeGuarantorPhoneNumberHome(int rep) throws HL7Exception
      Removes a repetition of GT1-6: "Guarantor phone number - home" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGt16_GuarantorPhoneNumberHome

      public TN removeGt16_GuarantorPhoneNumberHome(int rep) throws HL7Exception
      Removes a repetition of GT1-6: "Guarantor phone number - home" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGuarantorPhoneNumberBusiness

      public TN[] getGuarantorPhoneNumberBusiness()
      Returns all repetitions of Guarantor phone number - business (GT1-7).

    • getGt17_GuarantorPhoneNumberBusiness

      public TN[] getGt17_GuarantorPhoneNumberBusiness()
      Returns all repetitions of Guarantor phone number - business (GT1-7).

    • getGuarantorPhoneNumberBusinessReps

      public int getGuarantorPhoneNumberBusinessReps()
      Returns a count of the current number of repetitions of Guarantor phone number - business (GT1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getGuarantorPhoneNumberBusiness

      public TN getGuarantorPhoneNumberBusiness(int rep)
      Returns a specific repetition of GT1-7: "Guarantor phone number - business" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt17_GuarantorPhoneNumberBusiness

      public TN getGt17_GuarantorPhoneNumberBusiness(int rep)
      Returns a specific repetition of GT1-7: "Guarantor phone number - business" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt17_GuarantorPhoneNumberBusinessReps

      public int getGt17_GuarantorPhoneNumberBusinessReps()
      Returns a count of the current number of repetitions of Guarantor phone number - business (GT1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertGuarantorPhoneNumberBusiness

      public TN insertGuarantorPhoneNumberBusiness(int rep) throws HL7Exception
      Inserts a repetition of GT1-7: "Guarantor phone number - business" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGt17_GuarantorPhoneNumberBusiness

      public TN insertGt17_GuarantorPhoneNumberBusiness(int rep) throws HL7Exception
      Inserts a repetition of GT1-7: "Guarantor phone number - business" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGuarantorPhoneNumberBusiness

      public TN removeGuarantorPhoneNumberBusiness(int rep) throws HL7Exception
      Removes a repetition of GT1-7: "Guarantor phone number - business" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGt17_GuarantorPhoneNumberBusiness

      public TN removeGt17_GuarantorPhoneNumberBusiness(int rep) throws HL7Exception
      Removes a repetition of GT1-7: "Guarantor phone number - business" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGuarantorDateOfBirth

      public DT getGuarantorDateOfBirth()
      Returns GT1-8: "Guarantor date of birth" - creates it if necessary

    • getGt18_GuarantorDateOfBirth

      public DT getGt18_GuarantorDateOfBirth()
      Returns GT1-8: "Guarantor date of birth" - creates it if necessary

    • getGuarantorSex

      public ID getGuarantorSex()
      Returns GT1-9: "Guarantor sex" - creates it if necessary

    • getGt19_GuarantorSex

      public ID getGt19_GuarantorSex()
      Returns GT1-9: "Guarantor sex" - creates it if necessary

    • getGuarantorType

      public ID getGuarantorType()
      Returns GT1-10: "Guarantor type" - creates it if necessary

    • getGt110_GuarantorType

      public ID getGt110_GuarantorType()
      Returns GT1-10: "Guarantor type" - creates it if necessary

    • getGuarantorRelationship

      public ID getGuarantorRelationship()
      Returns GT1-11: "Guarantor relationship" - creates it if necessary

    • getGt111_GuarantorRelationship

      public ID getGt111_GuarantorRelationship()
      Returns GT1-11: "Guarantor relationship" - creates it if necessary

    • getGuarantorSocialSecurityNumber

      public ST getGuarantorSocialSecurityNumber()
      Returns GT1-12: "Guarantor social security number" - creates it if necessary

    • getGt112_GuarantorSocialSecurityNumber

      public ST getGt112_GuarantorSocialSecurityNumber()
      Returns GT1-12: "Guarantor social security number" - creates it if necessary

    • getGuarantorDateBegin

      public DT getGuarantorDateBegin()
      Returns GT1-13: "Guarantor date - begin" - creates it if necessary

    • getGt113_GuarantorDateBegin

      public DT getGt113_GuarantorDateBegin()
      Returns GT1-13: "Guarantor date - begin" - creates it if necessary

    • getGuarantorDateEnd

      public DT getGuarantorDateEnd()
      Returns GT1-14: "Guarantor date - end" - creates it if necessary

    • getGt114_GuarantorDateEnd

      public DT getGt114_GuarantorDateEnd()
      Returns GT1-14: "Guarantor date - end" - creates it if necessary

    • getGuarantorPriority

      public NM getGuarantorPriority()
      Returns GT1-15: "Guarantor priority" - creates it if necessary

    • getGt115_GuarantorPriority

      public NM getGt115_GuarantorPriority()
      Returns GT1-15: "Guarantor priority" - creates it if necessary

    • getGuarantorEmployerName

      public ST getGuarantorEmployerName()
      Returns GT1-16: "Guarantor employer name" - creates it if necessary

    • getGt116_GuarantorEmployerName

      public ST getGt116_GuarantorEmployerName()
      Returns GT1-16: "Guarantor employer name" - creates it if necessary

    • getGuarantorEmployerAddress

      public AD getGuarantorEmployerAddress()
      Returns GT1-17: "Guarantor employer address" - creates it if necessary

    • getGt117_GuarantorEmployerAddress

      public AD getGt117_GuarantorEmployerAddress()
      Returns GT1-17: "Guarantor employer address" - creates it if necessary

    • getGuarantorEmployPhoneNumber

      public TN[] getGuarantorEmployPhoneNumber()
      Returns all repetitions of Guarantor employ phone number (GT1-18).

    • getGt118_GuarantorEmployPhoneNumber

      public TN[] getGt118_GuarantorEmployPhoneNumber()
      Returns all repetitions of Guarantor employ phone number (GT1-18).

    • getGuarantorEmployPhoneNumberReps

      public int getGuarantorEmployPhoneNumberReps()
      Returns a count of the current number of repetitions of Guarantor employ phone number (GT1-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getGuarantorEmployPhoneNumber

      public TN getGuarantorEmployPhoneNumber(int rep)
      Returns a specific repetition of GT1-18: "Guarantor employ phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt118_GuarantorEmployPhoneNumber

      public TN getGt118_GuarantorEmployPhoneNumber(int rep)
      Returns a specific repetition of GT1-18: "Guarantor employ phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGt118_GuarantorEmployPhoneNumberReps

      public int getGt118_GuarantorEmployPhoneNumberReps()
      Returns a count of the current number of repetitions of Guarantor employ phone number (GT1-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertGuarantorEmployPhoneNumber

      public TN insertGuarantorEmployPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of GT1-18: "Guarantor employ phone number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGt118_GuarantorEmployPhoneNumber

      public TN insertGt118_GuarantorEmployPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of GT1-18: "Guarantor employ phone number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGuarantorEmployPhoneNumber

      public TN removeGuarantorEmployPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of GT1-18: "Guarantor employ phone number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGt118_GuarantorEmployPhoneNumber

      public TN removeGt118_GuarantorEmployPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of GT1-18: "Guarantor employ phone number" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGuarantorEmployeeIDNumber

      public ST getGuarantorEmployeeIDNumber()
      Returns GT1-19: "Guarantor employee ID number" - creates it if necessary

    • getGt119_GuarantorEmployeeIDNumber

      public ST getGt119_GuarantorEmployeeIDNumber()
      Returns GT1-19: "Guarantor employee ID number" - creates it if necessary

    • getGuarantorEmploymentStatus

      public ID getGuarantorEmploymentStatus()
      Returns GT1-20: "Guarantor employment status" - creates it if necessary

    • getGt120_GuarantorEmploymentStatus

      public ID getGt120_GuarantorEmploymentStatus()
      Returns GT1-20: "Guarantor employment status" - creates it if necessary

    • getGuarantorOrganization

      public ST getGuarantorOrganization()
      Returns GT1-21: "Guarantor organization" - creates it if necessary

    • getGt121_GuarantorOrganization

      public ST getGt121_GuarantorOrganization()
      Returns GT1-21: "Guarantor organization" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment