Package ca.uhn.hl7v2.model.v24.segment

Class UB1

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

Represents an HL7 UB1 message segment (UB82). This segment has the following fields:

  • UB1-1: Set ID - UB1 (SI) optional
  • UB1-2: Blood Deductible (43) (NM) optional
  • UB1-3: Blood Furnished-Pints Of (40) (NM) optional
  • UB1-4: Blood Replaced-Pints (41) (NM) optional
  • UB1-5: Blood Not Replaced-Pints(42) (NM) optional
  • UB1-6: Co-Insurance Days (25) (NM) optional
  • UB1-7: Condition Code (35-39) (IS) optional repeating
  • UB1-8: Covered Days - (23) (NM) optional
  • UB1-9: Non Covered Days - (24) (NM) optional
  • UB1-10: Value Amount & Code (46-49) (UVC) optional repeating
  • UB1-11: Number Of Grace Days (90) (NM) optional
  • UB1-12: Special Program Indicator (44) (CE) optional
  • UB1-13: PSRO/UR Approval Indicator (87) (CE) optional
  • UB1-14: PSRO/UR Approved Stay-Fm (88) (DT) optional
  • UB1-15: PSRO/UR Approved Stay-To (89) (DT) optional
  • UB1-16: Occurrence (28-32) (OCD) optional repeating
  • UB1-17: Occurrence Span (33) (CE) optional
  • UB1-18: Occur Span Start Date(33) (DT) optional
  • UB1-19: Occur Span End Date (33) (DT) optional
  • UB1-20: UB-82 Locator 2 (ST) optional
  • UB1-21: UB-82 Locator 9 (ST) optional
  • UB1-22: UB-82 Locator 27 (ST) optional
  • UB1-23: UB-82 Locator 45 (ST) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDUB1

      public SI getSetIDUB1()
      Returns UB1-1: "Set ID - UB1" - creates it if necessary

    • getUb11_SetIDUB1

      public SI getUb11_SetIDUB1()
      Returns UB1-1: "Set ID - UB1" - creates it if necessary

    • getBloodDeductible

      public NM getBloodDeductible()
      Returns UB1-2: "Blood Deductible (43)" - creates it if necessary

    • getUb12_BloodDeductible

      public NM getUb12_BloodDeductible()
      Returns UB1-2: "Blood Deductible (43)" - creates it if necessary

    • getBloodFurnishedPintsOf

      public NM getBloodFurnishedPintsOf()
      Returns UB1-3: "Blood Furnished-Pints Of (40)" - creates it if necessary

    • getUb13_BloodFurnishedPintsOf

      public NM getUb13_BloodFurnishedPintsOf()
      Returns UB1-3: "Blood Furnished-Pints Of (40)" - creates it if necessary

    • getBloodReplacedPints

      public NM getBloodReplacedPints()
      Returns UB1-4: "Blood Replaced-Pints (41)" - creates it if necessary

    • getUb14_BloodReplacedPints

      public NM getUb14_BloodReplacedPints()
      Returns UB1-4: "Blood Replaced-Pints (41)" - creates it if necessary

    • getBloodNotReplacedPints

      public NM getBloodNotReplacedPints()
      Returns UB1-5: "Blood Not Replaced-Pints(42)" - creates it if necessary

    • getUb15_BloodNotReplacedPints

      public NM getUb15_BloodNotReplacedPints()
      Returns UB1-5: "Blood Not Replaced-Pints(42)" - creates it if necessary

    • getCoInsuranceDays

      public NM getCoInsuranceDays()
      Returns UB1-6: "Co-Insurance Days (25)" - creates it if necessary

    • getUb16_CoInsuranceDays

      public NM getUb16_CoInsuranceDays()
      Returns UB1-6: "Co-Insurance Days (25)" - creates it if necessary

    • getConditionCode3539

      public IS[] getConditionCode3539()
      Returns all repetitions of Condition Code (35-39) (UB1-7).

    • getUb17_ConditionCode3539

      public IS[] getUb17_ConditionCode3539()
      Returns all repetitions of Condition Code (35-39) (UB1-7).

    • getConditionCode3539Reps

      public int getConditionCode3539Reps()
      Returns a count of the current number of repetitions of Condition Code (35-39) (UB1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getConditionCode3539

      public IS getConditionCode3539(int rep)
      Returns a specific repetition of UB1-7: "Condition Code (35-39)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb17_ConditionCode3539

      public IS getUb17_ConditionCode3539(int rep)
      Returns a specific repetition of UB1-7: "Condition Code (35-39)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb17_ConditionCode3539Reps

      public int getUb17_ConditionCode3539Reps()
      Returns a count of the current number of repetitions of Condition Code (35-39) (UB1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertConditionCode3539

      public IS insertConditionCode3539(int rep) throws HL7Exception
      Inserts a repetition of UB1-7: "Condition Code (35-39)" 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)

    • insertUb17_ConditionCode3539

      public IS insertUb17_ConditionCode3539(int rep) throws HL7Exception
      Inserts a repetition of UB1-7: "Condition Code (35-39)" 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)

    • removeConditionCode3539

      public IS removeConditionCode3539(int rep) throws HL7Exception
      Removes a repetition of UB1-7: "Condition Code (35-39)" 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)

    • removeUb17_ConditionCode3539

      public IS removeUb17_ConditionCode3539(int rep) throws HL7Exception
      Removes a repetition of UB1-7: "Condition Code (35-39)" 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)

    • getCoveredDays

      public NM getCoveredDays()
      Returns UB1-8: "Covered Days - (23)" - creates it if necessary

    • getUb18_CoveredDays

      public NM getUb18_CoveredDays()
      Returns UB1-8: "Covered Days - (23)" - creates it if necessary

    • getNonCoveredDays

      public NM getNonCoveredDays()
      Returns UB1-9: "Non Covered Days - (24)" - creates it if necessary

    • getUb19_NonCoveredDays

      public NM getUb19_NonCoveredDays()
      Returns UB1-9: "Non Covered Days - (24)" - creates it if necessary

    • getValueAmountCode4649

      public UVC[] getValueAmountCode4649()
      Returns all repetitions of Value Amount & Code (46-49) (UB1-10).

    • getUb110_ValueAmountCode4649

      public UVC[] getUb110_ValueAmountCode4649()
      Returns all repetitions of Value Amount & Code (46-49) (UB1-10).

    • getValueAmountCode4649Reps

      public int getValueAmountCode4649Reps()
      Returns a count of the current number of repetitions of Value Amount & Code (46-49) (UB1-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getValueAmountCode4649

      public UVC getValueAmountCode4649(int rep)
      Returns a specific repetition of UB1-10: "Value Amount & Code (46-49)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb110_ValueAmountCode4649

      public UVC getUb110_ValueAmountCode4649(int rep)
      Returns a specific repetition of UB1-10: "Value Amount & Code (46-49)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb110_ValueAmountCode4649Reps

      public int getUb110_ValueAmountCode4649Reps()
      Returns a count of the current number of repetitions of Value Amount & Code (46-49) (UB1-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertValueAmountCode4649

      public UVC insertValueAmountCode4649(int rep) throws HL7Exception
      Inserts a repetition of UB1-10: "Value Amount & Code (46-49)" 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)

    • insertUb110_ValueAmountCode4649

      public UVC insertUb110_ValueAmountCode4649(int rep) throws HL7Exception
      Inserts a repetition of UB1-10: "Value Amount & Code (46-49)" 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)

    • removeValueAmountCode4649

      public UVC removeValueAmountCode4649(int rep) throws HL7Exception
      Removes a repetition of UB1-10: "Value Amount & Code (46-49)" 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)

    • removeUb110_ValueAmountCode4649

      public UVC removeUb110_ValueAmountCode4649(int rep) throws HL7Exception
      Removes a repetition of UB1-10: "Value Amount & Code (46-49)" 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)

    • getNumberOfGraceDays

      public NM getNumberOfGraceDays()
      Returns UB1-11: "Number Of Grace Days (90)" - creates it if necessary

    • getUb111_NumberOfGraceDays

      public NM getUb111_NumberOfGraceDays()
      Returns UB1-11: "Number Of Grace Days (90)" - creates it if necessary

    • getSpecialProgramIndicator

      public CE getSpecialProgramIndicator()
      Returns UB1-12: "Special Program Indicator (44)" - creates it if necessary

    • getUb112_SpecialProgramIndicator

      public CE getUb112_SpecialProgramIndicator()
      Returns UB1-12: "Special Program Indicator (44)" - creates it if necessary

    • getPSROURApprovalIndicator

      public CE getPSROURApprovalIndicator()
      Returns UB1-13: "PSRO/UR Approval Indicator (87)" - creates it if necessary

    • getUb113_PSROURApprovalIndicator

      public CE getUb113_PSROURApprovalIndicator()
      Returns UB1-13: "PSRO/UR Approval Indicator (87)" - creates it if necessary

    • getPSROURApprovedStayFm

      public DT getPSROURApprovedStayFm()
      Returns UB1-14: "PSRO/UR Approved Stay-Fm (88)" - creates it if necessary

    • getUb114_PSROURApprovedStayFm

      public DT getUb114_PSROURApprovedStayFm()
      Returns UB1-14: "PSRO/UR Approved Stay-Fm (88)" - creates it if necessary

    • getPSROURApprovedStayTo

      public DT getPSROURApprovedStayTo()
      Returns UB1-15: "PSRO/UR Approved Stay-To (89)" - creates it if necessary

    • getUb115_PSROURApprovedStayTo

      public DT getUb115_PSROURApprovedStayTo()
      Returns UB1-15: "PSRO/UR Approved Stay-To (89)" - creates it if necessary

    • getOccurrence2832

      public OCD[] getOccurrence2832()
      Returns all repetitions of Occurrence (28-32) (UB1-16).

    • getUb116_Occurrence2832

      public OCD[] getUb116_Occurrence2832()
      Returns all repetitions of Occurrence (28-32) (UB1-16).

    • getOccurrence2832Reps

      public int getOccurrence2832Reps()
      Returns a count of the current number of repetitions of Occurrence (28-32) (UB1-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getOccurrence2832

      public OCD getOccurrence2832(int rep)
      Returns a specific repetition of UB1-16: "Occurrence (28-32)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb116_Occurrence2832

      public OCD getUb116_Occurrence2832(int rep)
      Returns a specific repetition of UB1-16: "Occurrence (28-32)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getUb116_Occurrence2832Reps

      public int getUb116_Occurrence2832Reps()
      Returns a count of the current number of repetitions of Occurrence (28-32) (UB1-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertOccurrence2832

      public OCD insertOccurrence2832(int rep) throws HL7Exception
      Inserts a repetition of UB1-16: "Occurrence (28-32)" 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)

    • insertUb116_Occurrence2832

      public OCD insertUb116_Occurrence2832(int rep) throws HL7Exception
      Inserts a repetition of UB1-16: "Occurrence (28-32)" 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)

    • removeOccurrence2832

      public OCD removeOccurrence2832(int rep) throws HL7Exception
      Removes a repetition of UB1-16: "Occurrence (28-32)" 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)

    • removeUb116_Occurrence2832

      public OCD removeUb116_Occurrence2832(int rep) throws HL7Exception
      Removes a repetition of UB1-16: "Occurrence (28-32)" 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)

    • getOccurrenceSpan

      public CE getOccurrenceSpan()
      Returns UB1-17: "Occurrence Span (33)" - creates it if necessary

    • getUb117_OccurrenceSpan

      public CE getUb117_OccurrenceSpan()
      Returns UB1-17: "Occurrence Span (33)" - creates it if necessary

    • getOccurSpanStartDate

      public DT getOccurSpanStartDate()
      Returns UB1-18: "Occur Span Start Date(33)" - creates it if necessary

    • getUb118_OccurSpanStartDate

      public DT getUb118_OccurSpanStartDate()
      Returns UB1-18: "Occur Span Start Date(33)" - creates it if necessary

    • getOccurSpanEndDate

      public DT getOccurSpanEndDate()
      Returns UB1-19: "Occur Span End Date (33)" - creates it if necessary

    • getUb119_OccurSpanEndDate

      public DT getUb119_OccurSpanEndDate()
      Returns UB1-19: "Occur Span End Date (33)" - creates it if necessary

    • getUB82Locator2

      public ST getUB82Locator2()
      Returns UB1-20: "UB-82 Locator 2" - creates it if necessary

    • getUb120_UB82Locator2

      public ST getUb120_UB82Locator2()
      Returns UB1-20: "UB-82 Locator 2" - creates it if necessary

    • getUB82Locator9

      public ST getUB82Locator9()
      Returns UB1-21: "UB-82 Locator 9" - creates it if necessary

    • getUb121_UB82Locator9

      public ST getUb121_UB82Locator9()
      Returns UB1-21: "UB-82 Locator 9" - creates it if necessary

    • getUB82Locator27

      public ST getUB82Locator27()
      Returns UB1-22: "UB-82 Locator 27" - creates it if necessary

    • getUb122_UB82Locator27

      public ST getUb122_UB82Locator27()
      Returns UB1-22: "UB-82 Locator 27" - creates it if necessary

    • getUB82Locator45

      public ST getUB82Locator45()
      Returns UB1-23: "UB-82 Locator 45" - creates it if necessary

    • getUb123_UB82Locator45

      public ST getUb123_UB82Locator45()
      Returns UB1-23: "UB-82 Locator 45" - creates it if necessary

    • createNewTypeWithoutReflection

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