Package ca.uhn.hl7v2.model.v24.segment

Class PRC

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v24.segment.PRC
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class PRC extends AbstractSegment

Represents an HL7 PRC message segment (Pricing). This segment has the following fields:

  • PRC-1: Primary Key Value - PRC (CE)
  • PRC-2: Facility ID - PRC (CE) optional repeating
  • PRC-3: Department (CE) optional repeating
  • PRC-4: Valid Patient Classes (IS) optional repeating
  • PRC-5: Price (CP) optional repeating
  • PRC-6: Formula (ST) optional repeating
  • PRC-7: Minimum Quantity (NM) optional
  • PRC-8: Maximum Quantity (NM) optional
  • PRC-9: Minimum Price (MO) optional
  • PRC-10: Maximum Price (MO) optional
  • PRC-11: Effective Start Date (TS) optional
  • PRC-12: Effective End Date (TS) optional
  • PRC-13: Price Override Flag (IS) optional
  • PRC-14: Billing Category (CE) optional repeating
  • PRC-15: Chargeable Flag (ID) optional
  • PRC-16: Active/Inactive Flag (ID) optional
  • PRC-17: Cost (MO) optional
  • PRC-18: Charge On Indicator (IS) optional
See Also:

  • Constructor Details

  • Method Details

    • getPrimaryKeyValuePRC

      public CE getPrimaryKeyValuePRC()
      Returns PRC-1: "Primary Key Value - PRC" - creates it if necessary

    • getPrc1_PrimaryKeyValuePRC

      public CE getPrc1_PrimaryKeyValuePRC()
      Returns PRC-1: "Primary Key Value - PRC" - creates it if necessary

    • getFacilityIDPRC

      public CE[] getFacilityIDPRC()
      Returns all repetitions of Facility ID - PRC (PRC-2).

    • getPrc2_FacilityIDPRC

      public CE[] getPrc2_FacilityIDPRC()
      Returns all repetitions of Facility ID - PRC (PRC-2).

    • getFacilityIDPRCReps

      public int getFacilityIDPRCReps()
      Returns a count of the current number of repetitions of Facility ID - PRC (PRC-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getFacilityIDPRC

      public CE getFacilityIDPRC(int rep)
      Returns a specific repetition of PRC-2: "Facility ID - PRC" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc2_FacilityIDPRC

      public CE getPrc2_FacilityIDPRC(int rep)
      Returns a specific repetition of PRC-2: "Facility ID - PRC" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc2_FacilityIDPRCReps

      public int getPrc2_FacilityIDPRCReps()
      Returns a count of the current number of repetitions of Facility ID - PRC (PRC-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertFacilityIDPRC

      public CE insertFacilityIDPRC(int rep) throws HL7Exception
      Inserts a repetition of PRC-2: "Facility ID - PRC" 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)

    • insertPrc2_FacilityIDPRC

      public CE insertPrc2_FacilityIDPRC(int rep) throws HL7Exception
      Inserts a repetition of PRC-2: "Facility ID - PRC" 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)

    • removeFacilityIDPRC

      public CE removeFacilityIDPRC(int rep) throws HL7Exception
      Removes a repetition of PRC-2: "Facility ID - PRC" 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)

    • removePrc2_FacilityIDPRC

      public CE removePrc2_FacilityIDPRC(int rep) throws HL7Exception
      Removes a repetition of PRC-2: "Facility ID - PRC" 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)

    • getDepartment

      public CE[] getDepartment()
      Returns all repetitions of Department (PRC-3).

    • getPrc3_Department

      public CE[] getPrc3_Department()
      Returns all repetitions of Department (PRC-3).

    • getDepartmentReps

      public int getDepartmentReps()
      Returns a count of the current number of repetitions of Department (PRC-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getDepartment

      public CE getDepartment(int rep)
      Returns a specific repetition of PRC-3: "Department" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc3_Department

      public CE getPrc3_Department(int rep)
      Returns a specific repetition of PRC-3: "Department" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc3_DepartmentReps

      public int getPrc3_DepartmentReps()
      Returns a count of the current number of repetitions of Department (PRC-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertDepartment

      public CE insertDepartment(int rep) throws HL7Exception
      Inserts a repetition of PRC-3: "Department" 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)

    • insertPrc3_Department

      public CE insertPrc3_Department(int rep) throws HL7Exception
      Inserts a repetition of PRC-3: "Department" 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)

    • removeDepartment

      public CE removeDepartment(int rep) throws HL7Exception
      Removes a repetition of PRC-3: "Department" 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)

    • removePrc3_Department

      public CE removePrc3_Department(int rep) throws HL7Exception
      Removes a repetition of PRC-3: "Department" 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)

    • getValidPatientClasses

      public IS[] getValidPatientClasses()
      Returns all repetitions of Valid Patient Classes (PRC-4).

    • getPrc4_ValidPatientClasses

      public IS[] getPrc4_ValidPatientClasses()
      Returns all repetitions of Valid Patient Classes (PRC-4).

    • getValidPatientClassesReps

      public int getValidPatientClassesReps()
      Returns a count of the current number of repetitions of Valid Patient Classes (PRC-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getValidPatientClasses

      public IS getValidPatientClasses(int rep)
      Returns a specific repetition of PRC-4: "Valid Patient Classes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc4_ValidPatientClasses

      public IS getPrc4_ValidPatientClasses(int rep)
      Returns a specific repetition of PRC-4: "Valid Patient Classes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc4_ValidPatientClassesReps

      public int getPrc4_ValidPatientClassesReps()
      Returns a count of the current number of repetitions of Valid Patient Classes (PRC-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertValidPatientClasses

      public IS insertValidPatientClasses(int rep) throws HL7Exception
      Inserts a repetition of PRC-4: "Valid Patient Classes" 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)

    • insertPrc4_ValidPatientClasses

      public IS insertPrc4_ValidPatientClasses(int rep) throws HL7Exception
      Inserts a repetition of PRC-4: "Valid Patient Classes" 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)

    • removeValidPatientClasses

      public IS removeValidPatientClasses(int rep) throws HL7Exception
      Removes a repetition of PRC-4: "Valid Patient Classes" 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)

    • removePrc4_ValidPatientClasses

      public IS removePrc4_ValidPatientClasses(int rep) throws HL7Exception
      Removes a repetition of PRC-4: "Valid Patient Classes" 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)

    • getPrice

      public CP[] getPrice()
      Returns all repetitions of Price (PRC-5).

    • getPrc5_Price

      public CP[] getPrc5_Price()
      Returns all repetitions of Price (PRC-5).

    • getPriceReps

      public int getPriceReps()
      Returns a count of the current number of repetitions of Price (PRC-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPrice

      public CP getPrice(int rep)
      Returns a specific repetition of PRC-5: "Price" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc5_Price

      public CP getPrc5_Price(int rep)
      Returns a specific repetition of PRC-5: "Price" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc5_PriceReps

      public int getPrc5_PriceReps()
      Returns a count of the current number of repetitions of Price (PRC-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPrice

      public CP insertPrice(int rep) throws HL7Exception
      Inserts a repetition of PRC-5: "Price" 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)

    • insertPrc5_Price

      public CP insertPrc5_Price(int rep) throws HL7Exception
      Inserts a repetition of PRC-5: "Price" 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)

    • removePrice

      public CP removePrice(int rep) throws HL7Exception
      Removes a repetition of PRC-5: "Price" 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)

    • removePrc5_Price

      public CP removePrc5_Price(int rep) throws HL7Exception
      Removes a repetition of PRC-5: "Price" 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)

    • getFormula

      public ST[] getFormula()
      Returns all repetitions of Formula (PRC-6).

    • getPrc6_Formula

      public ST[] getPrc6_Formula()
      Returns all repetitions of Formula (PRC-6).

    • getFormulaReps

      public int getFormulaReps()
      Returns a count of the current number of repetitions of Formula (PRC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getFormula

      public ST getFormula(int rep)
      Returns a specific repetition of PRC-6: "Formula" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc6_Formula

      public ST getPrc6_Formula(int rep)
      Returns a specific repetition of PRC-6: "Formula" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc6_FormulaReps

      public int getPrc6_FormulaReps()
      Returns a count of the current number of repetitions of Formula (PRC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertFormula

      public ST insertFormula(int rep) throws HL7Exception
      Inserts a repetition of PRC-6: "Formula" 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)

    • insertPrc6_Formula

      public ST insertPrc6_Formula(int rep) throws HL7Exception
      Inserts a repetition of PRC-6: "Formula" 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)

    • removeFormula

      public ST removeFormula(int rep) throws HL7Exception
      Removes a repetition of PRC-6: "Formula" 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)

    • removePrc6_Formula

      public ST removePrc6_Formula(int rep) throws HL7Exception
      Removes a repetition of PRC-6: "Formula" 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)

    • getMinimumQuantity

      public NM getMinimumQuantity()
      Returns PRC-7: "Minimum Quantity" - creates it if necessary

    • getPrc7_MinimumQuantity

      public NM getPrc7_MinimumQuantity()
      Returns PRC-7: "Minimum Quantity" - creates it if necessary

    • getMaximumQuantity

      public NM getMaximumQuantity()
      Returns PRC-8: "Maximum Quantity" - creates it if necessary

    • getPrc8_MaximumQuantity

      public NM getPrc8_MaximumQuantity()
      Returns PRC-8: "Maximum Quantity" - creates it if necessary

    • getMinimumPrice

      public MO getMinimumPrice()
      Returns PRC-9: "Minimum Price" - creates it if necessary

    • getPrc9_MinimumPrice

      public MO getPrc9_MinimumPrice()
      Returns PRC-9: "Minimum Price" - creates it if necessary

    • getMaximumPrice

      public MO getMaximumPrice()
      Returns PRC-10: "Maximum Price" - creates it if necessary

    • getPrc10_MaximumPrice

      public MO getPrc10_MaximumPrice()
      Returns PRC-10: "Maximum Price" - creates it if necessary

    • getEffectiveStartDate

      public TS getEffectiveStartDate()
      Returns PRC-11: "Effective Start Date" - creates it if necessary

    • getPrc11_EffectiveStartDate

      public TS getPrc11_EffectiveStartDate()
      Returns PRC-11: "Effective Start Date" - creates it if necessary

    • getEffectiveEndDate

      public TS getEffectiveEndDate()
      Returns PRC-12: "Effective End Date" - creates it if necessary

    • getPrc12_EffectiveEndDate

      public TS getPrc12_EffectiveEndDate()
      Returns PRC-12: "Effective End Date" - creates it if necessary

    • getPriceOverrideFlag

      public IS getPriceOverrideFlag()
      Returns PRC-13: "Price Override Flag" - creates it if necessary

    • getPrc13_PriceOverrideFlag

      public IS getPrc13_PriceOverrideFlag()
      Returns PRC-13: "Price Override Flag" - creates it if necessary

    • getBillingCategory

      public CE[] getBillingCategory()
      Returns all repetitions of Billing Category (PRC-14).

    • getPrc14_BillingCategory

      public CE[] getPrc14_BillingCategory()
      Returns all repetitions of Billing Category (PRC-14).

    • getBillingCategoryReps

      public int getBillingCategoryReps()
      Returns a count of the current number of repetitions of Billing Category (PRC-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getBillingCategory

      public CE getBillingCategory(int rep)
      Returns a specific repetition of PRC-14: "Billing Category" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc14_BillingCategory

      public CE getPrc14_BillingCategory(int rep)
      Returns a specific repetition of PRC-14: "Billing Category" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPrc14_BillingCategoryReps

      public int getPrc14_BillingCategoryReps()
      Returns a count of the current number of repetitions of Billing Category (PRC-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertBillingCategory

      public CE insertBillingCategory(int rep) throws HL7Exception
      Inserts a repetition of PRC-14: "Billing Category" 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)

    • insertPrc14_BillingCategory

      public CE insertPrc14_BillingCategory(int rep) throws HL7Exception
      Inserts a repetition of PRC-14: "Billing Category" 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)

    • removeBillingCategory

      public CE removeBillingCategory(int rep) throws HL7Exception
      Removes a repetition of PRC-14: "Billing Category" 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)

    • removePrc14_BillingCategory

      public CE removePrc14_BillingCategory(int rep) throws HL7Exception
      Removes a repetition of PRC-14: "Billing Category" 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)

    • getChargeableFlag

      public ID getChargeableFlag()
      Returns PRC-15: "Chargeable Flag" - creates it if necessary

    • getPrc15_ChargeableFlag

      public ID getPrc15_ChargeableFlag()
      Returns PRC-15: "Chargeable Flag" - creates it if necessary

    • getActiveInactiveFlag

      public ID getActiveInactiveFlag()
      Returns PRC-16: "Active/Inactive Flag" - creates it if necessary

    • getPrc16_ActiveInactiveFlag

      public ID getPrc16_ActiveInactiveFlag()
      Returns PRC-16: "Active/Inactive Flag" - creates it if necessary

    • getCost

      public MO getCost()
      Returns PRC-17: "Cost" - creates it if necessary

    • getPrc17_Cost

      public MO getPrc17_Cost()
      Returns PRC-17: "Cost" - creates it if necessary

    • getChargeOnIndicator

      public IS getChargeOnIndicator()
      Returns PRC-18: "Charge On Indicator" - creates it if necessary

    • getPrc18_ChargeOnIndicator

      public IS getPrc18_ChargeOnIndicator()
      Returns PRC-18: "Charge On Indicator" - creates it if necessary

    • createNewTypeWithoutReflection

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