ca.uhn.hl7v2.model.v23.group

Class RAR_RAR_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.RAR_RAR_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RAR_RAR_ORDER
extends AbstractGroup

Represents a RAR_RAR_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: RAR_RAR_ENCODING (a Group object) optional
• 3: RXA (Pharmacy administration segment) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RAR_RAR_ENCODING	getENCODING() Returns ENCODING (a Group object) - creates it if necessary
ORC	getORC() Returns ORC (Common order segment) - creates it if necessary
RXA	getRXA() Returns the first repetition of RXA (Pharmacy administration segment) - creates it if necessary
RXA	getRXA(int rep) Returns a specific repetition of RXA (Pharmacy administration segment) - creates it if necessary
List<RXA>	getRXAAll() Returns a non-modifiable List containing all current existing repetitions of RXA.
int	getRXAReps() Returns the number of existing repetitions of RXA
String	getVersion() Returns "2.3"
RXA	insertRXA(int rep) Inserts a specific repetition of RXA (Pharmacy administration segment)
void	insertRXA(RXA structure, int rep) Inserts a specific repetition of RXA (Pharmacy administration segment)
RXA	removeRXA(int rep) Removes a specific repetition of RXA (Pharmacy administration segment)

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

RAR_RAR_ORDER

public RAR_RAR_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new RAR_RAR_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getORC

public ORC getORC()

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

getENCODING

public RAR_RAR_ENCODING getENCODING()

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

getRXA

public RXA getRXA()

Returns the first repetition of RXA (Pharmacy administration segment) - creates it if necessary

getRXA

public RXA getRXA(int rep)

Returns a specific repetition of RXA (Pharmacy administration segment) - 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.

getRXAReps

public int getRXAReps()

Returns the number of existing repetitions of RXA

getRXAAll

public List<RXA> getRXAAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRXA

public void insertRXA(RXA structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXA (Pharmacy administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXA

public RXA insertRXA(int rep)
              throws HL7Exception

Inserts a specific repetition of RXA (Pharmacy administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXA

public RXA removeRXA(int rep)
              throws HL7Exception

Removes a specific repetition of RXA (Pharmacy administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)