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

Class RRG_O16_GIVE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RRG_O16_GIVE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RRG_O16_GIVE
extends AbstractGroup

Represents a RRG_O16_GIVE 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: RXG (Pharmacy/Treatment Give)
• 2: RRG_O16_TIMING_GIVE (a Group object) repeating
• 3: RXR (Pharmacy/Treatment Route) repeating
• 4: RXC (Pharmacy/Treatment Component Order) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RXC	getRXC()	Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
RXC	getRXC(int rep)	Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
List<RXC>	getRXCAll()	Returns a non-modifiable List containing all current existing repetitions of RXC.
int	getRXCReps()	Returns the number of existing repetitions of RXC
RXG	getRXG()	Returns RXG (Pharmacy/Treatment Give) - creates it if necessary
RXR	getRXR()	Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
RXR	getRXR(int rep)	Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
List<RXR>	getRXRAll()	Returns a non-modifiable List containing all current existing repetitions of RXR.
int	getRXRReps()	Returns the number of existing repetitions of RXR
RRG_O16_TIMING_GIVE	getTIMING_GIVE()	Returns the first repetition of TIMING_GIVE (a Group object) - creates it if necessary
RRG_O16_TIMING_GIVE	getTIMING_GIVE(int rep)	Returns a specific repetition of TIMING_GIVE (a Group object) - creates it if necessary
List<RRG_O16_TIMING_GIVE>	getTIMING_GIVEAll()	Returns a non-modifiable List containing all current existing repetitions of TIMING_GIVE.
int	getTIMING_GIVEReps()	Returns the number of existing repetitions of TIMING_GIVE
String	getVersion()	Returns "2.5.1"
RXC	insertRXC(int rep)	Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
void	insertRXC(RXC structure, int rep)	Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
RXR	insertRXR(int rep)	Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
void	insertRXR(RXR structure, int rep)	Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
RRG_O16_TIMING_GIVE	insertTIMING_GIVE(int rep)	Inserts a specific repetition of TIMING_GIVE (a Group object)
void	insertTIMING_GIVE(RRG_O16_TIMING_GIVE structure, int rep)	Inserts a specific repetition of TIMING_GIVE (a Group object)
RXC	removeRXC(int rep)	Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
RXR	removeRXR(int rep)	Removes a specific repetition of RXR (Pharmacy/Treatment Route)
RRG_O16_TIMING_GIVE	removeTIMING_GIVE(int rep)	Removes a specific repetition of TIMING_GIVE (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

RRG_O16_GIVE

public RRG_O16_GIVE(Group parent,
 ModelClassFactory factory)

Creates a new RRG_O16_GIVE group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getRXG

public RXG getRXG()

Returns RXG (Pharmacy/Treatment Give) - creates it if necessary

getTIMING_GIVE

public RRG_O16_TIMING_GIVE getTIMING_GIVE()

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

getTIMING_GIVE

public RRG_O16_TIMING_GIVE getTIMING_GIVE(int rep)

Returns a specific repetition of TIMING_GIVE (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_GIVEReps

public int getTIMING_GIVEReps()

Returns the number of existing repetitions of TIMING_GIVE

getTIMING_GIVEAll

public List<RRG_O16_TIMING_GIVE> getTIMING_GIVEAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING_GIVE

public void insertTIMING_GIVE(RRG_O16_TIMING_GIVE structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of TIMING_GIVE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertTIMING_GIVE

public RRG_O16_TIMING_GIVE insertTIMING_GIVE(int rep)
                                      throws HL7Exception

Inserts a specific repetition of TIMING_GIVE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeTIMING_GIVE

public RRG_O16_TIMING_GIVE removeTIMING_GIVE(int rep)
                                      throws HL7Exception

Removes a specific repetition of TIMING_GIVE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.

getRXRReps

public int getRXRReps()

Returns the number of existing repetitions of RXR

getRXRAll

public List<RXR> getRXRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXR

public void insertRXR(RXR structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getRXC

public RXC getRXC()

Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.

getRXCReps

public int getRXCReps()

Returns the number of existing repetitions of RXC

getRXCAll

public List<RXC> getRXCAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXC

public void insertRXC(RXC structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRXC

public RXC insertRXC(int rep)
              throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRXC

public RXC removeRXC(int rep)
              throws HL7Exception

Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)