ca.uhn.hl7v2.model.v26.group

Class ORD_O04_ORDER_DIET

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.ORD_O04_ORDER_DIET

All Implemented Interfaces:

Group, Structure, 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: ORD_O04_TIMING_DIET (a Group object) optional repeating
• 3: ODS (Dietary Orders, Supplements, and Preferences) optional repeating
• 4: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
ORD_O04_ORDER_DIET(Group parent, ModelClassFactory factory) Creates a new ORD_O04_ORDER_DIET group

Method Summary

Methods

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
ODS	getODS() Returns the first repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
ODS	getODS(int rep) Returns a specific repetition of ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
List<ODS>	getODSAll() Returns a non-modifiable List containing all current existing repetitions of ODS.
int	getODSReps() Returns the number of existing repetitions of ODS
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
ORD_O04_TIMING_DIET	getTIMING_DIET() Returns the first repetition of TIMING_DIET (a Group object) - creates it if necessary
ORD_O04_TIMING_DIET	getTIMING_DIET(int rep) Returns a specific repetition of TIMING_DIET (a Group object) - creates it if necessary
List<ORD_O04_TIMING_DIET>	getTIMING_DIETAll() Returns a non-modifiable List containing all current existing repetitions of TIMING_DIET.
int	getTIMING_DIETReps() Returns the number of existing repetitions of TIMING_DIET
String	getVersion() Returns "2.6"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
ODS	insertODS(int rep) Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
void	insertODS(ODS structure, int rep) Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
ORD_O04_TIMING_DIET	insertTIMING_DIET(int rep) Inserts a specific repetition of TIMING_DIET (a Group object)
void	insertTIMING_DIET(ORD_O04_TIMING_DIET structure, int rep) Inserts a specific repetition of TIMING_DIET (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
ODS	removeODS(int rep) Removes a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
ORD_O04_TIMING_DIET	removeTIMING_DIET(int rep) Removes a specific repetition of TIMING_DIET (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

ORD_O04_ORDER_DIET

public ORD_O04_ORDER_DIET(Group parent,
                  ModelClassFactory factory)

Creates a new ORD_O04_ORDER_DIET group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING_DIET

public ORD_O04_TIMING_DIET getTIMING_DIET()

Returns the first repetition of TIMING_DIET (a Group object) - creates it if necessary

getTIMING_DIET

public ORD_O04_TIMING_DIET getTIMING_DIET(int rep)

Returns a specific repetition of TIMING_DIET (a Group object) - 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.

getTIMING_DIETReps

public int getTIMING_DIETReps()

Returns the number of existing repetitions of TIMING_DIET

getTIMING_DIETAll

public List<ORD_O04_TIMING_DIET> getTIMING_DIETAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING_DIET

public void insertTIMING_DIET(ORD_O04_TIMING_DIET structure,
                     int rep)
                       throws HL7Exception

Inserts a specific repetition of TIMING_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTIMING_DIET

public ORD_O04_TIMING_DIET insertTIMING_DIET(int rep)
                                      throws HL7Exception

Inserts a specific repetition of TIMING_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTIMING_DIET

public ORD_O04_TIMING_DIET removeTIMING_DIET(int rep)
                                      throws HL7Exception

Removes a specific repetition of TIMING_DIET (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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:

AbstractGroup.removeRepetition(String, int)

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:

AbstractGroup.removeRepetition(String, int)