Class RXA

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class RXA extends AbstractSegment

Represents an HL7 RXA message segment (Pharmacy/Treatment Administration). This segment has the following fields:

  • RXA-1: Give Sub-ID Counter (NM)
  • RXA-2: Administration Sub-ID Counter (NM)
  • RXA-3: Date/Time Start of Administration (TS)
  • RXA-4: Date/Time End of Administration (TS)
  • RXA-5: Administered Code (CE)
  • RXA-6: Administered Amount (NM)
  • RXA-7: Administered Units (CE) optional
  • RXA-8: Administered Dosage Form (CE) optional
  • RXA-9: Administration Notes (CE) optional repeating
  • RXA-10: Administering Provider (XCN) optional repeating
  • RXA-11: Administered-at Location (LA2) optional
  • RXA-12: Administered Per (Time Unit) (ST) optional
  • RXA-13: Administered Strength (NM) optional
  • RXA-14: Administered Strength Units (CE) optional
  • RXA-15: Substance Lot Number (ST) optional repeating
  • RXA-16: Substance Expiration Date (TS) optional repeating
  • RXA-17: Substance Manufacturer Name (CE) optional repeating
  • RXA-18: Substance/Treatment Refusal Reason (CE) optional repeating
  • RXA-19: Indication (CE) optional repeating
  • RXA-20: Completion Status (ID) optional
  • RXA-21: Action Code-RXA (ID) optional
  • RXA-22: System Entry Date/Time (TS) optional
See Also:
  • Constructor Details

  • Method Details

    • getGiveSubIDCounter

      Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary
    • getRxa1_GiveSubIDCounter

      Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary
    • getAdministrationSubIDCounter

      Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary
    • getRxa2_AdministrationSubIDCounter

      Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary
    • getDateTimeStartOfAdministration

      Returns RXA-3: "Date/Time Start of Administration" - creates it if necessary
    • getRxa3_DateTimeStartOfAdministration

      Returns RXA-3: "Date/Time Start of Administration" - creates it if necessary
    • getDateTimeEndOfAdministration

      Returns RXA-4: "Date/Time End of Administration" - creates it if necessary
    • getRxa4_DateTimeEndOfAdministration

      Returns RXA-4: "Date/Time End of Administration" - creates it if necessary
    • getAdministeredCode

      Returns RXA-5: "Administered Code" - creates it if necessary
    • getRxa5_AdministeredCode

      Returns RXA-5: "Administered Code" - creates it if necessary
    • getAdministeredAmount

      Returns RXA-6: "Administered Amount" - creates it if necessary
    • getRxa6_AdministeredAmount

      Returns RXA-6: "Administered Amount" - creates it if necessary
    • getAdministeredUnits

      Returns RXA-7: "Administered Units" - creates it if necessary
    • getRxa7_AdministeredUnits

      Returns RXA-7: "Administered Units" - creates it if necessary
    • getAdministeredDosageForm

      Returns RXA-8: "Administered Dosage Form" - creates it if necessary
    • getRxa8_AdministeredDosageForm

      Returns RXA-8: "Administered Dosage Form" - creates it if necessary
    • getAdministrationNotes

      Returns all repetitions of Administration Notes (RXA-9).
    • getRxa9_AdministrationNotes

      Returns all repetitions of Administration Notes (RXA-9).
    • getAdministrationNotesReps

      Returns a count of the current number of repetitions of Administration Notes (RXA-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getAdministrationNotes

      public CE getAdministrationNotes(int rep)
      Returns a specific repetition of RXA-9: "Administration Notes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa9_AdministrationNotes

      public CE getRxa9_AdministrationNotes(int rep)
      Returns a specific repetition of RXA-9: "Administration Notes" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa9_AdministrationNotesReps

      Returns a count of the current number of repetitions of Administration Notes (RXA-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertAdministrationNotes

      public CE insertAdministrationNotes(int rep) throws HL7Exception
      Inserts a repetition of RXA-9: "Administration 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)
    • insertRxa9_AdministrationNotes

      Inserts a repetition of RXA-9: "Administration 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)
    • removeAdministrationNotes

      public CE removeAdministrationNotes(int rep) throws HL7Exception
      Removes a repetition of RXA-9: "Administration 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)
    • removeRxa9_AdministrationNotes

      Removes a repetition of RXA-9: "Administration 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)
    • getAdministeringProvider

      Returns all repetitions of Administering Provider (RXA-10).
    • getRxa10_AdministeringProvider

      Returns all repetitions of Administering Provider (RXA-10).
    • getAdministeringProviderReps

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

      public XCN getAdministeringProvider(int rep)
      Returns a specific repetition of RXA-10: "Administering Provider" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa10_AdministeringProvider

      Returns a specific repetition of RXA-10: "Administering Provider" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa10_AdministeringProviderReps

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

      public XCN insertAdministeringProvider(int rep) throws HL7Exception
      Inserts a repetition of RXA-10: "Administering 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)
    • insertRxa10_AdministeringProvider

      Inserts a repetition of RXA-10: "Administering 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)
    • removeAdministeringProvider

      public XCN removeAdministeringProvider(int rep) throws HL7Exception
      Removes a repetition of RXA-10: "Administering 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)
    • removeRxa10_AdministeringProvider

      Removes a repetition of RXA-10: "Administering 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)
    • getAdministeredAtLocation

      Returns RXA-11: "Administered-at Location" - creates it if necessary
    • getRxa11_AdministeredAtLocation

      Returns RXA-11: "Administered-at Location" - creates it if necessary
    • getAdministeredPerTimeUnit

      Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary
    • getRxa12_AdministeredPerTimeUnit

      Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary
    • getAdministeredStrength

      Returns RXA-13: "Administered Strength" - creates it if necessary
    • getRxa13_AdministeredStrength

      Returns RXA-13: "Administered Strength" - creates it if necessary
    • getAdministeredStrengthUnits

      Returns RXA-14: "Administered Strength Units" - creates it if necessary
    • getRxa14_AdministeredStrengthUnits

      Returns RXA-14: "Administered Strength Units" - creates it if necessary
    • getSubstanceLotNumber

      Returns all repetitions of Substance Lot Number (RXA-15).
    • getRxa15_SubstanceLotNumber

      Returns all repetitions of Substance Lot Number (RXA-15).
    • getSubstanceLotNumberReps

      Returns a count of the current number of repetitions of Substance Lot Number (RXA-15). 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 RXA-15: "Substance Lot Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa15_SubstanceLotNumber

      public ST getRxa15_SubstanceLotNumber(int rep)
      Returns a specific repetition of RXA-15: "Substance Lot Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa15_SubstanceLotNumberReps

      Returns a count of the current number of repetitions of Substance Lot Number (RXA-15). 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 RXA-15: "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)
    • insertRxa15_SubstanceLotNumber

      Inserts a repetition of RXA-15: "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 RXA-15: "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)
    • removeRxa15_SubstanceLotNumber

      Removes a repetition of RXA-15: "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

      Returns all repetitions of Substance Expiration Date (RXA-16).
    • getRxa16_SubstanceExpirationDate

      Returns all repetitions of Substance Expiration Date (RXA-16).
    • getSubstanceExpirationDateReps

      Returns a count of the current number of repetitions of Substance Expiration Date (RXA-16). 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 RXA-16: "Substance Expiration Date" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa16_SubstanceExpirationDate

      Returns a specific repetition of RXA-16: "Substance Expiration Date" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa16_SubstanceExpirationDateReps

      Returns a count of the current number of repetitions of Substance Expiration Date (RXA-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSubstanceExpirationDate

      Inserts a repetition of RXA-16: "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)
    • insertRxa16_SubstanceExpirationDate

      Inserts a repetition of RXA-16: "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

      Removes a repetition of RXA-16: "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)
    • removeRxa16_SubstanceExpirationDate

      Removes a repetition of RXA-16: "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

      Returns all repetitions of Substance Manufacturer Name (RXA-17).
    • getRxa17_SubstanceManufacturerName

      Returns all repetitions of Substance Manufacturer Name (RXA-17).
    • getSubstanceManufacturerNameReps

      Returns a count of the current number of repetitions of Substance Manufacturer Name (RXA-17). 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 RXA-17: "Substance Manufacturer Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa17_SubstanceManufacturerName

      Returns a specific repetition of RXA-17: "Substance Manufacturer Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa17_SubstanceManufacturerNameReps

      Returns a count of the current number of repetitions of Substance Manufacturer Name (RXA-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSubstanceManufacturerName

      Inserts a repetition of RXA-17: "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)
    • insertRxa17_SubstanceManufacturerName

      Inserts a repetition of RXA-17: "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

      Removes a repetition of RXA-17: "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)
    • removeRxa17_SubstanceManufacturerName

      Removes a repetition of RXA-17: "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)
    • getSubstanceTreatmentRefusalReason

      Returns all repetitions of Substance/Treatment Refusal Reason (RXA-18).
    • getRxa18_SubstanceTreatmentRefusalReason

      Returns all repetitions of Substance/Treatment Refusal Reason (RXA-18).
    • getSubstanceTreatmentRefusalReasonReps

      Returns a count of the current number of repetitions of Substance/Treatment Refusal Reason (RXA-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getSubstanceTreatmentRefusalReason

      Returns a specific repetition of RXA-18: "Substance/Treatment Refusal Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa18_SubstanceTreatmentRefusalReason

      Returns a specific repetition of RXA-18: "Substance/Treatment Refusal Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa18_SubstanceTreatmentRefusalReasonReps

      Returns a count of the current number of repetitions of Substance/Treatment Refusal Reason (RXA-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSubstanceTreatmentRefusalReason

      Inserts a repetition of RXA-18: "Substance/Treatment Refusal Reason" 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)
    • insertRxa18_SubstanceTreatmentRefusalReason

      Inserts a repetition of RXA-18: "Substance/Treatment Refusal Reason" 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)
    • removeSubstanceTreatmentRefusalReason

      Removes a repetition of RXA-18: "Substance/Treatment Refusal Reason" 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)
    • removeRxa18_SubstanceTreatmentRefusalReason

      Removes a repetition of RXA-18: "Substance/Treatment Refusal Reason" 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 (RXA-19).
    • getRxa19_Indication

      public CE[] getRxa19_Indication()
      Returns all repetitions of Indication (RXA-19).
    • getIndicationReps

      public int getIndicationReps()
      Returns a count of the current number of repetitions of Indication (RXA-19). 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 RXA-19: "Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa19_Indication

      public CE getRxa19_Indication(int rep)
      Returns a specific repetition of RXA-19: "Indication" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getRxa19_IndicationReps

      Returns a count of the current number of repetitions of Indication (RXA-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertIndication

      public CE insertIndication(int rep) throws HL7Exception
      Inserts a repetition of RXA-19: "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)
    • insertRxa19_Indication

      public CE insertRxa19_Indication(int rep) throws HL7Exception
      Inserts a repetition of RXA-19: "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 RXA-19: "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)
    • removeRxa19_Indication

      public CE removeRxa19_Indication(int rep) throws HL7Exception
      Removes a repetition of RXA-19: "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)
    • getCompletionStatus

      Returns RXA-20: "Completion Status" - creates it if necessary
    • getRxa20_CompletionStatus

      Returns RXA-20: "Completion Status" - creates it if necessary
    • getActionCodeRXA

      public ID getActionCodeRXA()
      Returns RXA-21: "Action Code-RXA" - creates it if necessary
    • getRxa21_ActionCodeRXA

      Returns RXA-21: "Action Code-RXA" - creates it if necessary
    • getSystemEntryDateTime

      Returns RXA-22: "System Entry Date/Time" - creates it if necessary
    • getRxa22_SystemEntryDateTime

      Returns RXA-22: "System Entry Date/Time" - creates it if necessary
    • createNewTypeWithoutReflection

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