Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

ca.uhn.hl7v2.model.v24.segment
Class UB1

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

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

See Also:
Serialized Form

Constructor Summary
UB1(Group parent, ModelClassFactory factory)
          Creates a new UB1 segment
 
Method Summary
protected  Type createNewTypeWithoutReflection(int field)
          
 NM getBloodDeductible()
          Returns UB1-2: "Blood Deductible (43)" - creates it if necessary
 NM getBloodFurnishedPintsOf()
          Returns UB1-3: "Blood Furnished-Pints Of (40)" - creates it if necessary
 NM getBloodNotReplacedPints()
          Returns UB1-5: "Blood Not Replaced-Pints(42)" - creates it if necessary
 NM getBloodReplacedPints()
          Returns UB1-4: "Blood Replaced-Pints (41)" - creates it if necessary
 NM getCoInsuranceDays()
          Returns UB1-6: "Co-Insurance Days (25)" - creates it if necessary
 IS[] getConditionCode3539()
          Returns all repetitions of Condition Code (35-39) (UB1-7).
 IS getConditionCode3539(int rep)
          Returns a specific repetition of UB1-7: "Condition Code (35-39)" - creates it if necessary
 int getConditionCode3539Reps()
          Returns a count of the current number of repetitions of Condition Code (35-39) (UB1-7).
 NM getCoveredDays()
          Returns UB1-8: "Covered Days - (23)" - creates it if necessary
 NM getNonCoveredDays()
          Returns UB1-9: "Non Covered Days - (24)" - creates it if necessary
 NM getNumberOfGraceDays()
          Returns UB1-11: "Number Of Grace Days (90)" - creates it if necessary
 OCD[] getOccurrence2832()
          Returns all repetitions of Occurrence (28-32) (UB1-16).
 OCD getOccurrence2832(int rep)
          Returns a specific repetition of UB1-16: "Occurrence (28-32)" - creates it if necessary
 int getOccurrence2832Reps()
          Returns a count of the current number of repetitions of Occurrence (28-32) (UB1-16).
 CE getOccurrenceSpan()
          Returns UB1-17: "Occurrence Span (33)" - creates it if necessary
 DT getOccurSpanEndDate()
          Returns UB1-19: "Occur Span End Date (33)" - creates it if necessary
 DT getOccurSpanStartDate()
          Returns UB1-18: "Occur Span Start Date(33)" - creates it if necessary
 CE getPSROURApprovalIndicator()
          Returns UB1-13: "PSRO/UR Approval Indicator (87)" - creates it if necessary
 DT getPSROURApprovedStayFm()
          Returns UB1-14: "PSRO/UR Approved Stay-Fm (88)" - creates it if necessary
 DT getPSROURApprovedStayTo()
          Returns UB1-15: "PSRO/UR Approved Stay-To (89)" - creates it if necessary
 SI getSetIDUB1()
          Returns UB1-1: "Set ID - UB1" - creates it if necessary
 CE getSpecialProgramIndicator()
          Returns UB1-12: "Special Program Indicator (44)" - creates it if necessary
 SI getUb11_SetIDUB1()
          Returns UB1-1: "Set ID - UB1" - creates it if necessary
 UVC getUb110_ValueAmountCode4649(int rep)
          Returns a specific repetition of UB1-10: "Value Amount & Code (46-49)" - creates it if necessary
 int getUb110_ValueAmountCode4649Reps()
          Returns a count of the current number of repetitions of Value Amount & Code (46-49) (UB1-10).
 NM getUb111_NumberOfGraceDays()
          Returns UB1-11: "Number Of Grace Days (90)" - creates it if necessary
 CE getUb112_SpecialProgramIndicator()
          Returns UB1-12: "Special Program Indicator (44)" - creates it if necessary
 CE getUb113_PSROURApprovalIndicator()
          Returns UB1-13: "PSRO/UR Approval Indicator (87)" - creates it if necessary
 DT getUb114_PSROURApprovedStayFm()
          Returns UB1-14: "PSRO/UR Approved Stay-Fm (88)" - creates it if necessary
 DT getUb115_PSROURApprovedStayTo()
          Returns UB1-15: "PSRO/UR Approved Stay-To (89)" - creates it if necessary
 OCD getUb116_Occurrence2832(int rep)
          Returns a specific repetition of UB1-16: "Occurrence (28-32)" - creates it if necessary
 int getUb116_Occurrence2832Reps()
          Returns a count of the current number of repetitions of Occurrence (28-32) (UB1-16).
 CE getUb117_OccurrenceSpan()
          Returns UB1-17: "Occurrence Span (33)" - creates it if necessary
 DT getUb118_OccurSpanStartDate()
          Returns UB1-18: "Occur Span Start Date(33)" - creates it if necessary
 DT getUb119_OccurSpanEndDate()
          Returns UB1-19: "Occur Span End Date (33)" - creates it if necessary
 NM getUb12_BloodDeductible()
          Returns UB1-2: "Blood Deductible (43)" - creates it if necessary
 ST getUb120_UB82Locator2()
          Returns UB1-20: "UB-82 Locator 2" - creates it if necessary
 ST getUb121_UB82Locator9()
          Returns UB1-21: "UB-82 Locator 9" - creates it if necessary
 ST getUb122_UB82Locator27()
          Returns UB1-22: "UB-82 Locator 27" - creates it if necessary
 ST getUb123_UB82Locator45()
          Returns UB1-23: "UB-82 Locator 45" - creates it if necessary
 NM getUb13_BloodFurnishedPintsOf()
          Returns UB1-3: "Blood Furnished-Pints Of (40)" - creates it if necessary
 NM getUb14_BloodReplacedPints()
          Returns UB1-4: "Blood Replaced-Pints (41)" - creates it if necessary
 NM getUb15_BloodNotReplacedPints()
          Returns UB1-5: "Blood Not Replaced-Pints(42)" - creates it if necessary
 NM getUb16_CoInsuranceDays()
          Returns UB1-6: "Co-Insurance Days (25)" - creates it if necessary
 IS getUb17_ConditionCode3539(int rep)
          Returns a specific repetition of UB1-7: "Condition Code (35-39)" - creates it if necessary
 int getUb17_ConditionCode3539Reps()
          Returns a count of the current number of repetitions of Condition Code (35-39) (UB1-7).
 NM getUb18_CoveredDays()
          Returns UB1-8: "Covered Days - (23)" - creates it if necessary
 NM getUb19_NonCoveredDays()
          Returns UB1-9: "Non Covered Days - (24)" - creates it if necessary
 ST getUB82Locator2()
          Returns UB1-20: "UB-82 Locator 2" - creates it if necessary
 ST getUB82Locator27()
          Returns UB1-22: "UB-82 Locator 27" - creates it if necessary
 ST getUB82Locator45()
          Returns UB1-23: "UB-82 Locator 45" - creates it if necessary
 ST getUB82Locator9()
          Returns UB1-21: "UB-82 Locator 9" - creates it if necessary
 UVC[] getValueAmountCode4649()
          Returns all repetitions of Value Amount & Code (46-49) (UB1-10).
 UVC getValueAmountCode4649(int rep)
          Returns a specific repetition of UB1-10: "Value Amount & Code (46-49)" - creates it if necessary
 int getValueAmountCode4649Reps()
          Returns a count of the current number of repetitions of Value Amount & Code (46-49) (UB1-10).
 IS insertConditionCode3539(int rep)
          Inserts a repetition of UB1-7: "Condition Code (35-39)" at a specific index
 OCD insertOccurrence2832(int rep)
          Inserts a repetition of UB1-16: "Occurrence (28-32)" at a specific index
 UVC insertUb110_ValueAmountCode4649(int rep)
          Inserts a repetition of UB1-10: "Value Amount & Code (46-49)" at a specific index
 OCD insertUb116_Occurrence2832(int rep)
          Inserts a repetition of UB1-16: "Occurrence (28-32)" at a specific index
 IS insertUb17_ConditionCode3539(int rep)
          Inserts a repetition of UB1-7: "Condition Code (35-39)" at a specific index
 UVC insertValueAmountCode4649(int rep)
          Inserts a repetition of UB1-10: "Value Amount & Code (46-49)" at a specific index
 IS removeConditionCode3539(int rep)
          Removes a repetition of UB1-7: "Condition Code (35-39)" at a specific index
 OCD removeOccurrence2832(int rep)
          Removes a repetition of UB1-16: "Occurrence (28-32)" at a specific index
 UVC removeUb110_ValueAmountCode4649(int rep)
          Removes a repetition of UB1-10: "Value Amount & Code (46-49)" at a specific index
 OCD removeUb116_Occurrence2832(int rep)
          Removes a repetition of UB1-16: "Occurrence (28-32)" at a specific index
 IS removeUb17_ConditionCode3539(int rep)
          Removes a repetition of UB1-7: "Condition Code (35-39)" at a specific index
 UVC removeValueAmountCode4649(int rep)
          Removes a repetition of UB1-10: "Value Amount & Code (46-49)" at a specific index
 
Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UB1

public UB1(Group parent,
           ModelClassFactory factory)
Creates a new UB1 segment

Method Detail

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).

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).

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).

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2011 University Health Network. All Rights Reserved.