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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class GP1
extends AbstractSegment

Represents an HL7 GP1 message segment (Grouping/Reimbursement - Visit). This segment has the following fields:

• GP1-1: Type of Bill Code (IS)
• GP1-2: Revenue Code (IS) optional repeating
• GP1-3: Overall Claim Disposition Code (IS) optional
• GP1-4: OCE Edits per Visit Code (IS) optional repeating
• GP1-5: Outlier Cost (CP) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
IS	getGp11_TypeOfBillCode() Returns GP1-1: "Type of Bill Code" - creates it if necessary
IS	getGp12_RevenueCode(int rep) Returns a specific repetition of GP1-2: "Revenue Code" - creates it if necessary
int	getGp12_RevenueCodeReps() Returns a count of the current number of repetitions of Revenue Code (GP1-2).
IS	getGp13_OverallClaimDispositionCode() Returns GP1-3: "Overall Claim Disposition Code" - creates it if necessary
IS	getGp14_OCEEditsPerVisitCode(int rep) Returns a specific repetition of GP1-4: "OCE Edits per Visit Code" - creates it if necessary
int	getGp14_OCEEditsPerVisitCodeReps() Returns a count of the current number of repetitions of OCE Edits per Visit Code (GP1-4).
CP	getGp15_OutlierCost() Returns GP1-5: "Outlier Cost" - creates it if necessary
IS[]	getOCEEditsPerVisitCode() Returns all repetitions of OCE Edits per Visit Code (GP1-4).
IS	getOCEEditsPerVisitCode(int rep) Returns a specific repetition of GP1-4: "OCE Edits per Visit Code" - creates it if necessary
int	getOCEEditsPerVisitCodeReps() Returns a count of the current number of repetitions of OCE Edits per Visit Code (GP1-4).
CP	getOutlierCost() Returns GP1-5: "Outlier Cost" - creates it if necessary
IS	getOverallClaimDispositionCode() Returns GP1-3: "Overall Claim Disposition Code" - creates it if necessary
IS[]	getRevenueCode() Returns all repetitions of Revenue Code (GP1-2).
IS	getRevenueCode(int rep) Returns a specific repetition of GP1-2: "Revenue Code" - creates it if necessary
int	getRevenueCodeReps() Returns a count of the current number of repetitions of Revenue Code (GP1-2).
IS	getTypeOfBillCode() Returns GP1-1: "Type of Bill Code" - creates it if necessary
IS	insertGp12_RevenueCode(int rep) Inserts a repetition of GP1-2: "Revenue Code" at a specific index
IS	insertGp14_OCEEditsPerVisitCode(int rep) Inserts a repetition of GP1-4: "OCE Edits per Visit Code" at a specific index
IS	insertOCEEditsPerVisitCode(int rep) Inserts a repetition of GP1-4: "OCE Edits per Visit Code" at a specific index
IS	insertRevenueCode(int rep) Inserts a repetition of GP1-2: "Revenue Code" at a specific index
IS	removeGp12_RevenueCode(int rep) Removes a repetition of GP1-2: "Revenue Code" at a specific index
IS	removeGp14_OCEEditsPerVisitCode(int rep) Removes a repetition of GP1-4: "OCE Edits per Visit Code" at a specific index
IS	removeOCEEditsPerVisitCode(int rep) Removes a repetition of GP1-4: "OCE Edits per Visit Code" at a specific index
IS	removeRevenueCode(int rep) Removes a repetition of GP1-2: "Revenue 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

GP1

public GP1(Group parent,
           ModelClassFactory factory)

Creates a new GP1 segment

Method Detail

getTypeOfBillCode

public IS getTypeOfBillCode()

Returns GP1-1: "Type of Bill Code" - creates it if necessary

getGp11_TypeOfBillCode

public IS getGp11_TypeOfBillCode()

Returns GP1-1: "Type of Bill Code" - creates it if necessary

getRevenueCode

public IS[] getRevenueCode()

Returns all repetitions of Revenue Code (GP1-2).

getRevenueCodeReps

public int getRevenueCodeReps()

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

getRevenueCode

public IS getRevenueCode(int rep)

Returns a specific repetition of GP1-2: "Revenue Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getGp12_RevenueCode

public IS getGp12_RevenueCode(int rep)

Returns a specific repetition of GP1-2: "Revenue Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getGp12_RevenueCodeReps

public int getGp12_RevenueCodeReps()

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

insertRevenueCode

public IS insertRevenueCode(int rep)
                     throws HL7Exception

Inserts a repetition of GP1-2: "Revenue 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)

insertGp12_RevenueCode

public IS insertGp12_RevenueCode(int rep)
                          throws HL7Exception

Inserts a repetition of GP1-2: "Revenue 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)

removeRevenueCode

public IS removeRevenueCode(int rep)
                     throws HL7Exception

Removes a repetition of GP1-2: "Revenue 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)

removeGp12_RevenueCode

public IS removeGp12_RevenueCode(int rep)
                          throws HL7Exception

Removes a repetition of GP1-2: "Revenue 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)

getOverallClaimDispositionCode

public IS getOverallClaimDispositionCode()

Returns GP1-3: "Overall Claim Disposition Code" - creates it if necessary

getGp13_OverallClaimDispositionCode

public IS getGp13_OverallClaimDispositionCode()

Returns GP1-3: "Overall Claim Disposition Code" - creates it if necessary

getOCEEditsPerVisitCode

public IS[] getOCEEditsPerVisitCode()

Returns all repetitions of OCE Edits per Visit Code (GP1-4).

getOCEEditsPerVisitCodeReps

public int getOCEEditsPerVisitCodeReps()

Returns a count of the current number of repetitions of OCE Edits per Visit Code (GP1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOCEEditsPerVisitCode

public IS getOCEEditsPerVisitCode(int rep)

Returns a specific repetition of GP1-4: "OCE Edits per Visit Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getGp14_OCEEditsPerVisitCode

public IS getGp14_OCEEditsPerVisitCode(int rep)

Returns a specific repetition of GP1-4: "OCE Edits per Visit Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getGp14_OCEEditsPerVisitCodeReps

public int getGp14_OCEEditsPerVisitCodeReps()

Returns a count of the current number of repetitions of OCE Edits per Visit Code (GP1-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOCEEditsPerVisitCode

public IS insertOCEEditsPerVisitCode(int rep)
                              throws HL7Exception

Inserts a repetition of GP1-4: "OCE Edits per Visit 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)

insertGp14_OCEEditsPerVisitCode

public IS insertGp14_OCEEditsPerVisitCode(int rep)
                                   throws HL7Exception

Inserts a repetition of GP1-4: "OCE Edits per Visit 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)

removeOCEEditsPerVisitCode

public IS removeOCEEditsPerVisitCode(int rep)
                              throws HL7Exception

Removes a repetition of GP1-4: "OCE Edits per Visit 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)

removeGp14_OCEEditsPerVisitCode

public IS removeGp14_OCEEditsPerVisitCode(int rep)
                                   throws HL7Exception

Removes a repetition of GP1-4: "OCE Edits per Visit 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)

getOutlierCost

public CP getOutlierCost()

Returns GP1-5: "Outlier Cost" - creates it if necessary

getGp15_OutlierCost

public CP getGp15_OutlierCost()

Returns GP1-5: "Outlier Cost" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment