Package ca.uhn.hl7v2.model.v251.segment

Class RXC

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

Represents an HL7 RXC message segment (Pharmacy/Treatment Component Order). This segment has the following fields:

  • RXC-1: RX Component Type (ID)
  • RXC-2: Component Code (CE)
  • RXC-3: Component Amount (NM)
  • RXC-4: Component Units (CE)
  • RXC-5: Component Strength (NM) optional
  • RXC-6: Component Strength Units (CE) optional
  • RXC-7: Supplementary Code (CE) optional repeating
  • RXC-8: Component Drug Strength Volume (NM) optional
  • RXC-9: Component Drug Strength Volume Units (CWE) optional
See Also:

  • Constructor Details

  • Method Details

    • getRXComponentType

      public ID getRXComponentType()
      Returns RXC-1: "RX Component Type" - creates it if necessary

    • getRxc1_RXComponentType

      public ID getRxc1_RXComponentType()
      Returns RXC-1: "RX Component Type" - creates it if necessary

    • getComponentCode

      public CE getComponentCode()
      Returns RXC-2: "Component Code" - creates it if necessary

    • getRxc2_ComponentCode

      public CE getRxc2_ComponentCode()
      Returns RXC-2: "Component Code" - creates it if necessary

    • getComponentAmount

      public NM getComponentAmount()
      Returns RXC-3: "Component Amount" - creates it if necessary

    • getRxc3_ComponentAmount

      public NM getRxc3_ComponentAmount()
      Returns RXC-3: "Component Amount" - creates it if necessary

    • getComponentUnits

      public CE getComponentUnits()
      Returns RXC-4: "Component Units" - creates it if necessary

    • getRxc4_ComponentUnits

      public CE getRxc4_ComponentUnits()
      Returns RXC-4: "Component Units" - creates it if necessary

    • getComponentStrength

      public NM getComponentStrength()
      Returns RXC-5: "Component Strength" - creates it if necessary

    • getRxc5_ComponentStrength

      public NM getRxc5_ComponentStrength()
      Returns RXC-5: "Component Strength" - creates it if necessary

    • getComponentStrengthUnits

      public CE getComponentStrengthUnits()
      Returns RXC-6: "Component Strength Units" - creates it if necessary

    • getRxc6_ComponentStrengthUnits

      public CE getRxc6_ComponentStrengthUnits()
      Returns RXC-6: "Component Strength Units" - creates it if necessary

    • getSupplementaryCode

      public CE[] getSupplementaryCode()
      Returns all repetitions of Supplementary Code (RXC-7).

    • getRxc7_SupplementaryCode

      public CE[] getRxc7_SupplementaryCode()
      Returns all repetitions of Supplementary Code (RXC-7).

    • getSupplementaryCodeReps

      public int getSupplementaryCodeReps()
      Returns a count of the current number of repetitions of Supplementary Code (RXC-7). 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 RXC-7: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxc7_SupplementaryCode

      public CE getRxc7_SupplementaryCode(int rep)
      Returns a specific repetition of RXC-7: "Supplementary Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getRxc7_SupplementaryCodeReps

      public int getRxc7_SupplementaryCodeReps()
      Returns a count of the current number of repetitions of Supplementary Code (RXC-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSupplementaryCode

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

    • insertRxc7_SupplementaryCode

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

    • removeRxc7_SupplementaryCode

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

    • getComponentDrugStrengthVolume

      public NM getComponentDrugStrengthVolume()
      Returns RXC-8: "Component Drug Strength Volume" - creates it if necessary

    • getRxc8_ComponentDrugStrengthVolume

      public NM getRxc8_ComponentDrugStrengthVolume()
      Returns RXC-8: "Component Drug Strength Volume" - creates it if necessary

    • getComponentDrugStrengthVolumeUnits

      public CWE getComponentDrugStrengthVolumeUnits()
      Returns RXC-9: "Component Drug Strength Volume Units" - creates it if necessary

    • getRxc9_ComponentDrugStrengthVolumeUnits

      public CWE getRxc9_ComponentDrugStrengthVolumeUnits()
      Returns RXC-9: "Component Drug Strength Volume Units" - creates it if necessary

    • createNewTypeWithoutReflection

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