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

Class RXD

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

Represents an HL7 RXD message segment (PHARMACY DISPENSE). This segment has the following fields:

  • RXD-1: Dispense Sub-ID Counter (NM) optional
  • RXD-2: Dispense / give code (CE)
  • RXD-3: Date / time dispensed (TS) optional
  • 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 (ST) optional repeating
  • RXD-10: Dispensing Provider (CN) optional
  • RXD-11: Substitution Status (ID) optional
  • RXD-12: Total Daily Dose (CQ_QUANTITY) optional
  • RXD-13: Deliver-to location (CM_LA1) optional
  • RXD-14: Needs Human Review (ID) optional
  • RXD-15: Pharmacy Special Dispensing Instructions (CE) 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 ST[] getDispenseNotes()
      Returns all repetitions of Dispense Notes (RXD-9).

    • getRxd9_DispenseNotes

      public ST[] 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 ST 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 ST 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 ST 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 ST 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 ST 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 ST 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 CN getDispensingProvider()
      Returns RXD-10: "Dispensing Provider" - creates it if necessary

    • getRxd10_DispensingProvider

      public CN 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_QUANTITY getTotalDailyDose()
      Returns RXD-12: "Total Daily Dose" - creates it if necessary

    • getRxd12_TotalDailyDose

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

    • getDeliverToLocation

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

    • getRxd13_DeliverToLocation

      public CM_LA1 getRxd13_DeliverToLocation()
      Returns RXD-13: "Deliver-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

    • getPharmacySpecialDispensingInstructions

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

    • getRxd15_PharmacySpecialDispensingInstructions

      public CE getRxd15_PharmacySpecialDispensingInstructions()
      Returns RXD-15: "Pharmacy Special Dispensing Instructions" - creates it if necessary

    • createNewTypeWithoutReflection

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