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

Class RDR_RDR_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.RDR_RDR_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RDR_RDR_ORDER
extends AbstractGroup

Represents a RDR_RDR_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 segment)
• 2: RDR_RDR_ENCODING (a Group object) optional
• 3: RDR_RDR_DISPENSE (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RDR_RDR_DISPENSE	getDISPENSE()	Returns the first repetition of DISPENSE (a Group object) - creates it if necessary
RDR_RDR_DISPENSE	getDISPENSE(int rep)	Returns a specific repetition of DISPENSE (a Group object) - creates it if necessary
List<RDR_RDR_DISPENSE>	getDISPENSEAll()	Returns a non-modifiable List containing all current existing repetitions of DISPENSE.
int	getDISPENSEReps()	Returns the number of existing repetitions of DISPENSE
RDR_RDR_ENCODING	getENCODING()	Returns ENCODING (a Group object) - creates it if necessary
ORC	getORC()	Returns ORC (Common order segment) - creates it if necessary
String	getVersion()	Returns "2.3"
RDR_RDR_DISPENSE	insertDISPENSE(int rep)	Inserts a specific repetition of DISPENSE (a Group object)
void	insertDISPENSE(RDR_RDR_DISPENSE structure, int rep)	Inserts a specific repetition of DISPENSE (a Group object)
RDR_RDR_DISPENSE	removeDISPENSE(int rep)	Removes a specific repetition of DISPENSE (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

RDR_RDR_ORDER

public RDR_RDR_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new RDR_RDR_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getORC

public ORC getORC()

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

getENCODING

public RDR_RDR_ENCODING getENCODING()

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

getDISPENSE

public RDR_RDR_DISPENSE getDISPENSE()

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

getDISPENSE

public RDR_RDR_DISPENSE getDISPENSE(int rep)

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

getDISPENSEReps

public int getDISPENSEReps()

Returns the number of existing repetitions of DISPENSE

getDISPENSEAll

public List<RDR_RDR_DISPENSE> getDISPENSEAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertDISPENSE

public void insertDISPENSE(RDR_RDR_DISPENSE structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of DISPENSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDISPENSE

public RDR_RDR_DISPENSE insertDISPENSE(int rep)
                                throws HL7Exception

Inserts a specific repetition of DISPENSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDISPENSE

public RDR_RDR_DISPENSE removeDISPENSE(int rep)
                                throws HL7Exception

Removes a specific repetition of DISPENSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)