ca.uhn.hl7v2.model.v281.group

Class RRA_O18_ADMINISTRATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.RRA_O18_ADMINISTRATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RRA_O18_ADMINISTRATION
extends AbstractGroup

Represents a RRA_O18_ADMINISTRATION 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: RRA_O18_TREATMENT (a Group object) repeating
• 2: RXR (Pharmacy/Treatment Route)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RXR	getRXR() Returns RXR (Pharmacy/Treatment Route) - creates it if necessary
RRA_O18_TREATMENT	getTREATMENT() Returns the first repetition of TREATMENT (a Group object) - creates it if necessary
RRA_O18_TREATMENT	getTREATMENT(int rep) Returns a specific repetition of TREATMENT (a Group object) - creates it if necessary
List<RRA_O18_TREATMENT>	getTREATMENTAll() Returns a non-modifiable List containing all current existing repetitions of TREATMENT.
int	getTREATMENTReps() Returns the number of existing repetitions of TREATMENT
String	getVersion() Returns "2.8.1"
RRA_O18_TREATMENT	insertTREATMENT(int rep) Inserts a specific repetition of TREATMENT (a Group object)
void	insertTREATMENT(RRA_O18_TREATMENT structure, int rep) Inserts a specific repetition of TREATMENT (a Group object)
RRA_O18_TREATMENT	removeTREATMENT(int rep) Removes a specific repetition of TREATMENT (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

RRA_O18_ADMINISTRATION

public RRA_O18_ADMINISTRATION(Group parent,
                              ModelClassFactory factory)

Creates a new RRA_O18_ADMINISTRATION group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getTREATMENT

public RRA_O18_TREATMENT getTREATMENT()

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

getTREATMENT

public RRA_O18_TREATMENT getTREATMENT(int rep)

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

getTREATMENTReps

public int getTREATMENTReps()

Returns the number of existing repetitions of TREATMENT

getTREATMENTAll

public List<RRA_O18_TREATMENT> getTREATMENTAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertTREATMENT

public void insertTREATMENT(RRA_O18_TREATMENT structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of TREATMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTREATMENT

public RRA_O18_TREATMENT insertTREATMENT(int rep)
                                  throws HL7Exception

Inserts a specific repetition of TREATMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTREATMENT

public RRA_O18_TREATMENT removeTREATMENT(int rep)
                                  throws HL7Exception

Removes a specific repetition of TREATMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

Returns RXR (Pharmacy/Treatment Route) - creates it if necessary