Package ca.uhn.hl7v2.model.v23.group

Class RRO_O02_ORDER_DETAIL

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

Represents a RRO_O02_ORDER_DETAIL 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: RXO (Pharmacy prescription order segment)
  • 2: NTE (Notes and comments segment) optional repeating
  • 3: RXR (Pharmacy route segment) repeating
  • 4: RXC (Pharmacy component order segment) optional repeating
  • 5: NTE (Notes and comments segment) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"

    • getRXO

      public RXO getRXO()
      Returns RXO (Pharmacy prescription order segment) - creates it if necessary

    • getNTE

      public NTE getNTE()
      Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary

    • getNTE

      public NTE getNTE(int rep)
      Returns a specific repetition of NTE (Notes and comments segment) - 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.

    • getNTEReps

      public int getNTEReps()
      Returns the number of existing repetitions of NTE

    • getNTEAll

      public List<NTE> getNTEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertNTE

      public void insertNTE(NTE structure, int rep) throws HL7Exception
      Inserts a specific repetition of NTE (Notes and comments segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertNTE

      public NTE insertNTE(int rep) throws HL7Exception
      Inserts a specific repetition of NTE (Notes and comments segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeNTE

      public NTE removeNTE(int rep) throws HL7Exception
      Removes a specific repetition of NTE (Notes and comments segment)
      Throws:
      HL7Exception
      See Also:

    • getRXR

      public RXR getRXR()
      Returns the first repetition of RXR (Pharmacy route segment) - creates it if necessary

    • getRXR

      public RXR getRXR(int rep)
      Returns a specific repetition of RXR (Pharmacy route segment) - 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 route segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXR

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

    • removeRXR

      public RXR removeRXR(int rep) throws HL7Exception
      Removes a specific repetition of RXR (Pharmacy route segment)
      Throws:
      HL7Exception
      See Also:

    • getRXC

      public RXC getRXC()
      Returns the first repetition of RXC (Pharmacy component order segment) - creates it if necessary

    • getRXC

      public RXC getRXC(int rep)
      Returns a specific repetition of RXC (Pharmacy component order segment) - 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 component order segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRXC

      public RXC insertRXC(int rep) throws HL7Exception
      Inserts a specific repetition of RXC (Pharmacy component order segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRXC

      public RXC removeRXC(int rep) throws HL7Exception
      Removes a specific repetition of RXC (Pharmacy component order segment)
      Throws:
      HL7Exception
      See Also:

    • getNTE2

      public NTE getNTE2()
      Returns the first repetition of NTE2 (Notes and comments segment) - creates it if necessary

    • getNTE2

      public NTE getNTE2(int rep)
      Returns a specific repetition of NTE (Notes and comments segment) - 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.

    • getNTE2Reps

      public int getNTE2Reps()
      Returns the number of existing repetitions of NTE2

    • getNTE2All

      public List<NTE> getNTE2All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertNTE2

      public void insertNTE2(NTE structure, int rep) throws HL7Exception
      Inserts a specific repetition of NTE2 (Notes and comments segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertNTE2

      public NTE insertNTE2(int rep) throws HL7Exception
      Inserts a specific repetition of NTE2 (Notes and comments segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeNTE2

      public NTE removeNTE2(int rep) throws HL7Exception
      Removes a specific repetition of NTE2 (Notes and comments segment)
      Throws:
      HL7Exception
      See Also: