GP2 (HAPI - Java HL7 API - Generated Structures v2.4 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractSegment
  - - ca.uhn.hl7v2.model.v24.segment.GP2

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable
```
public class GP2
extends AbstractSegment
```
Represents an HL7 GP2 message segment (Grouping/Reimbursement - Procedure Line Item). This segment has the following fields:
- GP2-1: Revenue Code (IS) optional
- GP2-2: Number of Service Units (NM) optional
- GP2-3: Charge (CP) optional
- GP2-4: Reimbursement Action Code (IS) optional
- GP2-5: Denial or Rejection Code (IS) optional
- GP2-6: OCE Edit Code (IS) optional repeating
- GP2-7: Ambulatory Payment Classification Code (CE) optional
- GP2-8: Modifier Edit Code (IS) optional repeating
- GP2-9: Payment Adjustment Code (IS) optional
- GP2-10: Packaging Status Code (IS) optional
- GP2-11: Expected HCFA Payment Amount (CP) optional
- GP2-12: Reimbursement Type Code (IS) optional
- GP2-13: Co-Pay Amount (CP) optional
- GP2-14: Pay Rate per Unit (NM) optional
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`GP2(Group parent, ModelClassFactory factory)` Creates a new GP2 segment

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Type`	`createNewTypeWithoutReflection(int field)`
`CE`	`getAmbulatoryPaymentClassificationCode()` Returns GP2-7: "Ambulatory Payment Classification Code" - creates it if necessary
`CP`	`getCharge()` Returns GP2-3: "Charge" - creates it if necessary
`CP`	`getCoPayAmount()` Returns GP2-13: "Co-Pay Amount" - creates it if necessary
`IS`	`getDenialOrRejectionCode()` Returns GP2-5: "Denial or Rejection Code" - creates it if necessary
`CP`	`getExpectedHCFAPaymentAmount()` Returns GP2-11: "Expected HCFA Payment Amount" - creates it if necessary
`IS`	`getGp21_RevenueCode()` Returns GP2-1: "Revenue Code" - creates it if necessary
`IS`	`getGp210_PackagingStatusCode()` Returns GP2-10: "Packaging Status Code" - creates it if necessary
`CP`	`getGp211_ExpectedHCFAPaymentAmount()` Returns GP2-11: "Expected HCFA Payment Amount" - creates it if necessary
`IS`	`getGp212_ReimbursementTypeCode()` Returns GP2-12: "Reimbursement Type Code" - creates it if necessary
`CP`	`getGp213_CoPayAmount()` Returns GP2-13: "Co-Pay Amount" - creates it if necessary
`NM`	`getGp214_PayRatePerUnit()` Returns GP2-14: "Pay Rate per Unit" - creates it if necessary
`NM`	`getGp22_NumberOfServiceUnits()` Returns GP2-2: "Number of Service Units" - creates it if necessary
`CP`	`getGp23_Charge()` Returns GP2-3: "Charge" - creates it if necessary
`IS`	`getGp24_ReimbursementActionCode()` Returns GP2-4: "Reimbursement Action Code" - creates it if necessary
`IS`	`getGp25_DenialOrRejectionCode()` Returns GP2-5: "Denial or Rejection Code" - creates it if necessary
`IS[]`	`getGp26_OCEEditCode()` Returns all repetitions of OCE Edit Code (GP2-6).
`IS`	`getGp26_OCEEditCode(int rep)` Returns a specific repetition of GP2-6: "OCE Edit Code" - creates it if necessary
`int`	`getGp26_OCEEditCodeReps()` Returns a count of the current number of repetitions of OCE Edit Code (GP2-6).
`CE`	`getGp27_AmbulatoryPaymentClassificationCode()` Returns GP2-7: "Ambulatory Payment Classification Code" - creates it if necessary
`IS[]`	`getGp28_ModifierEditCode()` Returns all repetitions of Modifier Edit Code (GP2-8).
`IS`	`getGp28_ModifierEditCode(int rep)` Returns a specific repetition of GP2-8: "Modifier Edit Code" - creates it if necessary
`int`	`getGp28_ModifierEditCodeReps()` Returns a count of the current number of repetitions of Modifier Edit Code (GP2-8).
`IS`	`getGp29_PaymentAdjustmentCode()` Returns GP2-9: "Payment Adjustment Code" - creates it if necessary
`IS[]`	`getModifierEditCode()` Returns all repetitions of Modifier Edit Code (GP2-8).
`IS`	`getModifierEditCode(int rep)` Returns a specific repetition of GP2-8: "Modifier Edit Code" - creates it if necessary
`int`	`getModifierEditCodeReps()` Returns a count of the current number of repetitions of Modifier Edit Code (GP2-8).
`NM`	`getNumberOfServiceUnits()` Returns GP2-2: "Number of Service Units" - creates it if necessary
`IS[]`	`getOCEEditCode()` Returns all repetitions of OCE Edit Code (GP2-6).
`IS`	`getOCEEditCode(int rep)` Returns a specific repetition of GP2-6: "OCE Edit Code" - creates it if necessary
`int`	`getOCEEditCodeReps()` Returns a count of the current number of repetitions of OCE Edit Code (GP2-6).
`IS`	`getPackagingStatusCode()` Returns GP2-10: "Packaging Status Code" - creates it if necessary
`IS`	`getPaymentAdjustmentCode()` Returns GP2-9: "Payment Adjustment Code" - creates it if necessary
`NM`	`getPayRatePerUnit()` Returns GP2-14: "Pay Rate per Unit" - creates it if necessary
`IS`	`getReimbursementActionCode()` Returns GP2-4: "Reimbursement Action Code" - creates it if necessary
`IS`	`getReimbursementTypeCode()` Returns GP2-12: "Reimbursement Type Code" - creates it if necessary
`IS`	`getRevenueCode()` Returns GP2-1: "Revenue Code" - creates it if necessary
`IS`	`insertGp26_OCEEditCode(int rep)` Inserts a repetition of GP2-6: "OCE Edit Code" at a specific index
`IS`	`insertGp28_ModifierEditCode(int rep)` Inserts a repetition of GP2-8: "Modifier Edit Code" at a specific index
`IS`	`insertModifierEditCode(int rep)` Inserts a repetition of GP2-8: "Modifier Edit Code" at a specific index
`IS`	`insertOCEEditCode(int rep)` Inserts a repetition of GP2-6: "OCE Edit Code" at a specific index
`IS`	`removeGp26_OCEEditCode(int rep)` Removes a repetition of GP2-6: "OCE Edit Code" at a specific index
`IS`	`removeGp28_ModifierEditCode(int rep)` Removes a repetition of GP2-8: "Modifier Edit Code" at a specific index
`IS`	`removeModifierEditCode(int rep)` Removes a repetition of GP2-8: "Modifier Edit Code" at a specific index
`IS`	`removeOCEEditCode(int rep)` Removes a repetition of GP2-6: "OCE Edit Code" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure
getMessage, getParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getMessage, getParent

- Constructor Detail
  - GP2
```
public GP2(Group parent,
           ModelClassFactory factory)
```
    Creates a new GP2 segment
- Method Detail
  - getRevenueCode
```
public IS getRevenueCode()
```
    Returns GP2-1: "Revenue Code" - creates it if necessary
  - getGp21_RevenueCode
```
public IS getGp21_RevenueCode()
```
    Returns GP2-1: "Revenue Code" - creates it if necessary
  - getNumberOfServiceUnits
```
public NM getNumberOfServiceUnits()
```
    Returns GP2-2: "Number of Service Units" - creates it if necessary
  - getGp22_NumberOfServiceUnits
```
public NM getGp22_NumberOfServiceUnits()
```
    Returns GP2-2: "Number of Service Units" - creates it if necessary
  - getCharge
```
public CP getCharge()
```
    Returns GP2-3: "Charge" - creates it if necessary
  - getGp23_Charge
```
public CP getGp23_Charge()
```
    Returns GP2-3: "Charge" - creates it if necessary
  - getReimbursementActionCode
```
public IS getReimbursementActionCode()
```
    Returns GP2-4: "Reimbursement Action Code" - creates it if necessary
  - getGp24_ReimbursementActionCode
```
public IS getGp24_ReimbursementActionCode()
```
    Returns GP2-4: "Reimbursement Action Code" - creates it if necessary
  - getDenialOrRejectionCode
```
public IS getDenialOrRejectionCode()
```
    Returns GP2-5: "Denial or Rejection Code" - creates it if necessary
  - getGp25_DenialOrRejectionCode
```
public IS getGp25_DenialOrRejectionCode()
```
    Returns GP2-5: "Denial or Rejection Code" - creates it if necessary
  - getOCEEditCode
```
public IS[] getOCEEditCode()
```
    Returns all repetitions of OCE Edit Code (GP2-6).
  - getGp26_OCEEditCode
```
public IS[] getGp26_OCEEditCode()
```
    Returns all repetitions of OCE Edit Code (GP2-6).
  - getOCEEditCodeReps
```
public int getOCEEditCodeReps()
```
    Returns a count of the current number of repetitions of OCE Edit Code (GP2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getOCEEditCode
```
public IS getOCEEditCode(int rep)
```
    Returns a specific repetition of GP2-6: "OCE Edit Code" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getGp26_OCEEditCode
```
public IS getGp26_OCEEditCode(int rep)
```
    Returns a specific repetition of GP2-6: "OCE Edit Code" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getGp26_OCEEditCodeReps
```
public int getGp26_OCEEditCodeReps()
```
    Returns a count of the current number of repetitions of OCE Edit Code (GP2-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertOCEEditCode
```
public IS insertOCEEditCode(int rep)
                     throws HL7Exception
```
    Inserts a repetition of GP2-6: "OCE Edit 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)
  - insertGp26_OCEEditCode
```
public IS insertGp26_OCEEditCode(int rep)
                          throws HL7Exception
```
    Inserts a repetition of GP2-6: "OCE Edit 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)
  - removeOCEEditCode
```
public IS removeOCEEditCode(int rep)
                     throws HL7Exception
```
    Removes a repetition of GP2-6: "OCE Edit 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)
  - removeGp26_OCEEditCode
```
public IS removeGp26_OCEEditCode(int rep)
                          throws HL7Exception
```
    Removes a repetition of GP2-6: "OCE Edit 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)
  - getAmbulatoryPaymentClassificationCode
```
public CE getAmbulatoryPaymentClassificationCode()
```
    Returns GP2-7: "Ambulatory Payment Classification Code" - creates it if necessary
  - getGp27_AmbulatoryPaymentClassificationCode
```
public CE getGp27_AmbulatoryPaymentClassificationCode()
```
    Returns GP2-7: "Ambulatory Payment Classification Code" - creates it if necessary
  - getModifierEditCode
```
public IS[] getModifierEditCode()
```
    Returns all repetitions of Modifier Edit Code (GP2-8).
  - getGp28_ModifierEditCode
```
public IS[] getGp28_ModifierEditCode()
```
    Returns all repetitions of Modifier Edit Code (GP2-8).
  - getModifierEditCodeReps
```
public int getModifierEditCodeReps()
```
    Returns a count of the current number of repetitions of Modifier Edit Code (GP2-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getModifierEditCode
```
public IS getModifierEditCode(int rep)
```
    Returns a specific repetition of GP2-8: "Modifier Edit Code" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getGp28_ModifierEditCode
```
public IS getGp28_ModifierEditCode(int rep)
```
    Returns a specific repetition of GP2-8: "Modifier Edit Code" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getGp28_ModifierEditCodeReps
```
public int getGp28_ModifierEditCodeReps()
```
    Returns a count of the current number of repetitions of Modifier Edit Code (GP2-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertModifierEditCode
```
public IS insertModifierEditCode(int rep)
                          throws HL7Exception
```
    Inserts a repetition of GP2-8: "Modifier Edit 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)
  - insertGp28_ModifierEditCode
```
public IS insertGp28_ModifierEditCode(int rep)
                               throws HL7Exception
```
    Inserts a repetition of GP2-8: "Modifier Edit 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)
  - removeModifierEditCode
```
public IS removeModifierEditCode(int rep)
                          throws HL7Exception
```
    Removes a repetition of GP2-8: "Modifier Edit 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)
  - removeGp28_ModifierEditCode
```
public IS removeGp28_ModifierEditCode(int rep)
                               throws HL7Exception
```
    Removes a repetition of GP2-8: "Modifier Edit 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)
  - getPaymentAdjustmentCode
```
public IS getPaymentAdjustmentCode()
```
    Returns GP2-9: "Payment Adjustment Code" - creates it if necessary
  - getGp29_PaymentAdjustmentCode
```
public IS getGp29_PaymentAdjustmentCode()
```
    Returns GP2-9: "Payment Adjustment Code" - creates it if necessary
  - getPackagingStatusCode
```
public IS getPackagingStatusCode()
```
    Returns GP2-10: "Packaging Status Code" - creates it if necessary
  - getGp210_PackagingStatusCode
```
public IS getGp210_PackagingStatusCode()
```
    Returns GP2-10: "Packaging Status Code" - creates it if necessary
  - getExpectedHCFAPaymentAmount
```
public CP getExpectedHCFAPaymentAmount()
```
    Returns GP2-11: "Expected HCFA Payment Amount" - creates it if necessary
  - getGp211_ExpectedHCFAPaymentAmount
```
public CP getGp211_ExpectedHCFAPaymentAmount()
```
    Returns GP2-11: "Expected HCFA Payment Amount" - creates it if necessary
  - getReimbursementTypeCode
```
public IS getReimbursementTypeCode()
```
    Returns GP2-12: "Reimbursement Type Code" - creates it if necessary
  - getGp212_ReimbursementTypeCode
```
public IS getGp212_ReimbursementTypeCode()
```
    Returns GP2-12: "Reimbursement Type Code" - creates it if necessary
  - getCoPayAmount
```
public CP getCoPayAmount()
```
    Returns GP2-13: "Co-Pay Amount" - creates it if necessary
  - getGp213_CoPayAmount
```
public CP getGp213_CoPayAmount()
```
    Returns GP2-13: "Co-Pay Amount" - creates it if necessary
  - getPayRatePerUnit
```
public NM getPayRatePerUnit()
```
    Returns GP2-14: "Pay Rate per Unit" - creates it if necessary
  - getGp214_PayRatePerUnit
```
public NM getGp214_PayRatePerUnit()
```
    Returns GP2-14: "Pay Rate per Unit" - creates it if necessary
  - createNewTypeWithoutReflection
```
protected Type createNewTypeWithoutReflection(int field)
```
    Overrides:
    
    createNewTypeWithoutReflection in class AbstractSegment

Class GP2

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

GP2

Method Detail

getRevenueCode

getGp21_RevenueCode

getNumberOfServiceUnits

getGp22_NumberOfServiceUnits

getCharge

getGp23_Charge

getReimbursementActionCode

getGp24_ReimbursementActionCode

getDenialOrRejectionCode

getGp25_DenialOrRejectionCode

getOCEEditCode

getGp26_OCEEditCode

getOCEEditCodeReps

getOCEEditCode

getGp26_OCEEditCode

getGp26_OCEEditCodeReps

insertOCEEditCode

insertGp26_OCEEditCode

removeOCEEditCode

removeGp26_OCEEditCode

getAmbulatoryPaymentClassificationCode

getGp27_AmbulatoryPaymentClassificationCode

getModifierEditCode

getGp28_ModifierEditCode

getModifierEditCodeReps

getModifierEditCode

getGp28_ModifierEditCode

getGp28_ModifierEditCodeReps

insertModifierEditCode

insertGp28_ModifierEditCode

removeModifierEditCode

removeGp28_ModifierEditCode

getPaymentAdjustmentCode

getGp29_PaymentAdjustmentCode

getPackagingStatusCode

getGp210_PackagingStatusCode

getExpectedHCFAPaymentAmount

getGp211_ExpectedHCFAPaymentAmount

getReimbursementTypeCode

getGp212_ReimbursementTypeCode

getCoPayAmount

getGp213_CoPayAmount

getPayRatePerUnit

getGp214_PayRatePerUnit

createNewTypeWithoutReflection