ca.uhn.hl7v2.model.v281.group

Class OMD_O03_ORDER_DIET

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.OMD_O03_ORDER_DIET

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OMD_O03_ORDER_DIET
extends AbstractGroup

Represents a OMD_O03_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: PRT (Participation Information) optional repeating
• 3: OMD_O03_TIMING_DIET (a Group object) optional repeating
• 4: OMD_O03_DIET (a Group object) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OMD_O03_DIET	getDIET() Returns DIET (a Group object) - creates it if necessary
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
OMD_O03_TIMING_DIET	getTIMING_DIET() Returns the first repetition of TIMING_DIET (a Group object) - creates it if necessary
OMD_O03_TIMING_DIET	getTIMING_DIET(int rep) Returns a specific repetition of TIMING_DIET (a Group object) - creates it if necessary
List<OMD_O03_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.8.1"
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
OMD_O03_TIMING_DIET	insertTIMING_DIET(int rep) Inserts a specific repetition of TIMING_DIET (a Group object)
void	insertTIMING_DIET(OMD_O03_TIMING_DIET structure, int rep) Inserts a specific repetition of TIMING_DIET (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
OMD_O03_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

accept, 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, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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

OMD_O03_ORDER_DIET

public OMD_O03_ORDER_DIET(Group parent,
                          ModelClassFactory factory)

Creates a new OMD_O03_ORDER_DIET group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getTIMING_DIET

public OMD_O03_TIMING_DIET getTIMING_DIET()

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

getTIMING_DIET

public OMD_O03_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<OMD_O03_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(OMD_O03_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 OMD_O03_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 OMD_O03_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)

getDIET

public OMD_O03_DIET getDIET()

Returns DIET (a Group object) - creates it if necessary