Package ca.uhn.hl7v2.model.v24.group

Class RGR_RGR_ORDER

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.v24.group.RGR_RGR_ORDER
All Implemented Interfaces:
Group, Structure, Visitable, Serializable
public class RGR_RGR_ORDER extends AbstractGroup

Represents a RGR_RGR_ORDER group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

  • 1: ORC (Common Order)
  • 2: RGR_RGR_ENCODING (a Group object) optional
  • 3: RXG (Pharmacy/Treatment Give) repeating
  • 4: RXR (Pharmacy/Treatment Route) repeating
  • 5: RXC (Pharmacy/Treatment Component Order) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getORC

      public ORC getORC()
      Returns ORC (Common Order) - creates it if necessary

    • getENCODING

      public RGR_RGR_ENCODING getENCODING()
      Returns ENCODING (a Group object) - creates it if necessary

    • getRXG

      public RXG getRXG()
      Returns the first repetition of RXG (Pharmacy/Treatment Give) - creates it if necessary

    • getRXG

      public RXG getRXG(int rep)
      Returns a specific repetition of RXG (Pharmacy/Treatment Give) - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getRXGReps

      public int getRXGReps()
      Returns the number of existing repetitions of RXG

    • getRXGAll

      public List<RXG> getRXGAll() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of RXG.

      Note that unlike getRXG(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertRXG

      public void insertRXG(RXG structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXG (Pharmacy/Treatment Give)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXG

      public RXG insertRXG(int rep) throws HL7Exception
      Inserts a specific repetition of RXG (Pharmacy/Treatment Give)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXG

      public RXG removeRXG(int rep) throws HL7Exception
      Removes a specific repetition of RXG (Pharmacy/Treatment Give)
      Throws:
      HL7Exception
      See Also:

    • getRXR

      public RXR getRXR()
      Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary

    • getRXR

      public RXR getRXR(int rep)
      Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getRXRReps

      public int getRXRReps()
      Returns the number of existing repetitions of RXR

    • getRXRAll

      public List<RXR> getRXRAll() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of RXR.

      Note that unlike getRXR(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertRXR

      public void insertRXR(RXR structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXR

      public RXR insertRXR(int rep) throws HL7Exception
      Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXR

      public RXR removeRXR(int rep) throws HL7Exception
      Removes a specific repetition of RXR (Pharmacy/Treatment Route)
      Throws:
      HL7Exception
      See Also:

    • getRXC

      public RXC getRXC()
      Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary

    • getRXC

      public RXC getRXC(int rep)
      Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getRXCReps

      public int getRXCReps()
      Returns the number of existing repetitions of RXC

    • getRXCAll

      public List<RXC> getRXCAll() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of RXC.

      Note that unlike getRXC(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertRXC

      public void insertRXC(RXC structure, int rep) throws HL7Exception
      Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXC

      public RXC insertRXC(int rep) throws HL7Exception
      Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXC

      public RXC removeRXC(int rep) throws HL7Exception
      Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
      Throws:
      HL7Exception
      See Also: