Package ca.uhn.hl7v2.model.v251.segment

Class TQ2

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

Represents an HL7 TQ2 message segment (Timing/Quantity Relationship). This segment has the following fields:

  • TQ2-1: Set ID - TQ2 (SI) optional
  • TQ2-2: Sequence/Results Flag (ID) optional
  • TQ2-3: Related Placer Number (EI) optional repeating
  • TQ2-4: Related Filler Number (EI) optional repeating
  • TQ2-5: Related Placer Group Number (EI) optional repeating
  • TQ2-6: Sequence Condition Code (ID) optional
  • TQ2-7: Cyclic Entry/Exit Indicator (ID) optional
  • TQ2-8: Sequence Condition Time Interval (CQ) optional
  • TQ2-9: Cyclic Group Maximum Number of Repeats (NM) optional
  • TQ2-10: Special Service Request Relationship (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDTQ2

      public SI getSetIDTQ2()
      Returns TQ2-1: "Set ID - TQ2" - creates it if necessary

    • getTq21_SetIDTQ2

      public SI getTq21_SetIDTQ2()
      Returns TQ2-1: "Set ID - TQ2" - creates it if necessary

    • getSequenceResultsFlag

      public ID getSequenceResultsFlag()
      Returns TQ2-2: "Sequence/Results Flag" - creates it if necessary

    • getTq22_SequenceResultsFlag

      public ID getTq22_SequenceResultsFlag()
      Returns TQ2-2: "Sequence/Results Flag" - creates it if necessary

    • getRelatedPlacerNumber

      public EI[] getRelatedPlacerNumber()
      Returns all repetitions of Related Placer Number (TQ2-3).

    • getTq23_RelatedPlacerNumber

      public EI[] getTq23_RelatedPlacerNumber()
      Returns all repetitions of Related Placer Number (TQ2-3).

    • getRelatedPlacerNumberReps

      public int getRelatedPlacerNumberReps()
      Returns a count of the current number of repetitions of Related Placer Number (TQ2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRelatedPlacerNumber

      public EI getRelatedPlacerNumber(int rep)
      Returns a specific repetition of TQ2-3: "Related Placer Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq23_RelatedPlacerNumber

      public EI getTq23_RelatedPlacerNumber(int rep)
      Returns a specific repetition of TQ2-3: "Related Placer Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq23_RelatedPlacerNumberReps

      public int getTq23_RelatedPlacerNumberReps()
      Returns a count of the current number of repetitions of Related Placer Number (TQ2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRelatedPlacerNumber

      public EI insertRelatedPlacerNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-3: "Related Placer 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)

    • insertTq23_RelatedPlacerNumber

      public EI insertTq23_RelatedPlacerNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-3: "Related Placer 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)

    • removeRelatedPlacerNumber

      public EI removeRelatedPlacerNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-3: "Related Placer 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)

    • removeTq23_RelatedPlacerNumber

      public EI removeTq23_RelatedPlacerNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-3: "Related Placer 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)

    • getRelatedFillerNumber

      public EI[] getRelatedFillerNumber()
      Returns all repetitions of Related Filler Number (TQ2-4).

    • getTq24_RelatedFillerNumber

      public EI[] getTq24_RelatedFillerNumber()
      Returns all repetitions of Related Filler Number (TQ2-4).

    • getRelatedFillerNumberReps

      public int getRelatedFillerNumberReps()
      Returns a count of the current number of repetitions of Related Filler Number (TQ2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRelatedFillerNumber

      public EI getRelatedFillerNumber(int rep)
      Returns a specific repetition of TQ2-4: "Related Filler Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq24_RelatedFillerNumber

      public EI getTq24_RelatedFillerNumber(int rep)
      Returns a specific repetition of TQ2-4: "Related Filler Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq24_RelatedFillerNumberReps

      public int getTq24_RelatedFillerNumberReps()
      Returns a count of the current number of repetitions of Related Filler Number (TQ2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRelatedFillerNumber

      public EI insertRelatedFillerNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-4: "Related Filler 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)

    • insertTq24_RelatedFillerNumber

      public EI insertTq24_RelatedFillerNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-4: "Related Filler 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)

    • removeRelatedFillerNumber

      public EI removeRelatedFillerNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-4: "Related Filler 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)

    • removeTq24_RelatedFillerNumber

      public EI removeTq24_RelatedFillerNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-4: "Related Filler 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)

    • getRelatedPlacerGroupNumber

      public EI[] getRelatedPlacerGroupNumber()
      Returns all repetitions of Related Placer Group Number (TQ2-5).

    • getTq25_RelatedPlacerGroupNumber

      public EI[] getTq25_RelatedPlacerGroupNumber()
      Returns all repetitions of Related Placer Group Number (TQ2-5).

    • getRelatedPlacerGroupNumberReps

      public int getRelatedPlacerGroupNumberReps()
      Returns a count of the current number of repetitions of Related Placer Group Number (TQ2-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRelatedPlacerGroupNumber

      public EI getRelatedPlacerGroupNumber(int rep)
      Returns a specific repetition of TQ2-5: "Related Placer Group Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq25_RelatedPlacerGroupNumber

      public EI getTq25_RelatedPlacerGroupNumber(int rep)
      Returns a specific repetition of TQ2-5: "Related Placer Group Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getTq25_RelatedPlacerGroupNumberReps

      public int getTq25_RelatedPlacerGroupNumberReps()
      Returns a count of the current number of repetitions of Related Placer Group Number (TQ2-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRelatedPlacerGroupNumber

      public EI insertRelatedPlacerGroupNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-5: "Related Placer Group 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)

    • insertTq25_RelatedPlacerGroupNumber

      public EI insertTq25_RelatedPlacerGroupNumber(int rep) throws HL7Exception
      Inserts a repetition of TQ2-5: "Related Placer Group 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)

    • removeRelatedPlacerGroupNumber

      public EI removeRelatedPlacerGroupNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-5: "Related Placer Group 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)

    • removeTq25_RelatedPlacerGroupNumber

      public EI removeTq25_RelatedPlacerGroupNumber(int rep) throws HL7Exception
      Removes a repetition of TQ2-5: "Related Placer Group 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)

    • getSequenceConditionCode

      public ID getSequenceConditionCode()
      Returns TQ2-6: "Sequence Condition Code" - creates it if necessary

    • getTq26_SequenceConditionCode

      public ID getTq26_SequenceConditionCode()
      Returns TQ2-6: "Sequence Condition Code" - creates it if necessary

    • getCyclicEntryExitIndicator

      public ID getCyclicEntryExitIndicator()
      Returns TQ2-7: "Cyclic Entry/Exit Indicator" - creates it if necessary

    • getTq27_CyclicEntryExitIndicator

      public ID getTq27_CyclicEntryExitIndicator()
      Returns TQ2-7: "Cyclic Entry/Exit Indicator" - creates it if necessary

    • getSequenceConditionTimeInterval

      public CQ getSequenceConditionTimeInterval()
      Returns TQ2-8: "Sequence Condition Time Interval" - creates it if necessary

    • getTq28_SequenceConditionTimeInterval

      public CQ getTq28_SequenceConditionTimeInterval()
      Returns TQ2-8: "Sequence Condition Time Interval" - creates it if necessary

    • getCyclicGroupMaximumNumberOfRepeats

      public NM getCyclicGroupMaximumNumberOfRepeats()
      Returns TQ2-9: "Cyclic Group Maximum Number of Repeats" - creates it if necessary

    • getTq29_CyclicGroupMaximumNumberOfRepeats

      public NM getTq29_CyclicGroupMaximumNumberOfRepeats()
      Returns TQ2-9: "Cyclic Group Maximum Number of Repeats" - creates it if necessary

    • getSpecialServiceRequestRelationship

      public ID getSpecialServiceRequestRelationship()
      Returns TQ2-10: "Special Service Request Relationship" - creates it if necessary

    • getTq210_SpecialServiceRequestRelationship

      public ID getTq210_SpecialServiceRequestRelationship()
      Returns TQ2-10: "Special Service Request Relationship" - creates it if necessary

    • createNewTypeWithoutReflection

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