Class RXO

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class RXO extends AbstractSegment

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

  • RXO-1: Requested Give Code (CE) optional
  • RXO-2: Requested Give Amount - Minimum (NM) optional
  • RXO-3: Requested Give Amount - Maximum (NM) optional
  • RXO-4: Requested Give Units (CE) optional
  • RXO-5: Requested Dosage Form (CE) optional
  • RXO-6: Provider's Pharmacy/Treatment Instructions (CE) optional repeating
  • RXO-7: Provider's Administration Instructions (CE) optional repeating
  • RXO-8: Deliver-To Location (LA1) optional
  • RXO-9: Allow Substitutions (ID) optional
  • RXO-10: Requested Dispense Code (CE) optional
  • RXO-11: Requested Dispense Amount (NM) optional
  • RXO-12: Requested Dispense Units (CE) optional
  • RXO-13: Number of Refills (NM) optional
  • RXO-14: Ordering Provider's DEA Number (XCN) optional repeating
  • RXO-15: Pharmacist/Treatment Supplier's Verifier ID (XCN) optional repeating
  • RXO-16: Needs Human Review (ID) optional
  • RXO-17: Requested Give Per (Time Unit) (ST) optional
  • RXO-18: Requested Give Strength (NM) optional
  • RXO-19: Requested Give Strength Units (CE) optional
  • RXO-20: Indication (CE) optional repeating
  • RXO-21: Requested Give Rate Amount (ST) optional
  • RXO-22: Requested Give Rate Units (CE) optional
  • RXO-23: Total Daily Dose (CQ) optional
  • RXO-24: Supplementary Code (CE) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getRequestedGiveCode

      Returns RXO-1: "Requested Give Code" - creates it if necessary
    • getRxo1_RequestedGiveCode

      Returns RXO-1: "Requested Give Code" - creates it if necessary
    • getRequestedGiveAmountMinimum

      Returns RXO-2: "Requested Give Amount - Minimum" - creates it if necessary
    • getRxo2_RequestedGiveAmountMinimum

      Returns RXO-2: "Requested Give Amount - Minimum" - creates it if necessary
    • getRequestedGiveAmountMaximum

      Returns RXO-3: "Requested Give Amount - Maximum" - creates it if necessary
    • getRxo3_RequestedGiveAmountMaximum

      Returns RXO-3: "Requested Give Amount - Maximum" - creates it if necessary
    • getRequestedGiveUnits

      Returns RXO-4: "Requested Give Units" - creates it if necessary
    • getRxo4_RequestedGiveUnits

      Returns RXO-4: "Requested Give Units" - creates it if necessary
    • getRequestedDosageForm

      Returns RXO-5: "Requested Dosage Form" - creates it if necessary
    • getRxo5_RequestedDosageForm

      Returns RXO-5: "Requested Dosage Form" - creates it if necessary
    • getProviderSPharmacyTreatmentInstructions

      Returns all repetitions of Provider's Pharmacy/Treatment Instructions (RXO-6).
    • getRxo6_ProviderSPharmacyTreatmentInstructions

      Returns all repetitions of Provider's Pharmacy/Treatment Instructions (RXO-6).
    • getProviderSPharmacyTreatmentInstructionsReps

      Returns a count of the current number of repetitions of Provider's Pharmacy/Treatment Instructions (RXO-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getProviderSPharmacyTreatmentInstructions

      Returns a specific repetition of RXO-6: "Provider's Pharmacy/Treatment Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo6_ProviderSPharmacyTreatmentInstructions

      Returns a specific repetition of RXO-6: "Provider's Pharmacy/Treatment Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo6_ProviderSPharmacyTreatmentInstructionsReps

      Returns a count of the current number of repetitions of Provider's Pharmacy/Treatment Instructions (RXO-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertProviderSPharmacyTreatmentInstructions

      Inserts a repetition of RXO-6: "Provider's Pharmacy/Treatment 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)
    • insertRxo6_ProviderSPharmacyTreatmentInstructions

      Inserts a repetition of RXO-6: "Provider's Pharmacy/Treatment 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)
    • removeProviderSPharmacyTreatmentInstructions

      Removes a repetition of RXO-6: "Provider's Pharmacy/Treatment 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)
    • removeRxo6_ProviderSPharmacyTreatmentInstructions

      Removes a repetition of RXO-6: "Provider's Pharmacy/Treatment 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)
    • getProviderSAdministrationInstructions

      Returns all repetitions of Provider's Administration Instructions (RXO-7).
    • getRxo7_ProviderSAdministrationInstructions

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

      Returns a count of the current number of repetitions of Provider's Administration Instructions (RXO-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 RXO-7: "Provider's Administration Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo7_ProviderSAdministrationInstructions

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

      Returns a count of the current number of repetitions of Provider's Administration Instructions (RXO-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 RXO-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)
    • insertRxo7_ProviderSAdministrationInstructions

      Inserts a repetition of RXO-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 RXO-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)
    • removeRxo7_ProviderSAdministrationInstructions

      Removes a repetition of RXO-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 RXO-8: "Deliver-To Location" - creates it if necessary
    • getRxo8_DeliverToLocation

      Returns RXO-8: "Deliver-To Location" - creates it if necessary
    • getAllowSubstitutions

      Returns RXO-9: "Allow Substitutions" - creates it if necessary
    • getRxo9_AllowSubstitutions

      Returns RXO-9: "Allow Substitutions" - creates it if necessary
    • getRequestedDispenseCode

      Returns RXO-10: "Requested Dispense Code" - creates it if necessary
    • getRxo10_RequestedDispenseCode

      Returns RXO-10: "Requested Dispense Code" - creates it if necessary
    • getRequestedDispenseAmount

      Returns RXO-11: "Requested Dispense Amount" - creates it if necessary
    • getRxo11_RequestedDispenseAmount

      Returns RXO-11: "Requested Dispense Amount" - creates it if necessary
    • getRequestedDispenseUnits

      Returns RXO-12: "Requested Dispense Units" - creates it if necessary
    • getRxo12_RequestedDispenseUnits

      Returns RXO-12: "Requested Dispense Units" - creates it if necessary
    • getNumberOfRefills

      Returns RXO-13: "Number of Refills" - creates it if necessary
    • getRxo13_NumberOfRefills

      Returns RXO-13: "Number of Refills" - creates it if necessary
    • getOrderingProviderSDEANumber

      Returns all repetitions of Ordering Provider's DEA Number (RXO-14).
    • getRxo14_OrderingProviderSDEANumber

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

      Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXO-14). 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 RXO-14: "Ordering Provider's DEA Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo14_OrderingProviderSDEANumber

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

      Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXO-14). 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 RXO-14: "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)
    • insertRxo14_OrderingProviderSDEANumber

      Inserts a repetition of RXO-14: "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 RXO-14: "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)
    • removeRxo14_OrderingProviderSDEANumber

      Removes a repetition of RXO-14: "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 (RXO-15).
    • getRxo15_PharmacistTreatmentSupplierSVerifierID

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

      Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXO-15). 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 RXO-15: "Pharmacist/Treatment Supplier's Verifier ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo15_PharmacistTreatmentSupplierSVerifierID

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

      Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXO-15). 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 RXO-15: "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)
    • insertRxo15_PharmacistTreatmentSupplierSVerifierID

      Inserts a repetition of RXO-15: "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 RXO-15: "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)
    • removeRxo15_PharmacistTreatmentSupplierSVerifierID

      Removes a repetition of RXO-15: "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)
    • getNeedsHumanReview

      Returns RXO-16: "Needs Human Review" - creates it if necessary
    • getRxo16_NeedsHumanReview

      Returns RXO-16: "Needs Human Review" - creates it if necessary
    • getRequestedGivePerTimeUnit

      Returns RXO-17: "Requested Give Per (Time Unit)" - creates it if necessary
    • getRxo17_RequestedGivePerTimeUnit

      Returns RXO-17: "Requested Give Per (Time Unit)" - creates it if necessary
    • getRequestedGiveStrength

      Returns RXO-18: "Requested Give Strength" - creates it if necessary
    • getRxo18_RequestedGiveStrength

      Returns RXO-18: "Requested Give Strength" - creates it if necessary
    • getRequestedGiveStrengthUnits

      Returns RXO-19: "Requested Give Strength Units" - creates it if necessary
    • getRxo19_RequestedGiveStrengthUnits

      Returns RXO-19: "Requested Give Strength Units" - creates it if necessary
    • getIndication

      public CE[] getIndication()
      Returns all repetitions of Indication (RXO-20).
    • getRxo20_Indication

      public CE[] getRxo20_Indication()
      Returns all repetitions of Indication (RXO-20).
    • getIndicationReps

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

      public CE getIndication(int rep)
      Returns a specific repetition of RXO-20: "Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo20_Indication

      public CE getRxo20_Indication(int rep)
      Returns a specific repetition of RXO-20: "Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo20_IndicationReps

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

      public CE insertIndication(int rep) throws HL7Exception
      Inserts a repetition of RXO-20: "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)
    • insertRxo20_Indication

      public CE insertRxo20_Indication(int rep) throws HL7Exception
      Inserts a repetition of RXO-20: "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)
    • removeIndication

      public CE removeIndication(int rep) throws HL7Exception
      Removes a repetition of RXO-20: "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)
    • removeRxo20_Indication

      public CE removeRxo20_Indication(int rep) throws HL7Exception
      Removes a repetition of RXO-20: "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)
    • getRequestedGiveRateAmount

      Returns RXO-21: "Requested Give Rate Amount" - creates it if necessary
    • getRxo21_RequestedGiveRateAmount

      Returns RXO-21: "Requested Give Rate Amount" - creates it if necessary
    • getRequestedGiveRateUnits

      Returns RXO-22: "Requested Give Rate Units" - creates it if necessary
    • getRxo22_RequestedGiveRateUnits

      Returns RXO-22: "Requested Give Rate Units" - creates it if necessary
    • getTotalDailyDose

      Returns RXO-23: "Total Daily Dose" - creates it if necessary
    • getRxo23_TotalDailyDose

      Returns RXO-23: "Total Daily Dose" - creates it if necessary
    • getSupplementaryCode

      Returns all repetitions of Supplementary Code (RXO-24).
    • getRxo24_SupplementaryCode

      Returns all repetitions of Supplementary Code (RXO-24).
    • getSupplementaryCodeReps

      Returns a count of the current number of repetitions of Supplementary Code (RXO-24). 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 RXO-24: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo24_SupplementaryCode

      public CE getRxo24_SupplementaryCode(int rep)
      Returns a specific repetition of RXO-24: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxo24_SupplementaryCodeReps

      Returns a count of the current number of repetitions of Supplementary Code (RXO-24). 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 RXO-24: "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)
    • insertRxo24_SupplementaryCode

      Inserts a repetition of RXO-24: "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 RXO-24: "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)
    • removeRxo24_SupplementaryCode

      Removes a repetition of RXO-24: "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