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

Class ORD_O02_ORDER_TRAY

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

Represents a ORD_O02_ORDER_TRAY 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 segment)
  • 2: ODT (Diet tray instructions segment) optional repeating
  • 3: NTE (Notes and comments segment) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"

    • getORC

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

    • getODT

      public ODT getODT()
      Returns the first repetition of ODT (Diet tray instructions segment) - creates it if necessary

    • getODT

      public ODT getODT(int rep)
      Returns a specific repetition of ODT (Diet tray instructions 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.

    • getODTReps

      public int getODTReps()
      Returns the number of existing repetitions of ODT

    • getODTAll

      public List<ODT> getODTAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertODT

      public void insertODT(ODT structure, int rep) throws HL7Exception
      Inserts a specific repetition of ODT (Diet tray instructions segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertODT

      public ODT insertODT(int rep) throws HL7Exception
      Inserts a specific repetition of ODT (Diet tray instructions segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeODT

      public ODT removeODT(int rep) throws HL7Exception
      Removes a specific repetition of ODT (Diet tray instructions segment)
      Throws:
      HL7Exception
      See Also:

    • 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: