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

Class RXO

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

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

  • RXO-1: Requested Give Code (CE)
  • RXO-2: Requested Give Amount - Minimum (NM)
  • RXO-3: Requested Give Amount - Maximum (NM) optional
  • RXO-4: Requested Give Units (CE)
  • RXO-5: Requested Dosage Form (CE) optional
  • RXO-6: Provider's Pharmacy Instructions (CE) optional repeating
  • RXO-7: Provider's Administration Instructions (CE) optional repeating
  • RXO-8: Deliver-to location (CM_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 (CN) optional
  • RXO-15: Pharmacist Verifier ID (CN) optional
  • RXO-16: Needs Human Review (ID) optional
  • RXO-17: Requested Give Per (Time Unit) (ST) optional
See Also:

  • Constructor Details

  • Method Details

    • getRequestedGiveCode

      public CE getRequestedGiveCode()
      Returns RXO-1: "Requested Give Code" - creates it if necessary

    • getRxo1_RequestedGiveCode

      public CE getRxo1_RequestedGiveCode()
      Returns RXO-1: "Requested Give Code" - creates it if necessary

    • getRequestedGiveAmountMinimum

      public NM getRequestedGiveAmountMinimum()
      Returns RXO-2: "Requested Give Amount - Minimum" - creates it if necessary

    • getRxo2_RequestedGiveAmountMinimum

      public NM getRxo2_RequestedGiveAmountMinimum()
      Returns RXO-2: "Requested Give Amount - Minimum" - creates it if necessary

    • getRequestedGiveAmountMaximum

      public NM getRequestedGiveAmountMaximum()
      Returns RXO-3: "Requested Give Amount - Maximum" - creates it if necessary

    • getRxo3_RequestedGiveAmountMaximum

      public NM getRxo3_RequestedGiveAmountMaximum()
      Returns RXO-3: "Requested Give Amount - Maximum" - creates it if necessary

    • getRequestedGiveUnits

      public CE getRequestedGiveUnits()
      Returns RXO-4: "Requested Give Units" - creates it if necessary

    • getRxo4_RequestedGiveUnits

      public CE getRxo4_RequestedGiveUnits()
      Returns RXO-4: "Requested Give Units" - creates it if necessary

    • getRequestedDosageForm

      public CE getRequestedDosageForm()
      Returns RXO-5: "Requested Dosage Form" - creates it if necessary

    • getRxo5_RequestedDosageForm

      public CE getRxo5_RequestedDosageForm()
      Returns RXO-5: "Requested Dosage Form" - creates it if necessary

    • getProviderSPharmacyInstructions

      public CE[] getProviderSPharmacyInstructions()
      Returns all repetitions of Provider's Pharmacy Instructions (RXO-6).

    • getRxo6_ProviderSPharmacyInstructions

      public CE[] getRxo6_ProviderSPharmacyInstructions()
      Returns all repetitions of Provider's Pharmacy Instructions (RXO-6).

    • getProviderSPharmacyInstructionsReps

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

    • getProviderSPharmacyInstructions

      public CE getProviderSPharmacyInstructions(int rep)
      Returns a specific repetition of RXO-6: "Provider's Pharmacy Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxo6_ProviderSPharmacyInstructions

      public CE getRxo6_ProviderSPharmacyInstructions(int rep)
      Returns a specific repetition of RXO-6: "Provider's Pharmacy Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxo6_ProviderSPharmacyInstructionsReps

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

    • insertProviderSPharmacyInstructions

      public CE insertProviderSPharmacyInstructions(int rep) throws HL7Exception
      Inserts a repetition of RXO-6: "Provider's Pharmacy 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_ProviderSPharmacyInstructions

      public CE insertRxo6_ProviderSPharmacyInstructions(int rep) throws HL7Exception
      Inserts a repetition of RXO-6: "Provider's Pharmacy 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)

    • removeProviderSPharmacyInstructions

      public CE removeProviderSPharmacyInstructions(int rep) throws HL7Exception
      Removes a repetition of RXO-6: "Provider's Pharmacy 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_ProviderSPharmacyInstructions

      public CE removeRxo6_ProviderSPharmacyInstructions(int rep) throws HL7Exception
      Removes a repetition of RXO-6: "Provider's Pharmacy 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

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

    • getRxo7_ProviderSAdministrationInstructions

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

    • getProviderSAdministrationInstructionsReps

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

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

    • getRxo7_ProviderSAdministrationInstructions

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

    • getRxo7_ProviderSAdministrationInstructionsReps

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

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

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

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

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

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

    • getRxo8_DeliverToLocation

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

    • getAllowSubstitutions

      public ID getAllowSubstitutions()
      Returns RXO-9: "Allow Substitutions" - creates it if necessary

    • getRxo9_AllowSubstitutions

      public ID getRxo9_AllowSubstitutions()
      Returns RXO-9: "Allow Substitutions" - creates it if necessary

    • getRequestedDispenseCode

      public CE getRequestedDispenseCode()
      Returns RXO-10: "Requested Dispense Code" - creates it if necessary

    • getRxo10_RequestedDispenseCode

      public CE getRxo10_RequestedDispenseCode()
      Returns RXO-10: "Requested Dispense Code" - creates it if necessary

    • getRequestedDispenseAmount

      public NM getRequestedDispenseAmount()
      Returns RXO-11: "Requested Dispense Amount" - creates it if necessary

    • getRxo11_RequestedDispenseAmount

      public NM getRxo11_RequestedDispenseAmount()
      Returns RXO-11: "Requested Dispense Amount" - creates it if necessary

    • getRequestedDispenseUnits

      public CE getRequestedDispenseUnits()
      Returns RXO-12: "Requested Dispense Units" - creates it if necessary

    • getRxo12_RequestedDispenseUnits

      public CE getRxo12_RequestedDispenseUnits()
      Returns RXO-12: "Requested Dispense Units" - creates it if necessary

    • getNumberOfRefills

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

    • getRxo13_NumberOfRefills

      public NM getRxo13_NumberOfRefills()
      Returns RXO-13: "Number of Refills" - creates it if necessary

    • getOrderingProviderSDEANumber

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

    • getRxo14_OrderingProviderSDEANumber

      public CN getRxo14_OrderingProviderSDEANumber()
      Returns RXO-14: "Ordering Provider's DEA Number" - creates it if necessary

    • getPharmacistVerifierID

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

    • getRxo15_PharmacistVerifierID

      public CN getRxo15_PharmacistVerifierID()
      Returns RXO-15: "Pharmacist Verifier ID" - creates it if necessary

    • getNeedsHumanReview

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

    • getRxo16_NeedsHumanReview

      public ID getRxo16_NeedsHumanReview()
      Returns RXO-16: "Needs Human Review" - creates it if necessary

    • getRequestedGivePerTimeUnit

      public ST getRequestedGivePerTimeUnit()
      Returns RXO-17: "Requested Give Per (Time Unit)" - creates it if necessary

    • getRxo17_RequestedGivePerTimeUnit

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

    • createNewTypeWithoutReflection

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