Class RXE

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class RXE extends AbstractSegment

Represents an HL7 RXE message segment (Pharmacy/Treatment Encoded Order). This segment has the following fields:

  • RXE-1: Quantity/Timing (TQ)
  • RXE-2: Give Code (CE)
  • RXE-3: Give Amount - Minimum (NM)
  • RXE-4: Give Amount - Maximum (NM) optional
  • RXE-5: Give Units (CE)
  • RXE-6: Give Dosage Form (CE) optional
  • RXE-7: Provider's Administration Instructions (CE) optional repeating
  • RXE-8: Deliver-To Location (LA1) optional
  • RXE-9: Substitution Status (ID) optional
  • RXE-10: Dispense Amount (NM) optional
  • RXE-11: Dispense Units (CE) optional
  • RXE-12: Number of Refills (NM) optional
  • RXE-13: Ordering Provider's DEA Number (XCN) optional repeating
  • RXE-14: Pharmacist/Treatment Supplier's Verifier ID (XCN) optional repeating
  • RXE-15: Prescription Number (ST) optional
  • RXE-16: Number of Refills Remaining (NM) optional
  • RXE-17: Number of Refills/Doses Dispensed (NM) optional
  • RXE-18: D/T of Most Recent Refill or Dose Dispensed (TS) optional
  • RXE-19: Total Daily Dose (CQ) optional
  • RXE-20: Needs Human Review (ID) optional
  • RXE-21: Pharmacy/Treatment Supplier's Special Dispensing Instructions (CE) optional repeating
  • RXE-22: Give Per (Time Unit) (ST) optional
  • RXE-23: Give Rate Amount (ST) optional
  • RXE-24: Give Rate Units (CE) optional
  • RXE-25: Give Strength (NM) optional
  • RXE-26: Give Strength Units (CE) optional
  • RXE-27: Give Indication (CE) optional repeating
  • RXE-28: Dispense Package Size (NM) optional
  • RXE-29: Dispense Package Size Unit (CE) optional
  • RXE-30: Dispense Package Method (ID) optional
  • RXE-31: Supplementary Code (CE) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getQuantityTiming

      Returns RXE-1: "Quantity/Timing" - creates it if necessary
    • getRxe1_QuantityTiming

      Returns RXE-1: "Quantity/Timing" - creates it if necessary
    • getGiveCode

      public CE getGiveCode()
      Returns RXE-2: "Give Code" - creates it if necessary
    • getRxe2_GiveCode

      public CE getRxe2_GiveCode()
      Returns RXE-2: "Give Code" - creates it if necessary
    • getGiveAmountMinimum

      Returns RXE-3: "Give Amount - Minimum" - creates it if necessary
    • getRxe3_GiveAmountMinimum

      Returns RXE-3: "Give Amount - Minimum" - creates it if necessary
    • getGiveAmountMaximum

      Returns RXE-4: "Give Amount - Maximum" - creates it if necessary
    • getRxe4_GiveAmountMaximum

      Returns RXE-4: "Give Amount - Maximum" - creates it if necessary
    • getGiveUnits

      public CE getGiveUnits()
      Returns RXE-5: "Give Units" - creates it if necessary
    • getRxe5_GiveUnits

      Returns RXE-5: "Give Units" - creates it if necessary
    • getGiveDosageForm

      Returns RXE-6: "Give Dosage Form" - creates it if necessary
    • getRxe6_GiveDosageForm

      Returns RXE-6: "Give Dosage Form" - creates it if necessary
    • getProviderSAdministrationInstructions

      Returns all repetitions of Provider's Administration Instructions (RXE-7).
    • getRxe7_ProviderSAdministrationInstructions

      Returns all repetitions of Provider's Administration Instructions (RXE-7).
    • getProviderSAdministrationInstructionsReps

      Returns a count of the current number of repetitions of Provider's Administration Instructions (RXE-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getProviderSAdministrationInstructions

      Returns a specific repetition of RXE-7: "Provider's Administration Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe7_ProviderSAdministrationInstructions

      Returns a specific repetition of RXE-7: "Provider's Administration Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe7_ProviderSAdministrationInstructionsReps

      Returns a count of the current number of repetitions of Provider's Administration Instructions (RXE-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertProviderSAdministrationInstructions

      Inserts a repetition of RXE-7: "Provider's Administration Instructions" 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)
    • insertRxe7_ProviderSAdministrationInstructions

      Inserts a repetition of RXE-7: "Provider's Administration Instructions" 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)
    • removeProviderSAdministrationInstructions

      Removes a repetition of RXE-7: "Provider's Administration Instructions" 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)
    • removeRxe7_ProviderSAdministrationInstructions

      Removes a repetition of RXE-7: "Provider's Administration Instructions" 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)
    • getDeliverToLocation

      Returns RXE-8: "Deliver-To Location" - creates it if necessary
    • getRxe8_DeliverToLocation

      Returns RXE-8: "Deliver-To Location" - creates it if necessary
    • getSubstitutionStatus

      Returns RXE-9: "Substitution Status" - creates it if necessary
    • getRxe9_SubstitutionStatus

      Returns RXE-9: "Substitution Status" - creates it if necessary
    • getDispenseAmount

      Returns RXE-10: "Dispense Amount" - creates it if necessary
    • getRxe10_DispenseAmount

      Returns RXE-10: "Dispense Amount" - creates it if necessary
    • getDispenseUnits

      public CE getDispenseUnits()
      Returns RXE-11: "Dispense Units" - creates it if necessary
    • getRxe11_DispenseUnits

      Returns RXE-11: "Dispense Units" - creates it if necessary
    • getNumberOfRefills

      Returns RXE-12: "Number of Refills" - creates it if necessary
    • getRxe12_NumberOfRefills

      Returns RXE-12: "Number of Refills" - creates it if necessary
    • getOrderingProviderSDEANumber

      Returns all repetitions of Ordering Provider's DEA Number (RXE-13).
    • getRxe13_OrderingProviderSDEANumber

      Returns all repetitions of Ordering Provider's DEA Number (RXE-13).
    • getOrderingProviderSDEANumberReps

      Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXE-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getOrderingProviderSDEANumber

      Returns a specific repetition of RXE-13: "Ordering Provider's DEA Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe13_OrderingProviderSDEANumber

      Returns a specific repetition of RXE-13: "Ordering Provider's DEA Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe13_OrderingProviderSDEANumberReps

      Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXE-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertOrderingProviderSDEANumber

      Inserts a repetition of RXE-13: "Ordering Provider's DEA 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)
    • insertRxe13_OrderingProviderSDEANumber

      Inserts a repetition of RXE-13: "Ordering Provider's DEA 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)
    • removeOrderingProviderSDEANumber

      Removes a repetition of RXE-13: "Ordering Provider's DEA 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)
    • removeRxe13_OrderingProviderSDEANumber

      Removes a repetition of RXE-13: "Ordering Provider's DEA 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)
    • getPharmacistTreatmentSupplierSVerifierID

      Returns all repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14).
    • getRxe14_PharmacistTreatmentSupplierSVerifierID

      Returns all repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14).
    • getPharmacistTreatmentSupplierSVerifierIDReps

      Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPharmacistTreatmentSupplierSVerifierID

      Returns a specific repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe14_PharmacistTreatmentSupplierSVerifierID

      Returns a specific repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe14_PharmacistTreatmentSupplierSVerifierIDReps

      Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPharmacistTreatmentSupplierSVerifierID

      Inserts a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" 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)
    • insertRxe14_PharmacistTreatmentSupplierSVerifierID

      Inserts a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" 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)
    • removePharmacistTreatmentSupplierSVerifierID

      Removes a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" 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)
    • removeRxe14_PharmacistTreatmentSupplierSVerifierID

      Removes a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" 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)
    • getPrescriptionNumber

      Returns RXE-15: "Prescription Number" - creates it if necessary
    • getRxe15_PrescriptionNumber

      Returns RXE-15: "Prescription Number" - creates it if necessary
    • getNumberOfRefillsRemaining

      Returns RXE-16: "Number of Refills Remaining" - creates it if necessary
    • getRxe16_NumberOfRefillsRemaining

      Returns RXE-16: "Number of Refills Remaining" - creates it if necessary
    • getNumberOfRefillsDosesDispensed

      Returns RXE-17: "Number of Refills/Doses Dispensed" - creates it if necessary
    • getRxe17_NumberOfRefillsDosesDispensed

      Returns RXE-17: "Number of Refills/Doses Dispensed" - creates it if necessary
    • getDTOfMostRecentRefillOrDoseDispensed

      Returns RXE-18: "D/T of Most Recent Refill or Dose Dispensed" - creates it if necessary
    • getRxe18_DTOfMostRecentRefillOrDoseDispensed

      Returns RXE-18: "D/T of Most Recent Refill or Dose Dispensed" - creates it if necessary
    • getTotalDailyDose

      Returns RXE-19: "Total Daily Dose" - creates it if necessary
    • getRxe19_TotalDailyDose

      Returns RXE-19: "Total Daily Dose" - creates it if necessary
    • getNeedsHumanReview

      Returns RXE-20: "Needs Human Review" - creates it if necessary
    • getRxe20_NeedsHumanReview

      Returns RXE-20: "Needs Human Review" - creates it if necessary
    • getPharmacyTreatmentSupplierSSpecialDispensingInstructions

      Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21).
    • getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21).
    • getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

      Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPharmacyTreatmentSupplierSSpecialDispensingInstructions

      Returns a specific repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      Returns a specific repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

      Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPharmacyTreatmentSupplierSSpecialDispensingInstructions

      Inserts a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" 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)
    • insertRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      Inserts a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" 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)
    • removePharmacyTreatmentSupplierSSpecialDispensingInstructions

      Removes a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" 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)
    • removeRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      Removes a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" 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)
    • getGivePerTimeUnit

      Returns RXE-22: "Give Per (Time Unit)" - creates it if necessary
    • getRxe22_GivePerTimeUnit

      Returns RXE-22: "Give Per (Time Unit)" - creates it if necessary
    • getGiveRateAmount

      Returns RXE-23: "Give Rate Amount" - creates it if necessary
    • getRxe23_GiveRateAmount

      Returns RXE-23: "Give Rate Amount" - creates it if necessary
    • getGiveRateUnits

      public CE getGiveRateUnits()
      Returns RXE-24: "Give Rate Units" - creates it if necessary
    • getRxe24_GiveRateUnits

      Returns RXE-24: "Give Rate Units" - creates it if necessary
    • getGiveStrength

      public NM getGiveStrength()
      Returns RXE-25: "Give Strength" - creates it if necessary
    • getRxe25_GiveStrength

      Returns RXE-25: "Give Strength" - creates it if necessary
    • getGiveStrengthUnits

      Returns RXE-26: "Give Strength Units" - creates it if necessary
    • getRxe26_GiveStrengthUnits

      Returns RXE-26: "Give Strength Units" - creates it if necessary
    • getGiveIndication

      public CE[] getGiveIndication()
      Returns all repetitions of Give Indication (RXE-27).
    • getRxe27_GiveIndication

      Returns all repetitions of Give Indication (RXE-27).
    • getGiveIndicationReps

      public int getGiveIndicationReps()
      Returns a count of the current number of repetitions of Give Indication (RXE-27). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getGiveIndication

      public CE getGiveIndication(int rep)
      Returns a specific repetition of RXE-27: "Give Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe27_GiveIndication

      public CE getRxe27_GiveIndication(int rep)
      Returns a specific repetition of RXE-27: "Give Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe27_GiveIndicationReps

      Returns a count of the current number of repetitions of Give Indication (RXE-27). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertGiveIndication

      public CE insertGiveIndication(int rep) throws HL7Exception
      Inserts a repetition of RXE-27: "Give Indication" 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)
    • insertRxe27_GiveIndication

      public CE insertRxe27_GiveIndication(int rep) throws HL7Exception
      Inserts a repetition of RXE-27: "Give Indication" 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)
    • removeGiveIndication

      public CE removeGiveIndication(int rep) throws HL7Exception
      Removes a repetition of RXE-27: "Give Indication" 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)
    • removeRxe27_GiveIndication

      public CE removeRxe27_GiveIndication(int rep) throws HL7Exception
      Removes a repetition of RXE-27: "Give Indication" 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)
    • getDispensePackageSize

      Returns RXE-28: "Dispense Package Size" - creates it if necessary
    • getRxe28_DispensePackageSize

      Returns RXE-28: "Dispense Package Size" - creates it if necessary
    • getDispensePackageSizeUnit

      Returns RXE-29: "Dispense Package Size Unit" - creates it if necessary
    • getRxe29_DispensePackageSizeUnit

      Returns RXE-29: "Dispense Package Size Unit" - creates it if necessary
    • getDispensePackageMethod

      Returns RXE-30: "Dispense Package Method" - creates it if necessary
    • getRxe30_DispensePackageMethod

      Returns RXE-30: "Dispense Package Method" - creates it if necessary
    • getSupplementaryCode

      Returns all repetitions of Supplementary Code (RXE-31).
    • getRxe31_SupplementaryCode

      Returns all repetitions of Supplementary Code (RXE-31).
    • getSupplementaryCodeReps

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

      public CE getSupplementaryCode(int rep)
      Returns a specific repetition of RXE-31: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe31_SupplementaryCode

      public CE getRxe31_SupplementaryCode(int rep)
      Returns a specific repetition of RXE-31: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxe31_SupplementaryCodeReps

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

      public CE insertSupplementaryCode(int rep) throws HL7Exception
      Inserts a repetition of RXE-31: "Supplementary 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)
    • insertRxe31_SupplementaryCode

      Inserts a repetition of RXE-31: "Supplementary 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)
    • removeSupplementaryCode

      public CE removeSupplementaryCode(int rep) throws HL7Exception
      Removes a repetition of RXE-31: "Supplementary 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)
    • removeRxe31_SupplementaryCode

      Removes a repetition of RXE-31: "Supplementary 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)
    • createNewTypeWithoutReflection

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