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

Class ORD_O04_ORDER_DIET

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

Represents a ORD_O04_ORDER_DIET 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: ODS (Dietary Orders, Supplements, and Preferences) optional repeating
  • 3: NTE (Notes and Comments) 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

    • getODS

      public ODS getODS()
      Returns the first repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary

    • getODS

      public ODS getODS(int rep)
      Returns a specific repetition of ODS (Dietary Orders, Supplements, and Preferences) - 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.

    • getODSReps

      public int getODSReps()
      Returns the number of existing repetitions of ODS

    • getODSAll

      public List<ODS> getODSAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertODS

      public void insertODS(ODS structure, int rep) throws HL7Exception
      Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertODS

      public ODS insertODS(int rep) throws HL7Exception
      Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeODS

      public ODS removeODS(int rep) throws HL7Exception
      Removes a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
      Throws:
      HL7Exception
      See Also:

    • getNTE

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

    • getNTE

      public NTE getNTE(int rep)
      Returns a specific repetition of NTE (Notes and Comments) - 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)
      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)
      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)
      Throws:
      HL7Exception
      See Also: