RXE (HAPI - 04 - Generated Structures v2.4 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ca.uhn.hl7v2.model.v24.segment
Class RXE

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.RXE

All Implemented Interfaces:: Segment, Structure, Serializable

public class RXE
extends AbstractSegment
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:: Serialized Form

Constructor Summary
`RXE(Group parent, ModelClassFactory factory)` Creates a new RXE segment

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`LA1`	`getDeliverToLocation()` Returns RXE-8: "Deliver-To Location" - creates it if necessary
`NM`	`getDispenseAmount()` Returns RXE-10: "Dispense Amount" - creates it if necessary
`ID`	`getDispensePackageMethod()` Returns RXE-30: "Dispense Package Method" - creates it if necessary
`NM`	`getDispensePackageSize()` Returns RXE-28: "Dispense Package Size" - creates it if necessary
`CE`	`getDispensePackageSizeUnit()` Returns RXE-29: "Dispense Package Size Unit" - creates it if necessary
`CE`	`getDispenseUnits()` Returns RXE-11: "Dispense Units" - creates it if necessary
`TS`	`getDTOfMostRecentRefillOrDoseDispensed()` Returns RXE-18: "D/T of Most Recent Refill or Dose Dispensed" - creates it if necessary
`NM`	`getGiveAmountMaximum()` Returns RXE-4: "Give Amount - Maximum" - creates it if necessary
`NM`	`getGiveAmountMinimum()` Returns RXE-3: "Give Amount - Minimum" - creates it if necessary
`CE`	`getGiveCode()` Returns RXE-2: "Give Code" - creates it if necessary
`CE`	`getGiveDosageForm()` Returns RXE-6: "Give Dosage Form" - creates it if necessary
`CE[]`	`getGiveIndication()` Returns all repetitions of Give Indication (RXE-27).
`CE`	`getGiveIndication(int rep)` Returns a specific repetition of RXE-27: "Give Indication" - creates it if necessary
`int`	`getGiveIndicationReps()` Returns a count of the current number of repetitions of Give Indication (RXE-27).
`ST`	`getGivePerTimeUnit()` Returns RXE-22: "Give Per (Time Unit)" - creates it if necessary
`ST`	`getGiveRateAmount()` Returns RXE-23: "Give Rate Amount" - creates it if necessary
`CE`	`getGiveRateUnits()` Returns RXE-24: "Give Rate Units" - creates it if necessary
`NM`	`getGiveStrength()` Returns RXE-25: "Give Strength" - creates it if necessary
`CE`	`getGiveStrengthUnits()` Returns RXE-26: "Give Strength Units" - creates it if necessary
`CE`	`getGiveUnits()` Returns RXE-5: "Give Units" - creates it if necessary
`ID`	`getNeedsHumanReview()` Returns RXE-20: "Needs Human Review" - creates it if necessary
`NM`	`getNumberOfRefills()` Returns RXE-12: "Number of Refills" - creates it if necessary
`NM`	`getNumberOfRefillsDosesDispensed()` Returns RXE-17: "Number of Refills/Doses Dispensed" - creates it if necessary
`NM`	`getNumberOfRefillsRemaining()` Returns RXE-16: "Number of Refills Remaining" - creates it if necessary
`XCN[]`	`getOrderingProviderSDEANumber()` Returns all repetitions of Ordering Provider's DEA Number (RXE-13).
`XCN`	`getOrderingProviderSDEANumber(int rep)` Returns a specific repetition of RXE-13: "Ordering Provider's DEA Number" - creates it if necessary
`int`	`getOrderingProviderSDEANumberReps()` Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXE-13).
`XCN[]`	`getPharmacistTreatmentSupplierSVerifierID()` Returns all repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14).
`XCN`	`getPharmacistTreatmentSupplierSVerifierID(int rep)` Returns a specific repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" - creates it if necessary
`int`	`getPharmacistTreatmentSupplierSVerifierIDReps()` Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14).
`CE[]`	`getPharmacyTreatmentSupplierSSpecialDispensingInstructions()` Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21).
`CE`	`getPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Returns a specific repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
`int`	`getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps()` Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21).
`ST`	`getPrescriptionNumber()` Returns RXE-15: "Prescription Number" - creates it if necessary
`CE[]`	`getProviderSAdministrationInstructions()` Returns all repetitions of Provider's Administration Instructions (RXE-7).
`CE`	`getProviderSAdministrationInstructions(int rep)` Returns a specific repetition of RXE-7: "Provider's Administration Instructions" - creates it if necessary
`int`	`getProviderSAdministrationInstructionsReps()` Returns a count of the current number of repetitions of Provider's Administration Instructions (RXE-7).
`TQ`	`getQuantityTiming()` Returns RXE-1: "Quantity/Timing" - creates it if necessary
`TQ`	`getRxe1_QuantityTiming()` Returns RXE-1: "Quantity/Timing" - creates it if necessary
`NM`	`getRxe10_DispenseAmount()` Returns RXE-10: "Dispense Amount" - creates it if necessary
`CE`	`getRxe11_DispenseUnits()` Returns RXE-11: "Dispense Units" - creates it if necessary
`NM`	`getRxe12_NumberOfRefills()` Returns RXE-12: "Number of Refills" - creates it if necessary
`XCN`	`getRxe13_OrderingProviderSDEANumber(int rep)` Returns a specific repetition of RXE-13: "Ordering Provider's DEA Number" - creates it if necessary
`int`	`getRxe13_OrderingProviderSDEANumberReps()` Returns a count of the current number of repetitions of Ordering Provider's DEA Number (RXE-13).
`XCN`	`getRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)` Returns a specific repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" - creates it if necessary
`int`	`getRxe14_PharmacistTreatmentSupplierSVerifierIDReps()` Returns a count of the current number of repetitions of Pharmacist/Treatment Supplier's Verifier ID (RXE-14).
`ST`	`getRxe15_PrescriptionNumber()` Returns RXE-15: "Prescription Number" - creates it if necessary
`NM`	`getRxe16_NumberOfRefillsRemaining()` Returns RXE-16: "Number of Refills Remaining" - creates it if necessary
`NM`	`getRxe17_NumberOfRefillsDosesDispensed()` Returns RXE-17: "Number of Refills/Doses Dispensed" - creates it if necessary
`TS`	`getRxe18_DTOfMostRecentRefillOrDoseDispensed()` Returns RXE-18: "D/T of Most Recent Refill or Dose Dispensed" - creates it if necessary
`CQ`	`getRxe19_TotalDailyDose()` Returns RXE-19: "Total Daily Dose" - creates it if necessary
`CE`	`getRxe2_GiveCode()` Returns RXE-2: "Give Code" - creates it if necessary
`ID`	`getRxe20_NeedsHumanReview()` Returns RXE-20: "Needs Human Review" - creates it if necessary
`CE`	`getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Returns a specific repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
`int`	`getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps()` Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXE-21).
`ST`	`getRxe22_GivePerTimeUnit()` Returns RXE-22: "Give Per (Time Unit)" - creates it if necessary
`ST`	`getRxe23_GiveRateAmount()` Returns RXE-23: "Give Rate Amount" - creates it if necessary
`CE`	`getRxe24_GiveRateUnits()` Returns RXE-24: "Give Rate Units" - creates it if necessary
`NM`	`getRxe25_GiveStrength()` Returns RXE-25: "Give Strength" - creates it if necessary
`CE`	`getRxe26_GiveStrengthUnits()` Returns RXE-26: "Give Strength Units" - creates it if necessary
`CE`	`getRxe27_GiveIndication(int rep)` Returns a specific repetition of RXE-27: "Give Indication" - creates it if necessary
`int`	`getRxe27_GiveIndicationReps()` Returns a count of the current number of repetitions of Give Indication (RXE-27).
`NM`	`getRxe28_DispensePackageSize()` Returns RXE-28: "Dispense Package Size" - creates it if necessary
`CE`	`getRxe29_DispensePackageSizeUnit()` Returns RXE-29: "Dispense Package Size Unit" - creates it if necessary
`NM`	`getRxe3_GiveAmountMinimum()` Returns RXE-3: "Give Amount - Minimum" - creates it if necessary
`ID`	`getRxe30_DispensePackageMethod()` Returns RXE-30: "Dispense Package Method" - creates it if necessary
`CE`	`getRxe31_SupplementaryCode(int rep)` Returns a specific repetition of RXE-31: "Supplementary Code" - creates it if necessary
`int`	`getRxe31_SupplementaryCodeReps()` Returns a count of the current number of repetitions of Supplementary Code (RXE-31).
`NM`	`getRxe4_GiveAmountMaximum()` Returns RXE-4: "Give Amount - Maximum" - creates it if necessary
`CE`	`getRxe5_GiveUnits()` Returns RXE-5: "Give Units" - creates it if necessary
`CE`	`getRxe6_GiveDosageForm()` Returns RXE-6: "Give Dosage Form" - creates it if necessary
`CE`	`getRxe7_ProviderSAdministrationInstructions(int rep)` Returns a specific repetition of RXE-7: "Provider's Administration Instructions" - creates it if necessary
`int`	`getRxe7_ProviderSAdministrationInstructionsReps()` Returns a count of the current number of repetitions of Provider's Administration Instructions (RXE-7).
`LA1`	`getRxe8_DeliverToLocation()` Returns RXE-8: "Deliver-To Location" - creates it if necessary
`ID`	`getRxe9_SubstitutionStatus()` Returns RXE-9: "Substitution Status" - creates it if necessary
`ID`	`getSubstitutionStatus()` Returns RXE-9: "Substitution Status" - creates it if necessary
`CE[]`	`getSupplementaryCode()` Returns all repetitions of Supplementary Code (RXE-31).
`CE`	`getSupplementaryCode(int rep)` Returns a specific repetition of RXE-31: "Supplementary Code" - creates it if necessary
`int`	`getSupplementaryCodeReps()` Returns a count of the current number of repetitions of Supplementary Code (RXE-31).
`CQ`	`getTotalDailyDose()` Returns RXE-19: "Total Daily Dose" - creates it if necessary
`CE`	`insertGiveIndication(int rep)` Inserts a repetition of RXE-27: "Give Indication" at a specific index
`XCN`	`insertOrderingProviderSDEANumber(int rep)` Inserts a repetition of RXE-13: "Ordering Provider's DEA Number" at a specific index
`XCN`	`insertPharmacistTreatmentSupplierSVerifierID(int rep)` Inserts a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" at a specific index
`CE`	`insertPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Inserts a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`CE`	`insertProviderSAdministrationInstructions(int rep)` Inserts a repetition of RXE-7: "Provider's Administration Instructions" at a specific index
`XCN`	`insertRxe13_OrderingProviderSDEANumber(int rep)` Inserts a repetition of RXE-13: "Ordering Provider's DEA Number" at a specific index
`XCN`	`insertRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)` Inserts a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" at a specific index
`CE`	`insertRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Inserts a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`CE`	`insertRxe27_GiveIndication(int rep)` Inserts a repetition of RXE-27: "Give Indication" at a specific index
`CE`	`insertRxe31_SupplementaryCode(int rep)` Inserts a repetition of RXE-31: "Supplementary Code" at a specific index
`CE`	`insertRxe7_ProviderSAdministrationInstructions(int rep)` Inserts a repetition of RXE-7: "Provider's Administration Instructions" at a specific index
`CE`	`insertSupplementaryCode(int rep)` Inserts a repetition of RXE-31: "Supplementary Code" at a specific index
`CE`	`removeGiveIndication(int rep)` Removes a repetition of RXE-27: "Give Indication" at a specific index
`XCN`	`removeOrderingProviderSDEANumber(int rep)` Removes a repetition of RXE-13: "Ordering Provider's DEA Number" at a specific index
`XCN`	`removePharmacistTreatmentSupplierSVerifierID(int rep)` Removes a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" at a specific index
`CE`	`removePharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Removes a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`CE`	`removeProviderSAdministrationInstructions(int rep)` Removes a repetition of RXE-7: "Provider's Administration Instructions" at a specific index
`XCN`	`removeRxe13_OrderingProviderSDEANumber(int rep)` Removes a repetition of RXE-13: "Ordering Provider's DEA Number" at a specific index
`XCN`	`removeRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)` Removes a repetition of RXE-14: "Pharmacist/Treatment Supplier's Verifier ID" at a specific index
`CE`	`removeRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Removes a repetition of RXE-21: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`CE`	`removeRxe27_GiveIndication(int rep)` Removes a repetition of RXE-27: "Give Indication" at a specific index
`CE`	`removeRxe31_SupplementaryCode(int rep)` Removes a repetition of RXE-31: "Supplementary Code" at a specific index
`CE`	`removeRxe7_ProviderSAdministrationInstructions(int rep)` Removes a repetition of RXE-7: "Provider's Administration Instructions" at a specific index
`CE`	`removeSupplementaryCode(int rep)` Removes a repetition of RXE-31: "Supplementary Code" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
`add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RXE

public RXE(Group parent,
           ModelClassFactory factory)

Creates a new RXE segment

Method Detail

getQuantityTiming

public TQ getQuantityTiming()

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

getRxe1_QuantityTiming

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

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).

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()

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 LA1 getDeliverToLocation()

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

getRxe8_DeliverToLocation

public 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 XCN[] getOrderingProviderSDEANumber()

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

getOrderingProviderSDEANumberReps

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

public XCN getOrderingProviderSDEANumber(int rep)

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

public XCN getRxe13_OrderingProviderSDEANumber(int rep)

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

public int getRxe13_OrderingProviderSDEANumberReps()

insertOrderingProviderSDEANumber

public XCN insertOrderingProviderSDEANumber(int rep)
                                     throws HL7Exception

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

public XCN insertRxe13_OrderingProviderSDEANumber(int rep)
                                           throws HL7Exception

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

public XCN removeOrderingProviderSDEANumber(int rep)
                                     throws HL7Exception

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

public XCN removeRxe13_OrderingProviderSDEANumber(int rep)
                                           throws HL7Exception

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

public XCN[] getPharmacistTreatmentSupplierSVerifierID()

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

getPharmacistTreatmentSupplierSVerifierIDReps

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

public XCN getPharmacistTreatmentSupplierSVerifierID(int rep)

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

public XCN getRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)

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

public int getRxe14_PharmacistTreatmentSupplierSVerifierIDReps()

insertPharmacistTreatmentSupplierSVerifierID

public XCN insertPharmacistTreatmentSupplierSVerifierID(int rep)
                                                 throws HL7Exception

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

public XCN insertRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)
                                                       throws HL7Exception

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

public XCN removePharmacistTreatmentSupplierSVerifierID(int rep)
                                                 throws HL7Exception

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

public XCN removeRxe14_PharmacistTreatmentSupplierSVerifierID(int rep)
                                                       throws HL7Exception

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

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

getDTOfMostRecentRefillOrDoseDispensed

public TS getDTOfMostRecentRefillOrDoseDispensed()

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

getRxe18_DTOfMostRecentRefillOrDoseDispensed

public TS getRxe18_DTOfMostRecentRefillOrDoseDispensed()

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

getTotalDailyDose

public CQ getTotalDailyDose()

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

getRxe19_TotalDailyDose

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

getPharmacyTreatmentSupplierSSpecialDispensingInstructions

public CE[] getPharmacyTreatmentSupplierSSpecialDispensingInstructions()

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

getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

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

public CE getPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)

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

public CE getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)

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

public int getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps()

insertPharmacyTreatmentSupplierSSpecialDispensingInstructions

public CE insertPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)
                                                                 throws HL7Exception

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

public CE insertRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)
                                                                       throws HL7Exception

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

public CE removePharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)
                                                                 throws HL7Exception

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

public CE removeRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)
                                                                       throws HL7Exception

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

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 ST getGiveRateAmount()

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

getRxe23_GiveRateAmount

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

getGiveStrength

public NM getGiveStrength()

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

getRxe25_GiveStrength

public NM getRxe25_GiveStrength()

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

getGiveStrengthUnits

public CE getGiveStrengthUnits()

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

getRxe26_GiveStrengthUnits

public CE getRxe26_GiveStrengthUnits()

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

getGiveIndication

public CE[] getGiveIndication()

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

public int getRxe27_GiveIndicationReps()

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

public NM getDispensePackageSize()

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

getRxe28_DispensePackageSize

public NM getRxe28_DispensePackageSize()

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

getDispensePackageSizeUnit

public CE getDispensePackageSizeUnit()

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

getRxe29_DispensePackageSizeUnit

public CE getRxe29_DispensePackageSizeUnit()

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

getDispensePackageMethod

public ID getDispensePackageMethod()

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

getRxe30_DispensePackageMethod

public ID getRxe30_DispensePackageMethod()

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

getSupplementaryCode

public CE[] getSupplementaryCode()

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

getSupplementaryCodeReps

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

public int getRxe31_SupplementaryCodeReps()

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

public CE insertRxe31_SupplementaryCode(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)

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

public CE removeRxe31_SupplementaryCode(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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:: createNewTypeWithoutReflection in class AbstractSegment

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ca.uhn.hl7v2.model.v24.segment Class RXE

RXE

getQuantityTiming

getRxe1_QuantityTiming

getGiveCode

getRxe2_GiveCode

getGiveAmountMinimum

getRxe3_GiveAmountMinimum

getGiveAmountMaximum

getRxe4_GiveAmountMaximum

getGiveUnits

getRxe5_GiveUnits

getGiveDosageForm

getRxe6_GiveDosageForm

getProviderSAdministrationInstructions

getProviderSAdministrationInstructionsReps

getProviderSAdministrationInstructions

getRxe7_ProviderSAdministrationInstructions

getRxe7_ProviderSAdministrationInstructionsReps

insertProviderSAdministrationInstructions

insertRxe7_ProviderSAdministrationInstructions

removeProviderSAdministrationInstructions

removeRxe7_ProviderSAdministrationInstructions

getDeliverToLocation

getRxe8_DeliverToLocation

getSubstitutionStatus

getRxe9_SubstitutionStatus

getDispenseAmount

getRxe10_DispenseAmount

getDispenseUnits

getRxe11_DispenseUnits

getNumberOfRefills

getRxe12_NumberOfRefills

getOrderingProviderSDEANumber

getOrderingProviderSDEANumberReps

getOrderingProviderSDEANumber

getRxe13_OrderingProviderSDEANumber

getRxe13_OrderingProviderSDEANumberReps

insertOrderingProviderSDEANumber

insertRxe13_OrderingProviderSDEANumber

removeOrderingProviderSDEANumber

removeRxe13_OrderingProviderSDEANumber

getPharmacistTreatmentSupplierSVerifierID

getPharmacistTreatmentSupplierSVerifierIDReps

getPharmacistTreatmentSupplierSVerifierID

getRxe14_PharmacistTreatmentSupplierSVerifierID

getRxe14_PharmacistTreatmentSupplierSVerifierIDReps

insertPharmacistTreatmentSupplierSVerifierID

insertRxe14_PharmacistTreatmentSupplierSVerifierID

removePharmacistTreatmentSupplierSVerifierID

removeRxe14_PharmacistTreatmentSupplierSVerifierID

getPrescriptionNumber

getRxe15_PrescriptionNumber

getNumberOfRefillsRemaining

getRxe16_NumberOfRefillsRemaining

getNumberOfRefillsDosesDispensed

getRxe17_NumberOfRefillsDosesDispensed

getDTOfMostRecentRefillOrDoseDispensed

getRxe18_DTOfMostRecentRefillOrDoseDispensed

getTotalDailyDose

getRxe19_TotalDailyDose

getNeedsHumanReview

getRxe20_NeedsHumanReview

getPharmacyTreatmentSupplierSSpecialDispensingInstructions

getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

getPharmacyTreatmentSupplierSSpecialDispensingInstructions

getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

getRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

insertPharmacyTreatmentSupplierSSpecialDispensingInstructions

insertRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

removePharmacyTreatmentSupplierSSpecialDispensingInstructions

removeRxe21_PharmacyTreatmentSupplierSSpecialDispensingInstructions

getGivePerTimeUnit

getRxe22_GivePerTimeUnit

getGiveRateAmount

getRxe23_GiveRateAmount

getGiveRateUnits

getRxe24_GiveRateUnits

getGiveStrength

getRxe25_GiveStrength

ca.uhn.hl7v2.model.v24.segment
Class RXE