Package ca.uhn.hl7v2.model.v251.group

Class ORL_O34_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.ORL_O34_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O34_ORDER
extends AbstractGroup

Represents a ORL_O34_ORDER 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: ORL_O34_TIMING (a Group object) optional repeating
• 3: ORL_O34_OBSERVATION_REQUEST (a Group object) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ORL_O34_OBSERVATION_REQUEST	getOBSERVATION_REQUEST()	Returns OBSERVATION_REQUEST (a Group object) - creates it if necessary
ORC	getORC()	Returns ORC (Common Order) - creates it if necessary
ORL_O34_TIMING	getTIMING()	Returns the first repetition of TIMING (a Group object) - creates it if necessary
ORL_O34_TIMING	getTIMING(int rep)	Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<ORL_O34_TIMING>	getTIMINGAll()	Returns a non-modifiable List containing all current existing repetitions of TIMING.
int	getTIMINGReps()	Returns the number of existing repetitions of TIMING
String	getVersion()	Returns "2.5.1"
ORL_O34_TIMING	insertTIMING(int rep)	Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(ORL_O34_TIMING structure, int rep)	Inserts a specific repetition of TIMING (a Group object)
ORL_O34_TIMING	removeTIMING(int rep)	Removes a specific repetition of TIMING (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 Details

ORL_O34_ORDER

public ORL_O34_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new ORL_O34_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public ORL_O34_TIMING getTIMING()

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

getTIMING

public ORL_O34_TIMING getTIMING(int rep)

Returns a specific repetition of TIMING (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.

getTIMINGReps

public int getTIMINGReps()

Returns the number of existing repetitions of TIMING

getTIMINGAll

public List<ORL_O34_TIMING> getTIMINGAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING

public void insertTIMING(ORL_O34_TIMING structure,
 int rep)
                  throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertTIMING

public ORL_O34_TIMING insertTIMING(int rep)
                            throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeTIMING

public ORL_O34_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBSERVATION_REQUEST

public ORL_O34_OBSERVATION_REQUEST getOBSERVATION_REQUEST()

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