Package ca.uhn.hl7v2.model.v23.segment

Class RXD

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

Represents an HL7 RXD message segment (Pharmacy dispense segment). This segment has the following fields:

  • RXD-1: Dispense Sub-ID Counter (NM)
  • RXD-2: Dispense/Give Code (CE)
  • RXD-3: Date/Time Dispensed (TS)
  • RXD-4: Actual Dispense Amount (NM)
  • RXD-5: Actual Dispense Units (CE) optional
  • RXD-6: Actual Dosage Form (CE) optional
  • RXD-7: Prescription Number (ST)
  • RXD-8: Number of Refills Remaining (NM) optional
  • RXD-9: Dispense Notes (CE) optional repeating
  • RXD-10: Dispensing Provider (XCN) optional
  • RXD-11: Substitution Status (ID) optional
  • RXD-12: Total Daily Dose (CQ) optional
  • RXD-13: Dispense-To Location (CM_LA1) optional
  • RXD-14: Needs Human Review (ID) optional
  • RXD-15: Pharmacy/Treatment Supplier's Special Dispensing Instructions (CE) optional repeating
  • RXD-16: Actual Strength (NM) optional
  • RXD-17: Actual Strength Unit (CE) optional
  • RXD-18: Substance Lot Number (ST) optional repeating
  • RXD-19: Substance Expiration Date (TS) optional repeating
  • RXD-20: Substance Manufacturer Name (CE) optional repeating
  • RXD-21: Indication (CE) optional
  • RXD-22: Dispense Package Size (NM) optional
  • RXD-23: Dispense Package Size Unit (CE) optional
  • RXD-24: Dispense Package Method (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getDispenseSubIDCounter

      public NM getDispenseSubIDCounter()
      Returns RXD-1: "Dispense Sub-ID Counter" - creates it if necessary

    • getRxd1_DispenseSubIDCounter

      public NM getRxd1_DispenseSubIDCounter()
      Returns RXD-1: "Dispense Sub-ID Counter" - creates it if necessary

    • getDispenseGiveCode

      public CE getDispenseGiveCode()
      Returns RXD-2: "Dispense/Give Code" - creates it if necessary

    • getRxd2_DispenseGiveCode

      public CE getRxd2_DispenseGiveCode()
      Returns RXD-2: "Dispense/Give Code" - creates it if necessary

    • getDateTimeDispensed

      public TS getDateTimeDispensed()
      Returns RXD-3: "Date/Time Dispensed" - creates it if necessary

    • getRxd3_DateTimeDispensed

      public TS getRxd3_DateTimeDispensed()
      Returns RXD-3: "Date/Time Dispensed" - creates it if necessary

    • getActualDispenseAmount

      public NM getActualDispenseAmount()
      Returns RXD-4: "Actual Dispense Amount" - creates it if necessary

    • getRxd4_ActualDispenseAmount

      public NM getRxd4_ActualDispenseAmount()
      Returns RXD-4: "Actual Dispense Amount" - creates it if necessary

    • getActualDispenseUnits

      public CE getActualDispenseUnits()
      Returns RXD-5: "Actual Dispense Units" - creates it if necessary

    • getRxd5_ActualDispenseUnits

      public CE getRxd5_ActualDispenseUnits()
      Returns RXD-5: "Actual Dispense Units" - creates it if necessary

    • getActualDosageForm

      public CE getActualDosageForm()
      Returns RXD-6: "Actual Dosage Form" - creates it if necessary

    • getRxd6_ActualDosageForm

      public CE getRxd6_ActualDosageForm()
      Returns RXD-6: "Actual Dosage Form" - creates it if necessary

    • getPrescriptionNumber

      public ST getPrescriptionNumber()
      Returns RXD-7: "Prescription Number" - creates it if necessary

    • getRxd7_PrescriptionNumber

      public ST getRxd7_PrescriptionNumber()
      Returns RXD-7: "Prescription Number" - creates it if necessary

    • getNumberOfRefillsRemaining

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

    • getRxd8_NumberOfRefillsRemaining

      public NM getRxd8_NumberOfRefillsRemaining()
      Returns RXD-8: "Number of Refills Remaining" - creates it if necessary

    • getDispenseNotes

      public CE[] getDispenseNotes()
      Returns all repetitions of Dispense Notes (RXD-9).

    • getRxd9_DispenseNotes

      public CE[] getRxd9_DispenseNotes()
      Returns all repetitions of Dispense Notes (RXD-9).

    • getDispenseNotesReps

      public int getDispenseNotesReps()
      Returns a count of the current number of repetitions of Dispense Notes (RXD-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getDispenseNotes

      public CE getDispenseNotes(int rep)
      Returns a specific repetition of RXD-9: "Dispense Notes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd9_DispenseNotes

      public CE getRxd9_DispenseNotes(int rep)
      Returns a specific repetition of RXD-9: "Dispense Notes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd9_DispenseNotesReps

      public int getRxd9_DispenseNotesReps()
      Returns a count of the current number of repetitions of Dispense Notes (RXD-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertDispenseNotes

      public CE insertDispenseNotes(int rep) throws HL7Exception
      Inserts a repetition of RXD-9: "Dispense Notes" 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)

    • insertRxd9_DispenseNotes

      public CE insertRxd9_DispenseNotes(int rep) throws HL7Exception
      Inserts a repetition of RXD-9: "Dispense Notes" 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)

    • removeDispenseNotes

      public CE removeDispenseNotes(int rep) throws HL7Exception
      Removes a repetition of RXD-9: "Dispense Notes" 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)

    • removeRxd9_DispenseNotes

      public CE removeRxd9_DispenseNotes(int rep) throws HL7Exception
      Removes a repetition of RXD-9: "Dispense Notes" 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)

    • getDispensingProvider

      public XCN getDispensingProvider()
      Returns RXD-10: "Dispensing Provider" - creates it if necessary

    • getRxd10_DispensingProvider

      public XCN getRxd10_DispensingProvider()
      Returns RXD-10: "Dispensing Provider" - creates it if necessary

    • getSubstitutionStatus

      public ID getSubstitutionStatus()
      Returns RXD-11: "Substitution Status" - creates it if necessary

    • getRxd11_SubstitutionStatus

      public ID getRxd11_SubstitutionStatus()
      Returns RXD-11: "Substitution Status" - creates it if necessary

    • getTotalDailyDose

      public CQ getTotalDailyDose()
      Returns RXD-12: "Total Daily Dose" - creates it if necessary

    • getRxd12_TotalDailyDose

      public CQ getRxd12_TotalDailyDose()
      Returns RXD-12: "Total Daily Dose" - creates it if necessary

    • getDispenseToLocation

      public CM_LA1 getDispenseToLocation()
      Returns RXD-13: "Dispense-To Location" - creates it if necessary

    • getRxd13_DispenseToLocation

      public CM_LA1 getRxd13_DispenseToLocation()
      Returns RXD-13: "Dispense-To Location" - creates it if necessary

    • getNeedsHumanReview

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

    • getRxd14_NeedsHumanReview

      public ID getRxd14_NeedsHumanReview()
      Returns RXD-14: "Needs Human Review" - creates it if necessary

    • getPharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE[] getPharmacyTreatmentSupplierSSpecialDispensingInstructions()
      Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXD-15).

    • getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE[] getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions()
      Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXD-15).

    • getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

      public int getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps()
      Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXD-15). 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 RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)
      Returns a specific repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

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

    • insertPharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE insertPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep) throws HL7Exception
      Inserts a repetition of RXD-15: "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)

    • insertRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE insertRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep) throws HL7Exception
      Inserts a repetition of RXD-15: "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 RXD-15: "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)

    • removeRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

      public CE removeRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep) throws HL7Exception
      Removes a repetition of RXD-15: "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)

    • getActualStrength

      public NM getActualStrength()
      Returns RXD-16: "Actual Strength" - creates it if necessary

    • getRxd16_ActualStrength

      public NM getRxd16_ActualStrength()
      Returns RXD-16: "Actual Strength" - creates it if necessary

    • getActualStrengthUnit

      public CE getActualStrengthUnit()
      Returns RXD-17: "Actual Strength Unit" - creates it if necessary

    • getRxd17_ActualStrengthUnit

      public CE getRxd17_ActualStrengthUnit()
      Returns RXD-17: "Actual Strength Unit" - creates it if necessary

    • getSubstanceLotNumber

      public ST[] getSubstanceLotNumber()
      Returns all repetitions of Substance Lot Number (RXD-18).

    • getRxd18_SubstanceLotNumber

      public ST[] getRxd18_SubstanceLotNumber()
      Returns all repetitions of Substance Lot Number (RXD-18).

    • getSubstanceLotNumberReps

      public int getSubstanceLotNumberReps()
      Returns a count of the current number of repetitions of Substance Lot Number (RXD-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSubstanceLotNumber

      public ST getSubstanceLotNumber(int rep)
      Returns a specific repetition of RXD-18: "Substance Lot Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd18_SubstanceLotNumber

      public ST getRxd18_SubstanceLotNumber(int rep)
      Returns a specific repetition of RXD-18: "Substance Lot Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd18_SubstanceLotNumberReps

      public int getRxd18_SubstanceLotNumberReps()
      Returns a count of the current number of repetitions of Substance Lot Number (RXD-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSubstanceLotNumber

      public ST insertSubstanceLotNumber(int rep) throws HL7Exception
      Inserts a repetition of RXD-18: "Substance Lot 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)

    • insertRxd18_SubstanceLotNumber

      public ST insertRxd18_SubstanceLotNumber(int rep) throws HL7Exception
      Inserts a repetition of RXD-18: "Substance Lot 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)

    • removeSubstanceLotNumber

      public ST removeSubstanceLotNumber(int rep) throws HL7Exception
      Removes a repetition of RXD-18: "Substance Lot 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)

    • removeRxd18_SubstanceLotNumber

      public ST removeRxd18_SubstanceLotNumber(int rep) throws HL7Exception
      Removes a repetition of RXD-18: "Substance Lot 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)

    • getSubstanceExpirationDate

      public TS[] getSubstanceExpirationDate()
      Returns all repetitions of Substance Expiration Date (RXD-19).

    • getRxd19_SubstanceExpirationDate

      public TS[] getRxd19_SubstanceExpirationDate()
      Returns all repetitions of Substance Expiration Date (RXD-19).

    • getSubstanceExpirationDateReps

      public int getSubstanceExpirationDateReps()
      Returns a count of the current number of repetitions of Substance Expiration Date (RXD-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSubstanceExpirationDate

      public TS getSubstanceExpirationDate(int rep)
      Returns a specific repetition of RXD-19: "Substance Expiration Date" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd19_SubstanceExpirationDate

      public TS getRxd19_SubstanceExpirationDate(int rep)
      Returns a specific repetition of RXD-19: "Substance Expiration Date" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd19_SubstanceExpirationDateReps

      public int getRxd19_SubstanceExpirationDateReps()
      Returns a count of the current number of repetitions of Substance Expiration Date (RXD-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSubstanceExpirationDate

      public TS insertSubstanceExpirationDate(int rep) throws HL7Exception
      Inserts a repetition of RXD-19: "Substance Expiration Date" 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)

    • insertRxd19_SubstanceExpirationDate

      public TS insertRxd19_SubstanceExpirationDate(int rep) throws HL7Exception
      Inserts a repetition of RXD-19: "Substance Expiration Date" 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)

    • removeSubstanceExpirationDate

      public TS removeSubstanceExpirationDate(int rep) throws HL7Exception
      Removes a repetition of RXD-19: "Substance Expiration Date" 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)

    • removeRxd19_SubstanceExpirationDate

      public TS removeRxd19_SubstanceExpirationDate(int rep) throws HL7Exception
      Removes a repetition of RXD-19: "Substance Expiration Date" 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)

    • getSubstanceManufacturerName

      public CE[] getSubstanceManufacturerName()
      Returns all repetitions of Substance Manufacturer Name (RXD-20).

    • getRxd20_SubstanceManufacturerName

      public CE[] getRxd20_SubstanceManufacturerName()
      Returns all repetitions of Substance Manufacturer Name (RXD-20).

    • getSubstanceManufacturerNameReps

      public int getSubstanceManufacturerNameReps()
      Returns a count of the current number of repetitions of Substance Manufacturer Name (RXD-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSubstanceManufacturerName

      public CE getSubstanceManufacturerName(int rep)
      Returns a specific repetition of RXD-20: "Substance Manufacturer Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd20_SubstanceManufacturerName

      public CE getRxd20_SubstanceManufacturerName(int rep)
      Returns a specific repetition of RXD-20: "Substance Manufacturer Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxd20_SubstanceManufacturerNameReps

      public int getRxd20_SubstanceManufacturerNameReps()
      Returns a count of the current number of repetitions of Substance Manufacturer Name (RXD-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSubstanceManufacturerName

      public CE insertSubstanceManufacturerName(int rep) throws HL7Exception
      Inserts a repetition of RXD-20: "Substance Manufacturer Name" 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)

    • insertRxd20_SubstanceManufacturerName

      public CE insertRxd20_SubstanceManufacturerName(int rep) throws HL7Exception
      Inserts a repetition of RXD-20: "Substance Manufacturer Name" 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)

    • removeSubstanceManufacturerName

      public CE removeSubstanceManufacturerName(int rep) throws HL7Exception
      Removes a repetition of RXD-20: "Substance Manufacturer Name" 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)

    • removeRxd20_SubstanceManufacturerName

      public CE removeRxd20_SubstanceManufacturerName(int rep) throws HL7Exception
      Removes a repetition of RXD-20: "Substance Manufacturer Name" 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)

    • getIndication

      public CE getIndication()
      Returns RXD-21: "Indication" - creates it if necessary

    • getRxd21_Indication

      public CE getRxd21_Indication()
      Returns RXD-21: "Indication" - creates it if necessary

    • getDispensePackageSize

      public NM getDispensePackageSize()
      Returns RXD-22: "Dispense Package Size" - creates it if necessary

    • getRxd22_DispensePackageSize

      public NM getRxd22_DispensePackageSize()
      Returns RXD-22: "Dispense Package Size" - creates it if necessary

    • getDispensePackageSizeUnit

      public CE getDispensePackageSizeUnit()
      Returns RXD-23: "Dispense Package Size Unit" - creates it if necessary

    • getRxd23_DispensePackageSizeUnit

      public CE getRxd23_DispensePackageSizeUnit()
      Returns RXD-23: "Dispense Package Size Unit" - creates it if necessary

    • getDispensePackageMethod

      public ID getDispensePackageMethod()
      Returns RXD-24: "Dispense Package Method" - creates it if necessary

    • getRxd24_DispensePackageMethod

      public ID getRxd24_DispensePackageMethod()
      Returns RXD-24: "Dispense Package Method" - creates it if necessary

    • createNewTypeWithoutReflection

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