Package ca.uhn.hl7v2.model.v251.segment

Class GP2

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v251.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 CMS Payment Amount (CP) optional
  • GP2-12: Reimbursement Type Code (IS) optional
  • GP2-13: Co-Pay Amount (CP) optional
  • GP2-14: Pay Rate per Service Unit (NM) optional
See Also:

  • Constructor Details

  • Method Details

    • 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

    • getExpectedCMSPaymentAmount

      public CP getExpectedCMSPaymentAmount()
      Returns GP2-11: "Expected CMS Payment Amount" - creates it if necessary

    • getGp211_ExpectedCMSPaymentAmount

      public CP getGp211_ExpectedCMSPaymentAmount()
      Returns GP2-11: "Expected CMS 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

    • getPayRatePerServiceUnit

      public NM getPayRatePerServiceUnit()
      Returns GP2-14: "Pay Rate per Service Unit" - creates it if necessary

    • getGp214_PayRatePerServiceUnit

      public NM getGp214_PayRatePerServiceUnit()
      Returns GP2-14: "Pay Rate per Service Unit" - creates it if necessary

    • createNewTypeWithoutReflection

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