Package ca.uhn.hl7v2.model.v22.segment

Class RXE

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

Represents an HL7 RXE message segment (PHARMACY ENCODED ORDER). This segment has the following fields:

  • RXE-1: Quantity / timing (TQ) optional repeating
  • 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 (CM_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 (CN) optional
  • RXE-14: Pharmacist Verifier ID (CN) optional
  • RXE-15: Prescription Number (ST)
  • RXE-16: Number of Refills Remaining (NM) optional
  • RXE-17: Number of refills / doses dispensed (NM) optional
  • RXE-18: Date / time of most recent refill or dose dispensed (TS) optional
  • RXE-19: Total Daily Dose (CQ_QUANTITY) optional
  • RXE-20: Needs Human Review (ID) optional
  • RXE-21: Pharmacy Special Dispensing Instructions (CE) optional
  • RXE-22: Give Per (Time Unit) (ST) optional
  • RXE-23: Give Rate Amount (CE) optional
  • RXE-24: Give Rate Units (CE) optional
See Also:

  • Constructor Details

  • Method Details

    • getQuantityTiming

      public TQ[] getQuantityTiming()
      Returns all repetitions of Quantity / timing (RXE-1).

    • getRxe1_QuantityTiming

      public TQ[] getRxe1_QuantityTiming()
      Returns all repetitions of Quantity / timing (RXE-1).

    • getQuantityTimingReps

      public int getQuantityTimingReps()
      Returns a count of the current number of repetitions of Quantity / timing (RXE-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getQuantityTiming

      public TQ getQuantityTiming(int rep)
      Returns a specific repetition of RXE-1: "Quantity / timing" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxe1_QuantityTiming

      public TQ getRxe1_QuantityTiming(int rep)
      Returns a specific repetition of RXE-1: "Quantity / timing" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxe1_QuantityTimingReps

      public int getRxe1_QuantityTimingReps()
      Returns a count of the current number of repetitions of Quantity / timing (RXE-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertQuantityTiming

      public TQ insertQuantityTiming(int rep) throws HL7Exception
      Inserts a repetition of RXE-1: "Quantity / timing" 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)

    • insertRxe1_QuantityTiming

      public TQ insertRxe1_QuantityTiming(int rep) throws HL7Exception
      Inserts a repetition of RXE-1: "Quantity / timing" 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)

    • removeQuantityTiming

      public TQ removeQuantityTiming(int rep) throws HL7Exception
      Removes a repetition of RXE-1: "Quantity / timing" 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)

    • removeRxe1_QuantityTiming

      public TQ removeRxe1_QuantityTiming(int rep) throws HL7Exception
      Removes a repetition of RXE-1: "Quantity / timing" 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)

    • 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

      public NM getGiveAmountMinimum()
      Returns RXE-3: "Give Amount - Minimum" - creates it if necessary

    • getRxe3_GiveAmountMinimum

      public NM getRxe3_GiveAmountMinimum()
      Returns RXE-3: "Give Amount - Minimum" - creates it if necessary

    • getGiveAmountMaximum

      public NM getGiveAmountMaximum()
      Returns RXE-4: "Give Amount - Maximum" - creates it if necessary

    • getRxe4_GiveAmountMaximum

      public NM 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

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

    • getGiveDosageForm

      public CE getGiveDosageForm()
      Returns RXE-6: "Give Dosage Form" - creates it if necessary

    • getRxe6_GiveDosageForm

      public CE getRxe6_GiveDosageForm()
      Returns RXE-6: "Give Dosage Form" - creates it if necessary

    • getProviderSAdministrationInstructions

      public CE[] getProviderSAdministrationInstructions()
      Returns all repetitions of Provider's Administration Instructions (RXE-7).

    • getRxe7_ProviderSAdministrationInstructions

      public CE[] getRxe7_ProviderSAdministrationInstructions()
      Returns all repetitions of Provider's Administration Instructions (RXE-7).

    • getProviderSAdministrationInstructionsReps

      public int 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

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

    • getRxe7_ProviderSAdministrationInstructions

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

    • getRxe7_ProviderSAdministrationInstructionsReps

      public int 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

      public CE insertProviderSAdministrationInstructions(int rep) throws HL7Exception
      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

      public CE insertRxe7_ProviderSAdministrationInstructions(int rep) throws HL7Exception
      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

      public CE removeProviderSAdministrationInstructions(int rep) throws HL7Exception
      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

      public CE removeRxe7_ProviderSAdministrationInstructions(int rep) throws HL7Exception
      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

      public CM_LA1 getDeliverToLocation()
      Returns RXE-8: "Deliver-to location" - creates it if necessary

    • getRxe8_DeliverToLocation

      public CM_LA1 getRxe8_DeliverToLocation()
      Returns RXE-8: "Deliver-to location" - creates it if necessary

    • getSubstitutionStatus

      public ID getSubstitutionStatus()
      Returns RXE-9: "Substitution Status" - creates it if necessary

    • getRxe9_SubstitutionStatus

      public ID getRxe9_SubstitutionStatus()
      Returns RXE-9: "Substitution Status" - creates it if necessary

    • getDispenseAmount

      public NM getDispenseAmount()
      Returns RXE-10: "Dispense Amount" - creates it if necessary

    • getRxe10_DispenseAmount

      public NM 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

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

    • getNumberOfRefills

      public NM getNumberOfRefills()
      Returns RXE-12: "Number of Refills" - creates it if necessary

    • getRxe12_NumberOfRefills

      public NM getRxe12_NumberOfRefills()
      Returns RXE-12: "Number of Refills" - creates it if necessary

    • getOrderingProviderSDEANumber

      public CN getOrderingProviderSDEANumber()
      Returns RXE-13: "Ordering Provider's DEA Number" - creates it if necessary

    • getRxe13_OrderingProviderSDEANumber

      public CN getRxe13_OrderingProviderSDEANumber()
      Returns RXE-13: "Ordering Provider's DEA Number" - creates it if necessary

    • getPharmacistVerifierID

      public CN getPharmacistVerifierID()
      Returns RXE-14: "Pharmacist Verifier ID" - creates it if necessary

    • getRxe14_PharmacistVerifierID

      public CN getRxe14_PharmacistVerifierID()
      Returns RXE-14: "Pharmacist Verifier ID" - creates it if necessary

    • getPrescriptionNumber

      public ST getPrescriptionNumber()
      Returns RXE-15: "Prescription Number" - creates it if necessary

    • getRxe15_PrescriptionNumber

      public ST getRxe15_PrescriptionNumber()
      Returns RXE-15: "Prescription Number" - creates it if necessary

    • getNumberOfRefillsRemaining

      public NM getNumberOfRefillsRemaining()
      Returns RXE-16: "Number of Refills Remaining" - creates it if necessary

    • getRxe16_NumberOfRefillsRemaining

      public NM getRxe16_NumberOfRefillsRemaining()
      Returns RXE-16: "Number of Refills Remaining" - creates it if necessary

    • getNumberOfRefillsDosesDispensed

      public NM getNumberOfRefillsDosesDispensed()
      Returns RXE-17: "Number of refills / doses dispensed" - creates it if necessary

    • getRxe17_NumberOfRefillsDosesDispensed

      public NM getRxe17_NumberOfRefillsDosesDispensed()
      Returns RXE-17: "Number of refills / doses dispensed" - creates it if necessary

    • getDateTimeOfMostRecentRefillOrDoseDispensed

      public TS getDateTimeOfMostRecentRefillOrDoseDispensed()
      Returns RXE-18: "Date / time of most recent refill or dose dispensed" - creates it if necessary

    • getRxe18_DateTimeOfMostRecentRefillOrDoseDispensed

      public TS getRxe18_DateTimeOfMostRecentRefillOrDoseDispensed()
      Returns RXE-18: "Date / time of most recent refill or dose dispensed" - creates it if necessary

    • getTotalDailyDose

      public CQ_QUANTITY getTotalDailyDose()
      Returns RXE-19: "Total Daily Dose" - creates it if necessary

    • getRxe19_TotalDailyDose

      public CQ_QUANTITY getRxe19_TotalDailyDose()
      Returns RXE-19: "Total Daily Dose" - creates it if necessary

    • getNeedsHumanReview

      public ID getNeedsHumanReview()
      Returns RXE-20: "Needs Human Review" - creates it if necessary

    • getRxe20_NeedsHumanReview

      public ID getRxe20_NeedsHumanReview()
      Returns RXE-20: "Needs Human Review" - creates it if necessary

    • getPharmacySpecialDispensingInstructions

      public CE getPharmacySpecialDispensingInstructions()
      Returns RXE-21: "Pharmacy Special Dispensing Instructions" - creates it if necessary

    • getRxe21_PharmacySpecialDispensingInstructions

      public CE getRxe21_PharmacySpecialDispensingInstructions()
      Returns RXE-21: "Pharmacy Special Dispensing Instructions" - creates it if necessary

    • getGivePerTimeUnit

      public ST getGivePerTimeUnit()
      Returns RXE-22: "Give Per (Time Unit)" - creates it if necessary

    • getRxe22_GivePerTimeUnit

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

    • getGiveRateAmount

      public CE getGiveRateAmount()
      Returns RXE-23: "Give Rate Amount" - creates it if necessary

    • getRxe23_GiveRateAmount

      public CE 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

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

    • createNewTypeWithoutReflection

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