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

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.UB2

All Implemented Interfaces:

Segment, Structure, Serializable

public class UB2
extends AbstractSegment

Represents an HL7 UB2 message segment (UB92 Data). This segment has the following fields:

• UB2-1: Set ID - UB2 (SI) optional
• UB2-2: Co-Insurance Days (9) (ST) optional
• UB2-3: Condition Code (24-30) (IS) optional repeating
• UB2-4: Covered Days (7) (ST) optional
• UB2-5: Non-Covered Days (8) (ST) optional
• UB2-6: Value Amount & Code (UVC) optional repeating
• UB2-7: Occurrence Code & Date (32-35) (OCD) optional repeating
• UB2-8: Occurrence Span Code/Dates (36) (OSP) optional repeating
• UB2-9: UB92 Locator 2 (State) (ST) optional repeating
• UB2-10: UB92 Locator 11 (State) (ST) optional repeating
• UB2-11: UB92 Locator 31 (National) (ST) optional
• UB2-12: Document Control Number (ST) optional repeating
• UB2-13: UB92 Locator 49 (National) (ST) optional repeating
• UB2-14: UB92 Locator 56 (State) (ST) optional repeating
• UB2-15: UB92 Locator 57 (National) (ST) optional
• UB2-16: UB92 Locator 78 (State) (ST) optional repeating
• UB2-17: Special Visit Count (NM) optional

See Also:

Serialized Form

Constructor Summary

UB2(Group parent, ModelClassFactory factory)
Creates a new UB2 segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getCoInsuranceDays9() Returns UB2-2: "Co-Insurance Days (9)" - creates it if necessary
IS[]	getConditionCode2430() Returns all repetitions of Condition Code (24-30) (UB2-3).
IS	getConditionCode2430(int rep) Returns a specific repetition of UB2-3: "Condition Code (24-30)" - creates it if necessary
int	getConditionCode2430Reps() Returns a count of the current number of repetitions of Condition Code (24-30) (UB2-3).
ST	getCoveredDays7() Returns UB2-4: "Covered Days (7)" - creates it if necessary
ST[]	getDocumentControlNumber() Returns all repetitions of Document Control Number (UB2-12).
ST	getDocumentControlNumber(int rep) Returns a specific repetition of UB2-12: "Document Control Number" - creates it if necessary
int	getDocumentControlNumberReps() Returns a count of the current number of repetitions of Document Control Number (UB2-12).
ST	getNonCoveredDays8() Returns UB2-5: "Non-Covered Days (8)" - creates it if necessary
OCD[]	getOccurrenceCodeDate3235() Returns all repetitions of Occurrence Code & Date (32-35) (UB2-7).
OCD	getOccurrenceCodeDate3235(int rep) Returns a specific repetition of UB2-7: "Occurrence Code & Date (32-35)" - creates it if necessary
int	getOccurrenceCodeDate3235Reps() Returns a count of the current number of repetitions of Occurrence Code & Date (32-35) (UB2-7).
OSP[]	getOccurrenceSpanCodeDates() Returns all repetitions of Occurrence Span Code/Dates (36) (UB2-8).
OSP	getOccurrenceSpanCodeDates(int rep) Returns a specific repetition of UB2-8: "Occurrence Span Code/Dates (36)" - creates it if necessary
int	getOccurrenceSpanCodeDatesReps() Returns a count of the current number of repetitions of Occurrence Span Code/Dates (36) (UB2-8).
SI	getSetIDUB2() Returns UB2-1: "Set ID - UB2" - creates it if necessary
NM	getSpecialVisitCount() Returns UB2-17: "Special Visit Count" - creates it if necessary
SI	getUb21_SetIDUB2() Returns UB2-1: "Set ID - UB2" - creates it if necessary
ST	getUb210_UB92Locator11State(int rep) Returns a specific repetition of UB2-10: "UB92 Locator 11 (State)" - creates it if necessary
int	getUb210_UB92Locator11StateReps() Returns a count of the current number of repetitions of UB92 Locator 11 (State) (UB2-10).
ST	getUb211_UB92Locator31National() Returns UB2-11: "UB92 Locator 31 (National)" - creates it if necessary
ST	getUb212_DocumentControlNumber(int rep) Returns a specific repetition of UB2-12: "Document Control Number" - creates it if necessary
int	getUb212_DocumentControlNumberReps() Returns a count of the current number of repetitions of Document Control Number (UB2-12).
ST	getUb213_UB92Locator49National(int rep) Returns a specific repetition of UB2-13: "UB92 Locator 49 (National)" - creates it if necessary
int	getUb213_UB92Locator49NationalReps() Returns a count of the current number of repetitions of UB92 Locator 49 (National) (UB2-13).
ST	getUb214_UB92Locator56State(int rep) Returns a specific repetition of UB2-14: "UB92 Locator 56 (State)" - creates it if necessary
int	getUb214_UB92Locator56StateReps() Returns a count of the current number of repetitions of UB92 Locator 56 (State) (UB2-14).
ST	getUb215_UB92Locator57National() Returns UB2-15: "UB92 Locator 57 (National)" - creates it if necessary
ST	getUb216_UB92Locator78State(int rep) Returns a specific repetition of UB2-16: "UB92 Locator 78 (State)" - creates it if necessary
int	getUb216_UB92Locator78StateReps() Returns a count of the current number of repetitions of UB92 Locator 78 (State) (UB2-16).
NM	getUb217_SpecialVisitCount() Returns UB2-17: "Special Visit Count" - creates it if necessary
ST	getUb22_CoInsuranceDays9() Returns UB2-2: "Co-Insurance Days (9)" - creates it if necessary
IS	getUb23_ConditionCode2430(int rep) Returns a specific repetition of UB2-3: "Condition Code (24-30)" - creates it if necessary
int	getUb23_ConditionCode2430Reps() Returns a count of the current number of repetitions of Condition Code (24-30) (UB2-3).
ST	getUb24_CoveredDays7() Returns UB2-4: "Covered Days (7)" - creates it if necessary
ST	getUb25_NonCoveredDays8() Returns UB2-5: "Non-Covered Days (8)" - creates it if necessary
UVC	getUb26_ValueAmountCode(int rep) Returns a specific repetition of UB2-6: "Value Amount & Code" - creates it if necessary
int	getUb26_ValueAmountCodeReps() Returns a count of the current number of repetitions of Value Amount & Code (UB2-6).
OCD	getUb27_OccurrenceCodeDate3235(int rep) Returns a specific repetition of UB2-7: "Occurrence Code & Date (32-35)" - creates it if necessary
int	getUb27_OccurrenceCodeDate3235Reps() Returns a count of the current number of repetitions of Occurrence Code & Date (32-35) (UB2-7).
OSP	getUb28_OccurrenceSpanCodeDates(int rep) Returns a specific repetition of UB2-8: "Occurrence Span Code/Dates (36)" - creates it if necessary
int	getUb28_OccurrenceSpanCodeDatesReps() Returns a count of the current number of repetitions of Occurrence Span Code/Dates (36) (UB2-8).
ST	getUb29_UB92Locator2State(int rep) Returns a specific repetition of UB2-9: "UB92 Locator 2 (State)" - creates it if necessary
int	getUb29_UB92Locator2StateReps() Returns a count of the current number of repetitions of UB92 Locator 2 (State) (UB2-9).
ST[]	getUB92Locator11State() Returns all repetitions of UB92 Locator 11 (State) (UB2-10).
ST	getUB92Locator11State(int rep) Returns a specific repetition of UB2-10: "UB92 Locator 11 (State)" - creates it if necessary
int	getUB92Locator11StateReps() Returns a count of the current number of repetitions of UB92 Locator 11 (State) (UB2-10).
ST[]	getUB92Locator2State() Returns all repetitions of UB92 Locator 2 (State) (UB2-9).
ST	getUB92Locator2State(int rep) Returns a specific repetition of UB2-9: "UB92 Locator 2 (State)" - creates it if necessary
int	getUB92Locator2StateReps() Returns a count of the current number of repetitions of UB92 Locator 2 (State) (UB2-9).
ST	getUB92Locator31National() Returns UB2-11: "UB92 Locator 31 (National)" - creates it if necessary
ST[]	getUB92Locator49National() Returns all repetitions of UB92 Locator 49 (National) (UB2-13).
ST	getUB92Locator49National(int rep) Returns a specific repetition of UB2-13: "UB92 Locator 49 (National)" - creates it if necessary
int	getUB92Locator49NationalReps() Returns a count of the current number of repetitions of UB92 Locator 49 (National) (UB2-13).
ST[]	getUB92Locator56State() Returns all repetitions of UB92 Locator 56 (State) (UB2-14).
ST	getUB92Locator56State(int rep) Returns a specific repetition of UB2-14: "UB92 Locator 56 (State)" - creates it if necessary
int	getUB92Locator56StateReps() Returns a count of the current number of repetitions of UB92 Locator 56 (State) (UB2-14).
ST	getUB92Locator57National() Returns UB2-15: "UB92 Locator 57 (National)" - creates it if necessary
ST[]	getUB92Locator78State() Returns all repetitions of UB92 Locator 78 (State) (UB2-16).
ST	getUB92Locator78State(int rep) Returns a specific repetition of UB2-16: "UB92 Locator 78 (State)" - creates it if necessary
int	getUB92Locator78StateReps() Returns a count of the current number of repetitions of UB92 Locator 78 (State) (UB2-16).
UVC[]	getValueAmountCode() Returns all repetitions of Value Amount & Code (UB2-6).
UVC	getValueAmountCode(int rep) Returns a specific repetition of UB2-6: "Value Amount & Code" - creates it if necessary
int	getValueAmountCodeReps() Returns a count of the current number of repetitions of Value Amount & Code (UB2-6).
IS	insertConditionCode2430(int rep) Inserts a repetition of UB2-3: "Condition Code (24-30)" at a specific index
ST	insertDocumentControlNumber(int rep) Inserts a repetition of UB2-12: "Document Control Number" at a specific index
OCD	insertOccurrenceCodeDate3235(int rep) Inserts a repetition of UB2-7: "Occurrence Code & Date (32-35)" at a specific index
OSP	insertOccurrenceSpanCodeDates(int rep) Inserts a repetition of UB2-8: "Occurrence Span Code/Dates (36)" at a specific index
ST	insertUb210_UB92Locator11State(int rep) Inserts a repetition of UB2-10: "UB92 Locator 11 (State)" at a specific index
ST	insertUb212_DocumentControlNumber(int rep) Inserts a repetition of UB2-12: "Document Control Number" at a specific index
ST	insertUb213_UB92Locator49National(int rep) Inserts a repetition of UB2-13: "UB92 Locator 49 (National)" at a specific index
ST	insertUb214_UB92Locator56State(int rep) Inserts a repetition of UB2-14: "UB92 Locator 56 (State)" at a specific index
ST	insertUb216_UB92Locator78State(int rep) Inserts a repetition of UB2-16: "UB92 Locator 78 (State)" at a specific index
IS	insertUb23_ConditionCode2430(int rep) Inserts a repetition of UB2-3: "Condition Code (24-30)" at a specific index
UVC	insertUb26_ValueAmountCode(int rep) Inserts a repetition of UB2-6: "Value Amount & Code" at a specific index
OCD	insertUb27_OccurrenceCodeDate3235(int rep) Inserts a repetition of UB2-7: "Occurrence Code & Date (32-35)" at a specific index
OSP	insertUb28_OccurrenceSpanCodeDates(int rep) Inserts a repetition of UB2-8: "Occurrence Span Code/Dates (36)" at a specific index
ST	insertUb29_UB92Locator2State(int rep) Inserts a repetition of UB2-9: "UB92 Locator 2 (State)" at a specific index
ST	insertUB92Locator11State(int rep) Inserts a repetition of UB2-10: "UB92 Locator 11 (State)" at a specific index
ST	insertUB92Locator2State(int rep) Inserts a repetition of UB2-9: "UB92 Locator 2 (State)" at a specific index
ST	insertUB92Locator49National(int rep) Inserts a repetition of UB2-13: "UB92 Locator 49 (National)" at a specific index
ST	insertUB92Locator56State(int rep) Inserts a repetition of UB2-14: "UB92 Locator 56 (State)" at a specific index
ST	insertUB92Locator78State(int rep) Inserts a repetition of UB2-16: "UB92 Locator 78 (State)" at a specific index
UVC	insertValueAmountCode(int rep) Inserts a repetition of UB2-6: "Value Amount & Code" at a specific index
IS	removeConditionCode2430(int rep) Removes a repetition of UB2-3: "Condition Code (24-30)" at a specific index
ST	removeDocumentControlNumber(int rep) Removes a repetition of UB2-12: "Document Control Number" at a specific index
OCD	removeOccurrenceCodeDate3235(int rep) Removes a repetition of UB2-7: "Occurrence Code & Date (32-35)" at a specific index
OSP	removeOccurrenceSpanCodeDates(int rep) Removes a repetition of UB2-8: "Occurrence Span Code/Dates (36)" at a specific index
ST	removeUb210_UB92Locator11State(int rep) Removes a repetition of UB2-10: "UB92 Locator 11 (State)" at a specific index
ST	removeUb212_DocumentControlNumber(int rep) Removes a repetition of UB2-12: "Document Control Number" at a specific index
ST	removeUb213_UB92Locator49National(int rep) Removes a repetition of UB2-13: "UB92 Locator 49 (National)" at a specific index
ST	removeUb214_UB92Locator56State(int rep) Removes a repetition of UB2-14: "UB92 Locator 56 (State)" at a specific index
ST	removeUb216_UB92Locator78State(int rep) Removes a repetition of UB2-16: "UB92 Locator 78 (State)" at a specific index
IS	removeUb23_ConditionCode2430(int rep) Removes a repetition of UB2-3: "Condition Code (24-30)" at a specific index
UVC	removeUb26_ValueAmountCode(int rep) Removes a repetition of UB2-6: "Value Amount & Code" at a specific index
OCD	removeUb27_OccurrenceCodeDate3235(int rep) Removes a repetition of UB2-7: "Occurrence Code & Date (32-35)" at a specific index
OSP	removeUb28_OccurrenceSpanCodeDates(int rep) Removes a repetition of UB2-8: "Occurrence Span Code/Dates (36)" at a specific index
ST	removeUb29_UB92Locator2State(int rep) Removes a repetition of UB2-9: "UB92 Locator 2 (State)" at a specific index
ST	removeUB92Locator11State(int rep) Removes a repetition of UB2-10: "UB92 Locator 11 (State)" at a specific index
ST	removeUB92Locator2State(int rep) Removes a repetition of UB2-9: "UB92 Locator 2 (State)" at a specific index
ST	removeUB92Locator49National(int rep) Removes a repetition of UB2-13: "UB92 Locator 49 (National)" at a specific index
ST	removeUB92Locator56State(int rep) Removes a repetition of UB2-14: "UB92 Locator 56 (State)" at a specific index
ST	removeUB92Locator78State(int rep) Removes a repetition of UB2-16: "UB92 Locator 78 (State)" at a specific index
UVC	removeValueAmountCode(int rep) Removes a repetition of UB2-6: "Value Amount & Code" 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

UB2

public UB2(Group parent,
           ModelClassFactory factory)

Creates a new UB2 segment

Method Detail

getSetIDUB2

public SI getSetIDUB2()

Returns UB2-1: "Set ID - UB2" - creates it if necessary

getUb21_SetIDUB2

public SI getUb21_SetIDUB2()

Returns UB2-1: "Set ID - UB2" - creates it if necessary

getCoInsuranceDays9

public ST getCoInsuranceDays9()

Returns UB2-2: "Co-Insurance Days (9)" - creates it if necessary

getUb22_CoInsuranceDays9

public ST getUb22_CoInsuranceDays9()

Returns UB2-2: "Co-Insurance Days (9)" - creates it if necessary

getConditionCode2430

public IS[] getConditionCode2430()

Returns all repetitions of Condition Code (24-30) (UB2-3).

getConditionCode2430Reps

public int getConditionCode2430Reps()

Returns a count of the current number of repetitions of Condition Code (24-30) (UB2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getConditionCode2430

public IS getConditionCode2430(int rep)

Returns a specific repetition of UB2-3: "Condition Code (24-30)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb23_ConditionCode2430

public IS getUb23_ConditionCode2430(int rep)

Returns a specific repetition of UB2-3: "Condition Code (24-30)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb23_ConditionCode2430Reps

public int getUb23_ConditionCode2430Reps()

Returns a count of the current number of repetitions of Condition Code (24-30) (UB2-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertConditionCode2430

public IS insertConditionCode2430(int rep)
                           throws HL7Exception

Inserts a repetition of UB2-3: "Condition Code (24-30)" 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)

insertUb23_ConditionCode2430

public IS insertUb23_ConditionCode2430(int rep)
                                throws HL7Exception

Inserts a repetition of UB2-3: "Condition Code (24-30)" 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)

removeConditionCode2430

public IS removeConditionCode2430(int rep)
                           throws HL7Exception

Removes a repetition of UB2-3: "Condition Code (24-30)" 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)

removeUb23_ConditionCode2430

public IS removeUb23_ConditionCode2430(int rep)
                                throws HL7Exception

Removes a repetition of UB2-3: "Condition Code (24-30)" 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)

getCoveredDays7

public ST getCoveredDays7()

Returns UB2-4: "Covered Days (7)" - creates it if necessary

getUb24_CoveredDays7

public ST getUb24_CoveredDays7()

Returns UB2-4: "Covered Days (7)" - creates it if necessary

getNonCoveredDays8

public ST getNonCoveredDays8()

Returns UB2-5: "Non-Covered Days (8)" - creates it if necessary

getUb25_NonCoveredDays8

public ST getUb25_NonCoveredDays8()

Returns UB2-5: "Non-Covered Days (8)" - creates it if necessary

getValueAmountCode

public UVC[] getValueAmountCode()

Returns all repetitions of Value Amount & Code (UB2-6).

getValueAmountCodeReps

public int getValueAmountCodeReps()

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

getValueAmountCode

public UVC getValueAmountCode(int rep)

Returns a specific repetition of UB2-6: "Value Amount & Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb26_ValueAmountCode

public UVC getUb26_ValueAmountCode(int rep)

Returns a specific repetition of UB2-6: "Value Amount & Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb26_ValueAmountCodeReps

public int getUb26_ValueAmountCodeReps()

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

insertValueAmountCode

public UVC insertValueAmountCode(int rep)
                          throws HL7Exception

Inserts a repetition of UB2-6: "Value Amount & Code" 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)

insertUb26_ValueAmountCode

public UVC insertUb26_ValueAmountCode(int rep)
                               throws HL7Exception

Inserts a repetition of UB2-6: "Value Amount & Code" 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)

removeValueAmountCode

public UVC removeValueAmountCode(int rep)
                          throws HL7Exception

Removes a repetition of UB2-6: "Value Amount & Code" 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)

removeUb26_ValueAmountCode

public UVC removeUb26_ValueAmountCode(int rep)
                               throws HL7Exception

Removes a repetition of UB2-6: "Value Amount & Code" 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)

getOccurrenceCodeDate3235

public OCD[] getOccurrenceCodeDate3235()

Returns all repetitions of Occurrence Code & Date (32-35) (UB2-7).

getOccurrenceCodeDate3235Reps

public int getOccurrenceCodeDate3235Reps()

Returns a count of the current number of repetitions of Occurrence Code & Date (32-35) (UB2-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOccurrenceCodeDate3235

public OCD getOccurrenceCodeDate3235(int rep)

Returns a specific repetition of UB2-7: "Occurrence Code & Date (32-35)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb27_OccurrenceCodeDate3235

public OCD getUb27_OccurrenceCodeDate3235(int rep)

Returns a specific repetition of UB2-7: "Occurrence Code & Date (32-35)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb27_OccurrenceCodeDate3235Reps

public int getUb27_OccurrenceCodeDate3235Reps()

Returns a count of the current number of repetitions of Occurrence Code & Date (32-35) (UB2-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOccurrenceCodeDate3235

public OCD insertOccurrenceCodeDate3235(int rep)
                                 throws HL7Exception

Inserts a repetition of UB2-7: "Occurrence Code & Date (32-35)" 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)

insertUb27_OccurrenceCodeDate3235

public OCD insertUb27_OccurrenceCodeDate3235(int rep)
                                      throws HL7Exception

Inserts a repetition of UB2-7: "Occurrence Code & Date (32-35)" 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)

removeOccurrenceCodeDate3235

public OCD removeOccurrenceCodeDate3235(int rep)
                                 throws HL7Exception

Removes a repetition of UB2-7: "Occurrence Code & Date (32-35)" 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)

removeUb27_OccurrenceCodeDate3235

public OCD removeUb27_OccurrenceCodeDate3235(int rep)
                                      throws HL7Exception

Removes a repetition of UB2-7: "Occurrence Code & Date (32-35)" 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)

getOccurrenceSpanCodeDates

public OSP[] getOccurrenceSpanCodeDates()

Returns all repetitions of Occurrence Span Code/Dates (36) (UB2-8).

getOccurrenceSpanCodeDatesReps

public int getOccurrenceSpanCodeDatesReps()

Returns a count of the current number of repetitions of Occurrence Span Code/Dates (36) (UB2-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOccurrenceSpanCodeDates

public OSP getOccurrenceSpanCodeDates(int rep)

Returns a specific repetition of UB2-8: "Occurrence Span Code/Dates (36)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb28_OccurrenceSpanCodeDates

public OSP getUb28_OccurrenceSpanCodeDates(int rep)

Returns a specific repetition of UB2-8: "Occurrence Span Code/Dates (36)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb28_OccurrenceSpanCodeDatesReps

public int getUb28_OccurrenceSpanCodeDatesReps()

Returns a count of the current number of repetitions of Occurrence Span Code/Dates (36) (UB2-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOccurrenceSpanCodeDates

public OSP insertOccurrenceSpanCodeDates(int rep)
                                  throws HL7Exception

Inserts a repetition of UB2-8: "Occurrence Span Code/Dates (36)" 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)

insertUb28_OccurrenceSpanCodeDates

public OSP insertUb28_OccurrenceSpanCodeDates(int rep)
                                       throws HL7Exception

Inserts a repetition of UB2-8: "Occurrence Span Code/Dates (36)" 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)

removeOccurrenceSpanCodeDates

public OSP removeOccurrenceSpanCodeDates(int rep)
                                  throws HL7Exception

Removes a repetition of UB2-8: "Occurrence Span Code/Dates (36)" 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)

removeUb28_OccurrenceSpanCodeDates

public OSP removeUb28_OccurrenceSpanCodeDates(int rep)
                                       throws HL7Exception

Removes a repetition of UB2-8: "Occurrence Span Code/Dates (36)" 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)

getUB92Locator2State

public ST[] getUB92Locator2State()

Returns all repetitions of UB92 Locator 2 (State) (UB2-9).

getUB92Locator2StateReps

public int getUB92Locator2StateReps()

Returns a count of the current number of repetitions of UB92 Locator 2 (State) (UB2-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getUB92Locator2State

public ST getUB92Locator2State(int rep)

Returns a specific repetition of UB2-9: "UB92 Locator 2 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb29_UB92Locator2State

public ST getUb29_UB92Locator2State(int rep)

Returns a specific repetition of UB2-9: "UB92 Locator 2 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb29_UB92Locator2StateReps

public int getUb29_UB92Locator2StateReps()

Returns a count of the current number of repetitions of UB92 Locator 2 (State) (UB2-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertUB92Locator2State

public ST insertUB92Locator2State(int rep)
                           throws HL7Exception

Inserts a repetition of UB2-9: "UB92 Locator 2 (State)" 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)

insertUb29_UB92Locator2State

public ST insertUb29_UB92Locator2State(int rep)
                                throws HL7Exception

Inserts a repetition of UB2-9: "UB92 Locator 2 (State)" 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)

removeUB92Locator2State

public ST removeUB92Locator2State(int rep)
                           throws HL7Exception

Removes a repetition of UB2-9: "UB92 Locator 2 (State)" 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)

removeUb29_UB92Locator2State

public ST removeUb29_UB92Locator2State(int rep)
                                throws HL7Exception

Removes a repetition of UB2-9: "UB92 Locator 2 (State)" 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)

getUB92Locator11State

public ST[] getUB92Locator11State()

Returns all repetitions of UB92 Locator 11 (State) (UB2-10).

getUB92Locator11StateReps

public int getUB92Locator11StateReps()

Returns a count of the current number of repetitions of UB92 Locator 11 (State) (UB2-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getUB92Locator11State

public ST getUB92Locator11State(int rep)

Returns a specific repetition of UB2-10: "UB92 Locator 11 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb210_UB92Locator11State

public ST getUb210_UB92Locator11State(int rep)

Returns a specific repetition of UB2-10: "UB92 Locator 11 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb210_UB92Locator11StateReps

public int getUb210_UB92Locator11StateReps()

Returns a count of the current number of repetitions of UB92 Locator 11 (State) (UB2-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertUB92Locator11State

public ST insertUB92Locator11State(int rep)
                            throws HL7Exception

Inserts a repetition of UB2-10: "UB92 Locator 11 (State)" 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)

insertUb210_UB92Locator11State

public ST insertUb210_UB92Locator11State(int rep)
                                  throws HL7Exception

Inserts a repetition of UB2-10: "UB92 Locator 11 (State)" 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)

removeUB92Locator11State

public ST removeUB92Locator11State(int rep)
                            throws HL7Exception

Removes a repetition of UB2-10: "UB92 Locator 11 (State)" 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)

removeUb210_UB92Locator11State

public ST removeUb210_UB92Locator11State(int rep)
                                  throws HL7Exception

Removes a repetition of UB2-10: "UB92 Locator 11 (State)" 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)

getUB92Locator31National

public ST getUB92Locator31National()

Returns UB2-11: "UB92 Locator 31 (National)" - creates it if necessary

getUb211_UB92Locator31National

public ST getUb211_UB92Locator31National()

Returns UB2-11: "UB92 Locator 31 (National)" - creates it if necessary

getDocumentControlNumber

public ST[] getDocumentControlNumber()

Returns all repetitions of Document Control Number (UB2-12).

getDocumentControlNumberReps

public int getDocumentControlNumberReps()

Returns a count of the current number of repetitions of Document Control Number (UB2-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getDocumentControlNumber

public ST getDocumentControlNumber(int rep)

Returns a specific repetition of UB2-12: "Document Control Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb212_DocumentControlNumber

public ST getUb212_DocumentControlNumber(int rep)

Returns a specific repetition of UB2-12: "Document Control Number" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb212_DocumentControlNumberReps

public int getUb212_DocumentControlNumberReps()

Returns a count of the current number of repetitions of Document Control Number (UB2-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertDocumentControlNumber

public ST insertDocumentControlNumber(int rep)
                               throws HL7Exception

Inserts a repetition of UB2-12: "Document Control 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)

insertUb212_DocumentControlNumber

public ST insertUb212_DocumentControlNumber(int rep)
                                     throws HL7Exception

Inserts a repetition of UB2-12: "Document Control 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)

removeDocumentControlNumber

public ST removeDocumentControlNumber(int rep)
                               throws HL7Exception

Removes a repetition of UB2-12: "Document Control 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)

removeUb212_DocumentControlNumber

public ST removeUb212_DocumentControlNumber(int rep)
                                     throws HL7Exception

Removes a repetition of UB2-12: "Document Control 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)

getUB92Locator49National

public ST[] getUB92Locator49National()

Returns all repetitions of UB92 Locator 49 (National) (UB2-13).

getUB92Locator49NationalReps

public int getUB92Locator49NationalReps()

Returns a count of the current number of repetitions of UB92 Locator 49 (National) (UB2-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getUB92Locator49National

public ST getUB92Locator49National(int rep)

Returns a specific repetition of UB2-13: "UB92 Locator 49 (National)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb213_UB92Locator49National

public ST getUb213_UB92Locator49National(int rep)

Returns a specific repetition of UB2-13: "UB92 Locator 49 (National)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb213_UB92Locator49NationalReps

public int getUb213_UB92Locator49NationalReps()

Returns a count of the current number of repetitions of UB92 Locator 49 (National) (UB2-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertUB92Locator49National

public ST insertUB92Locator49National(int rep)
                               throws HL7Exception

Inserts a repetition of UB2-13: "UB92 Locator 49 (National)" 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)

insertUb213_UB92Locator49National

public ST insertUb213_UB92Locator49National(int rep)
                                     throws HL7Exception

Inserts a repetition of UB2-13: "UB92 Locator 49 (National)" 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)

removeUB92Locator49National

public ST removeUB92Locator49National(int rep)
                               throws HL7Exception

Removes a repetition of UB2-13: "UB92 Locator 49 (National)" 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)

removeUb213_UB92Locator49National

public ST removeUb213_UB92Locator49National(int rep)
                                     throws HL7Exception

Removes a repetition of UB2-13: "UB92 Locator 49 (National)" 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)

getUB92Locator56State

public ST[] getUB92Locator56State()

Returns all repetitions of UB92 Locator 56 (State) (UB2-14).

getUB92Locator56StateReps

public int getUB92Locator56StateReps()

Returns a count of the current number of repetitions of UB92 Locator 56 (State) (UB2-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getUB92Locator56State

public ST getUB92Locator56State(int rep)

Returns a specific repetition of UB2-14: "UB92 Locator 56 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb214_UB92Locator56State

public ST getUb214_UB92Locator56State(int rep)

Returns a specific repetition of UB2-14: "UB92 Locator 56 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb214_UB92Locator56StateReps

public int getUb214_UB92Locator56StateReps()

Returns a count of the current number of repetitions of UB92 Locator 56 (State) (UB2-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertUB92Locator56State

public ST insertUB92Locator56State(int rep)
                            throws HL7Exception

Inserts a repetition of UB2-14: "UB92 Locator 56 (State)" 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)

insertUb214_UB92Locator56State

public ST insertUb214_UB92Locator56State(int rep)
                                  throws HL7Exception

Inserts a repetition of UB2-14: "UB92 Locator 56 (State)" 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)

removeUB92Locator56State

public ST removeUB92Locator56State(int rep)
                            throws HL7Exception

Removes a repetition of UB2-14: "UB92 Locator 56 (State)" 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)

removeUb214_UB92Locator56State

public ST removeUb214_UB92Locator56State(int rep)
                                  throws HL7Exception

Removes a repetition of UB2-14: "UB92 Locator 56 (State)" 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)

getUB92Locator57National

public ST getUB92Locator57National()

Returns UB2-15: "UB92 Locator 57 (National)" - creates it if necessary

getUb215_UB92Locator57National

public ST getUb215_UB92Locator57National()

Returns UB2-15: "UB92 Locator 57 (National)" - creates it if necessary

getUB92Locator78State

public ST[] getUB92Locator78State()

Returns all repetitions of UB92 Locator 78 (State) (UB2-16).

getUB92Locator78StateReps

public int getUB92Locator78StateReps()

Returns a count of the current number of repetitions of UB92 Locator 78 (State) (UB2-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getUB92Locator78State

public ST getUB92Locator78State(int rep)

Returns a specific repetition of UB2-16: "UB92 Locator 78 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb216_UB92Locator78State

public ST getUb216_UB92Locator78State(int rep)

Returns a specific repetition of UB2-16: "UB92 Locator 78 (State)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getUb216_UB92Locator78StateReps

public int getUb216_UB92Locator78StateReps()

Returns a count of the current number of repetitions of UB92 Locator 78 (State) (UB2-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertUB92Locator78State

public ST insertUB92Locator78State(int rep)
                            throws HL7Exception

Inserts a repetition of UB2-16: "UB92 Locator 78 (State)" 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)

insertUb216_UB92Locator78State

public ST insertUb216_UB92Locator78State(int rep)
                                  throws HL7Exception

Inserts a repetition of UB2-16: "UB92 Locator 78 (State)" 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)

removeUB92Locator78State

public ST removeUB92Locator78State(int rep)
                            throws HL7Exception

Removes a repetition of UB2-16: "UB92 Locator 78 (State)" 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)

removeUb216_UB92Locator78State

public ST removeUb216_UB92Locator78State(int rep)
                                  throws HL7Exception

Removes a repetition of UB2-16: "UB92 Locator 78 (State)" 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)

getSpecialVisitCount

public NM getSpecialVisitCount()

Returns UB2-17: "Special Visit Count" - creates it if necessary

getUb217_SpecialVisitCount

public NM getUb217_SpecialVisitCount()

Returns UB2-17: "Special Visit Count" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment