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

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

All Implemented Interfaces:: Segment, Structure, Serializable

public class RXD
extends AbstractSegment
extends AbstractSegment

Represents an HL7 RXD message segment (Pharmacy/Treatment Dispense). 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 (ST) optional repeating
RXD-10: Dispensing Provider (XCN) optional repeating
RXD-11: Substitution Status (ID) optional
RXD-12: Total Daily Dose (CQ) optional
RXD-13: Dispense-To Location (LA2) 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 repeating
RXD-22: Dispense Package Size (NM) optional
RXD-23: Dispense Package Size Unit (CE) optional
RXD-24: Dispense Package Method (ID) optional
RXD-25: Supplementary Code (CE) optional repeating
RXD-26: Initiating Location (CE) optional
RXD-27: Packaging/Assembly Location (CE) optional

See Also:: Serialized Form

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

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`NM`	`getActualDispenseAmount()` Returns RXD-4: "Actual Dispense Amount" - creates it if necessary
`CE`	`getActualDispenseUnits()` Returns RXD-5: "Actual Dispense Units" - creates it if necessary
`CE`	`getActualDosageForm()` Returns RXD-6: "Actual Dosage Form" - creates it if necessary
`NM`	`getActualStrength()` Returns RXD-16: "Actual Strength" - creates it if necessary
`CE`	`getActualStrengthUnit()` Returns RXD-17: "Actual Strength Unit" - creates it if necessary
`TS`	`getDateTimeDispensed()` Returns RXD-3: "Date/Time Dispensed" - creates it if necessary
`CE`	`getDispenseGiveCode()` Returns RXD-2: "Dispense/Give Code" - creates it if necessary
`ST[]`	`getDispenseNotes()` Returns all repetitions of Dispense Notes (RXD-9).
`ST`	`getDispenseNotes(int rep)` Returns a specific repetition of RXD-9: "Dispense Notes" - creates it if necessary
`int`	`getDispenseNotesReps()` Returns a count of the current number of repetitions of Dispense Notes (RXD-9).
`ID`	`getDispensePackageMethod()` Returns RXD-24: "Dispense Package Method" - creates it if necessary
`NM`	`getDispensePackageSize()` Returns RXD-22: "Dispense Package Size" - creates it if necessary
`CE`	`getDispensePackageSizeUnit()` Returns RXD-23: "Dispense Package Size Unit" - creates it if necessary
`NM`	`getDispenseSubIDCounter()` Returns RXD-1: "Dispense Sub-ID Counter" - creates it if necessary
`LA2`	`getDispenseToLocation()` Returns RXD-13: "Dispense-To Location" - creates it if necessary
`XCN[]`	`getDispensingProvider()` Returns all repetitions of Dispensing Provider (RXD-10).
`XCN`	`getDispensingProvider(int rep)` Returns a specific repetition of RXD-10: "Dispensing Provider" - creates it if necessary
`int`	`getDispensingProviderReps()` Returns a count of the current number of repetitions of Dispensing Provider (RXD-10).
`CE[]`	`getIndication()` Returns all repetitions of Indication (RXD-21).
`CE`	`getIndication(int rep)` Returns a specific repetition of RXD-21: "Indication" - creates it if necessary
`int`	`getIndicationReps()` Returns a count of the current number of repetitions of Indication (RXD-21).
`CE`	`getInitiatingLocation()` Returns RXD-26: "Initiating Location" - creates it if necessary
`ID`	`getNeedsHumanReview()` Returns RXD-14: "Needs Human Review" - creates it if necessary
`NM`	`getNumberOfRefillsRemaining()` Returns RXD-8: "Number of Refills Remaining" - creates it if necessary
`CE`	`getPackagingAssemblyLocation()` Returns RXD-27: "Packaging/Assembly Location" - creates it if necessary
`CE[]`	`getPharmacyTreatmentSupplierSSpecialDispensingInstructions()` Returns all repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXD-15).
`CE`	`getPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Returns a specific repetition of RXD-15: "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 (RXD-15).
`ST`	`getPrescriptionNumber()` Returns RXD-7: "Prescription Number" - creates it if necessary
`NM`	`getRxd1_DispenseSubIDCounter()` Returns RXD-1: "Dispense Sub-ID Counter" - creates it if necessary
`XCN`	`getRxd10_DispensingProvider(int rep)` Returns a specific repetition of RXD-10: "Dispensing Provider" - creates it if necessary
`int`	`getRxd10_DispensingProviderReps()` Returns a count of the current number of repetitions of Dispensing Provider (RXD-10).
`ID`	`getRxd11_SubstitutionStatus()` Returns RXD-11: "Substitution Status" - creates it if necessary
`CQ`	`getRxd12_TotalDailyDose()` Returns RXD-12: "Total Daily Dose" - creates it if necessary
`LA2`	`getRxd13_DispenseToLocation()` Returns RXD-13: "Dispense-To Location" - creates it if necessary
`ID`	`getRxd14_NeedsHumanReview()` Returns RXD-14: "Needs Human Review" - creates it if necessary
`CE`	`getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Returns a specific repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" - creates it if necessary
`int`	`getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps()` Returns a count of the current number of repetitions of Pharmacy/Treatment Supplier's Special Dispensing Instructions (RXD-15).
`NM`	`getRxd16_ActualStrength()` Returns RXD-16: "Actual Strength" - creates it if necessary
`CE`	`getRxd17_ActualStrengthUnit()` Returns RXD-17: "Actual Strength Unit" - creates it if necessary
`ST`	`getRxd18_SubstanceLotNumber(int rep)` Returns a specific repetition of RXD-18: "Substance Lot Number" - creates it if necessary
`int`	`getRxd18_SubstanceLotNumberReps()` Returns a count of the current number of repetitions of Substance Lot Number (RXD-18).
`TS`	`getRxd19_SubstanceExpirationDate(int rep)` Returns a specific repetition of RXD-19: "Substance Expiration Date" - creates it if necessary
`int`	`getRxd19_SubstanceExpirationDateReps()` Returns a count of the current number of repetitions of Substance Expiration Date (RXD-19).
`CE`	`getRxd2_DispenseGiveCode()` Returns RXD-2: "Dispense/Give Code" - creates it if necessary
`CE`	`getRxd20_SubstanceManufacturerName(int rep)` Returns a specific repetition of RXD-20: "Substance Manufacturer Name" - creates it if necessary
`int`	`getRxd20_SubstanceManufacturerNameReps()` Returns a count of the current number of repetitions of Substance Manufacturer Name (RXD-20).
`CE`	`getRxd21_Indication(int rep)` Returns a specific repetition of RXD-21: "Indication" - creates it if necessary
`int`	`getRxd21_IndicationReps()` Returns a count of the current number of repetitions of Indication (RXD-21).
`NM`	`getRxd22_DispensePackageSize()` Returns RXD-22: "Dispense Package Size" - creates it if necessary
`CE`	`getRxd23_DispensePackageSizeUnit()` Returns RXD-23: "Dispense Package Size Unit" - creates it if necessary
`ID`	`getRxd24_DispensePackageMethod()` Returns RXD-24: "Dispense Package Method" - creates it if necessary
`CE`	`getRxd25_SupplementaryCode(int rep)` Returns a specific repetition of RXD-25: "Supplementary Code" - creates it if necessary
`int`	`getRxd25_SupplementaryCodeReps()` Returns a count of the current number of repetitions of Supplementary Code (RXD-25).
`CE`	`getRxd26_InitiatingLocation()` Returns RXD-26: "Initiating Location" - creates it if necessary
`CE`	`getRxd27_PackagingAssemblyLocation()` Returns RXD-27: "Packaging/Assembly Location" - creates it if necessary
`TS`	`getRxd3_DateTimeDispensed()` Returns RXD-3: "Date/Time Dispensed" - creates it if necessary
`NM`	`getRxd4_ActualDispenseAmount()` Returns RXD-4: "Actual Dispense Amount" - creates it if necessary
`CE`	`getRxd5_ActualDispenseUnits()` Returns RXD-5: "Actual Dispense Units" - creates it if necessary
`CE`	`getRxd6_ActualDosageForm()` Returns RXD-6: "Actual Dosage Form" - creates it if necessary
`ST`	`getRxd7_PrescriptionNumber()` Returns RXD-7: "Prescription Number" - creates it if necessary
`NM`	`getRxd8_NumberOfRefillsRemaining()` Returns RXD-8: "Number of Refills Remaining" - creates it if necessary
`ST`	`getRxd9_DispenseNotes(int rep)` Returns a specific repetition of RXD-9: "Dispense Notes" - creates it if necessary
`int`	`getRxd9_DispenseNotesReps()` Returns a count of the current number of repetitions of Dispense Notes (RXD-9).
`TS[]`	`getSubstanceExpirationDate()` Returns all repetitions of Substance Expiration Date (RXD-19).
`TS`	`getSubstanceExpirationDate(int rep)` Returns a specific repetition of RXD-19: "Substance Expiration Date" - creates it if necessary
`int`	`getSubstanceExpirationDateReps()` Returns a count of the current number of repetitions of Substance Expiration Date (RXD-19).
`ST[]`	`getSubstanceLotNumber()` Returns all repetitions of Substance Lot Number (RXD-18).
`ST`	`getSubstanceLotNumber(int rep)` Returns a specific repetition of RXD-18: "Substance Lot Number" - creates it if necessary
`int`	`getSubstanceLotNumberReps()` Returns a count of the current number of repetitions of Substance Lot Number (RXD-18).
`CE[]`	`getSubstanceManufacturerName()` Returns all repetitions of Substance Manufacturer Name (RXD-20).
`CE`	`getSubstanceManufacturerName(int rep)` Returns a specific repetition of RXD-20: "Substance Manufacturer Name" - creates it if necessary
`int`	`getSubstanceManufacturerNameReps()` Returns a count of the current number of repetitions of Substance Manufacturer Name (RXD-20).
`ID`	`getSubstitutionStatus()` Returns RXD-11: "Substitution Status" - creates it if necessary
`CE[]`	`getSupplementaryCode()` Returns all repetitions of Supplementary Code (RXD-25).
`CE`	`getSupplementaryCode(int rep)` Returns a specific repetition of RXD-25: "Supplementary Code" - creates it if necessary
`int`	`getSupplementaryCodeReps()` Returns a count of the current number of repetitions of Supplementary Code (RXD-25).
`CQ`	`getTotalDailyDose()` Returns RXD-12: "Total Daily Dose" - creates it if necessary
`ST`	`insertDispenseNotes(int rep)` Inserts a repetition of RXD-9: "Dispense Notes" at a specific index
`XCN`	`insertDispensingProvider(int rep)` Inserts a repetition of RXD-10: "Dispensing Provider" at a specific index
`CE`	`insertIndication(int rep)` Inserts a repetition of RXD-21: "Indication" at a specific index
`CE`	`insertPharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Inserts a repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`XCN`	`insertRxd10_DispensingProvider(int rep)` Inserts a repetition of RXD-10: "Dispensing Provider" at a specific index
`CE`	`insertRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Inserts a repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`ST`	`insertRxd18_SubstanceLotNumber(int rep)` Inserts a repetition of RXD-18: "Substance Lot Number" at a specific index
`TS`	`insertRxd19_SubstanceExpirationDate(int rep)` Inserts a repetition of RXD-19: "Substance Expiration Date" at a specific index
`CE`	`insertRxd20_SubstanceManufacturerName(int rep)` Inserts a repetition of RXD-20: "Substance Manufacturer Name" at a specific index
`CE`	`insertRxd21_Indication(int rep)` Inserts a repetition of RXD-21: "Indication" at a specific index
`CE`	`insertRxd25_SupplementaryCode(int rep)` Inserts a repetition of RXD-25: "Supplementary Code" at a specific index
`ST`	`insertRxd9_DispenseNotes(int rep)` Inserts a repetition of RXD-9: "Dispense Notes" at a specific index
`TS`	`insertSubstanceExpirationDate(int rep)` Inserts a repetition of RXD-19: "Substance Expiration Date" at a specific index
`ST`	`insertSubstanceLotNumber(int rep)` Inserts a repetition of RXD-18: "Substance Lot Number" at a specific index
`CE`	`insertSubstanceManufacturerName(int rep)` Inserts a repetition of RXD-20: "Substance Manufacturer Name" at a specific index
`CE`	`insertSupplementaryCode(int rep)` Inserts a repetition of RXD-25: "Supplementary Code" at a specific index
`ST`	`removeDispenseNotes(int rep)` Removes a repetition of RXD-9: "Dispense Notes" at a specific index
`XCN`	`removeDispensingProvider(int rep)` Removes a repetition of RXD-10: "Dispensing Provider" at a specific index
`CE`	`removeIndication(int rep)` Removes a repetition of RXD-21: "Indication" at a specific index
`CE`	`removePharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Removes a repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`XCN`	`removeRxd10_DispensingProvider(int rep)` Removes a repetition of RXD-10: "Dispensing Provider" at a specific index
`CE`	`removeRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions(int rep)` Removes a repetition of RXD-15: "Pharmacy/Treatment Supplier's Special Dispensing Instructions" at a specific index
`ST`	`removeRxd18_SubstanceLotNumber(int rep)` Removes a repetition of RXD-18: "Substance Lot Number" at a specific index
`TS`	`removeRxd19_SubstanceExpirationDate(int rep)` Removes a repetition of RXD-19: "Substance Expiration Date" at a specific index
`CE`	`removeRxd20_SubstanceManufacturerName(int rep)` Removes a repetition of RXD-20: "Substance Manufacturer Name" at a specific index
`CE`	`removeRxd21_Indication(int rep)` Removes a repetition of RXD-21: "Indication" at a specific index
`CE`	`removeRxd25_SupplementaryCode(int rep)` Removes a repetition of RXD-25: "Supplementary Code" at a specific index
`ST`	`removeRxd9_DispenseNotes(int rep)` Removes a repetition of RXD-9: "Dispense Notes" at a specific index
`TS`	`removeSubstanceExpirationDate(int rep)` Removes a repetition of RXD-19: "Substance Expiration Date" at a specific index
`ST`	`removeSubstanceLotNumber(int rep)` Removes a repetition of RXD-18: "Substance Lot Number" at a specific index
`CE`	`removeSubstanceManufacturerName(int rep)` Removes a repetition of RXD-20: "Substance Manufacturer Name" at a specific index
`CE`	`removeSupplementaryCode(int rep)` Removes a repetition of RXD-25: "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

RXD

public RXD(Group parent,
           ModelClassFactory factory)

Creates a new RXD segment

Method Detail

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

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

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

Returns all repetitions of Dispensing Provider (RXD-10).

getDispensingProviderReps

public int getDispensingProviderReps()

Returns a count of the current number of repetitions of Dispensing Provider (RXD-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getDispensingProvider

public XCN getDispensingProvider(int rep)

Returns a specific repetition of RXD-10: "Dispensing Provider" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd10_DispensingProvider

public XCN getRxd10_DispensingProvider(int rep)

Returns a specific repetition of RXD-10: "Dispensing Provider" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd10_DispensingProviderReps

public int getRxd10_DispensingProviderReps()

insertDispensingProvider

public XCN insertDispensingProvider(int rep)
                             throws HL7Exception

Inserts a repetition of RXD-10: "Dispensing Provider" 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)

insertRxd10_DispensingProvider

public XCN insertRxd10_DispensingProvider(int rep)
                                   throws HL7Exception

Inserts a repetition of RXD-10: "Dispensing Provider" 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)

removeDispensingProvider

public XCN removeDispensingProvider(int rep)
                             throws HL7Exception

Removes a repetition of RXD-10: "Dispensing Provider" 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)

removeRxd10_DispensingProvider

public XCN removeRxd10_DispensingProvider(int rep)
                                   throws HL7Exception

Removes a repetition of RXD-10: "Dispensing Provider" 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)

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

Returns RXD-13: "Dispense-To Location" - creates it if necessary

getRxd13_DispenseToLocation

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

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

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

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

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

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

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

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

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 all repetitions of Indication (RXD-21).

getIndicationReps

public int getIndicationReps()

Returns a count of the current number of repetitions of Indication (RXD-21). 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 RXD-21: "Indication" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd21_Indication

public CE getRxd21_Indication(int rep)

Returns a specific repetition of RXD-21: "Indication" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd21_IndicationReps

public int getRxd21_IndicationReps()

insertIndication

public CE insertIndication(int rep)
                    throws HL7Exception

Inserts a repetition of RXD-21: "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)

insertRxd21_Indication

public CE insertRxd21_Indication(int rep)
                          throws HL7Exception

Inserts a repetition of RXD-21: "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 RXD-21: "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)

removeRxd21_Indication

public CE removeRxd21_Indication(int rep)
                          throws HL7Exception

Removes a repetition of RXD-21: "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 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

getSupplementaryCode

public CE[] getSupplementaryCode()

Returns all repetitions of Supplementary Code (RXD-25).

getSupplementaryCodeReps

public int getSupplementaryCodeReps()

Returns a count of the current number of repetitions of Supplementary Code (RXD-25). 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 RXD-25: "Supplementary Code" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd25_SupplementaryCode

public CE getRxd25_SupplementaryCode(int rep)

Returns a specific repetition of RXD-25: "Supplementary Code" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getRxd25_SupplementaryCodeReps

public int getRxd25_SupplementaryCodeReps()

insertSupplementaryCode

public CE insertSupplementaryCode(int rep)
                           throws HL7Exception

Inserts a repetition of RXD-25: "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)

insertRxd25_SupplementaryCode

public CE insertRxd25_SupplementaryCode(int rep)
                                 throws HL7Exception

Inserts a repetition of RXD-25: "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 RXD-25: "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)

removeRxd25_SupplementaryCode

public CE removeRxd25_SupplementaryCode(int rep)
                                 throws HL7Exception

Removes a repetition of RXD-25: "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)

getInitiatingLocation

public CE getInitiatingLocation()

Returns RXD-26: "Initiating Location" - creates it if necessary

getRxd26_InitiatingLocation

public CE getRxd26_InitiatingLocation()

Returns RXD-26: "Initiating Location" - creates it if necessary

getPackagingAssemblyLocation

public CE getPackagingAssemblyLocation()

Returns RXD-27: "Packaging/Assembly Location" - creates it if necessary

getRxd27_PackagingAssemblyLocation

public CE getRxd27_PackagingAssemblyLocation()

Returns RXD-27: "Packaging/Assembly Location" - creates it if necessary

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 RXD

RXD

getDispenseSubIDCounter

getRxd1_DispenseSubIDCounter

getDispenseGiveCode

getRxd2_DispenseGiveCode

getDateTimeDispensed

getRxd3_DateTimeDispensed

getActualDispenseAmount

getRxd4_ActualDispenseAmount

getActualDispenseUnits

getRxd5_ActualDispenseUnits

getActualDosageForm

getRxd6_ActualDosageForm

getPrescriptionNumber

getRxd7_PrescriptionNumber

getNumberOfRefillsRemaining

getRxd8_NumberOfRefillsRemaining

getDispenseNotes

getDispenseNotesReps

getDispenseNotes

getRxd9_DispenseNotes

getRxd9_DispenseNotesReps

insertDispenseNotes

insertRxd9_DispenseNotes

removeDispenseNotes

removeRxd9_DispenseNotes

getDispensingProvider

getDispensingProviderReps

getDispensingProvider

getRxd10_DispensingProvider

getRxd10_DispensingProviderReps

insertDispensingProvider

insertRxd10_DispensingProvider

removeDispensingProvider

removeRxd10_DispensingProvider

getSubstitutionStatus

getRxd11_SubstitutionStatus

getTotalDailyDose

getRxd12_TotalDailyDose

getDispenseToLocation

getRxd13_DispenseToLocation

getNeedsHumanReview

getRxd14_NeedsHumanReview

getPharmacyTreatmentSupplierSSpecialDispensingInstructions

getPharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

getPharmacyTreatmentSupplierSSpecialDispensingInstructions

getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

getRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructionsReps

insertPharmacyTreatmentSupplierSSpecialDispensingInstructions

insertRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

removePharmacyTreatmentSupplierSSpecialDispensingInstructions

removeRxd15_PharmacyTreatmentSupplierSSpecialDispensingInstructions

getActualStrength

getRxd16_ActualStrength

getActualStrengthUnit

getRxd17_ActualStrengthUnit

getSubstanceLotNumber

getSubstanceLotNumberReps

getSubstanceLotNumber

getRxd18_SubstanceLotNumber

getRxd18_SubstanceLotNumberReps

insertSubstanceLotNumber

insertRxd18_SubstanceLotNumber

removeSubstanceLotNumber

removeRxd18_SubstanceLotNumber

getSubstanceExpirationDate

getSubstanceExpirationDateReps

getSubstanceExpirationDate

getRxd19_SubstanceExpirationDate

getRxd19_SubstanceExpirationDateReps

insertSubstanceExpirationDate

insertRxd19_SubstanceExpirationDate

removeSubstanceExpirationDate

removeRxd19_SubstanceExpirationDate

getSubstanceManufacturerName

getSubstanceManufacturerNameReps

getSubstanceManufacturerName

getRxd20_SubstanceManufacturerName

getRxd20_SubstanceManufacturerNameReps

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