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

Class RDE_O01_ORDER_DETAIL

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

Represents a RDE_O01_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: RDE_O01_COMPONENT (a Group object) optional
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:

    • getCOMPONENT

      public RDE_O01_COMPONENT getCOMPONENT()
      Returns COMPONENT (a Group object) - creates it if necessary