ca.uhn.hl7v2.model.v23.group

Class RDR_RDR_ENCODING

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.RDR_RDR_ENCODING

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RDR_RDR_ENCODING
extends AbstractGroup

Represents a RDR_RDR_ENCODING 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: RXE (Pharmacy encoded order segment)
• 2: RXR (Pharmacy route segment)
• 3: RXC (Pharmacy component order segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RXC	getRXC() Returns the first repetition of RXC (Pharmacy component order segment) - creates it if necessary
RXC	getRXC(int rep) Returns a specific repetition of RXC (Pharmacy component order segment) - 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
RXE	getRXE() Returns RXE (Pharmacy encoded order segment) - creates it if necessary
RXR	getRXR() Returns RXR (Pharmacy route segment) - creates it if necessary
String	getVersion() Returns "2.3"
RXC	insertRXC(int rep) Inserts a specific repetition of RXC (Pharmacy component order segment)
void	insertRXC(RXC structure, int rep) Inserts a specific repetition of RXC (Pharmacy component order segment)
RXC	removeRXC(int rep) Removes a specific repetition of RXC (Pharmacy component order 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

RDR_RDR_ENCODING

public RDR_RDR_ENCODING(Group parent,
                        ModelClassFactory factory)

Creates a new RDR_RDR_ENCODING group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getRXE

public RXE getRXE()

Returns RXE (Pharmacy encoded order segment) - creates it if necessary

getRXR

public RXR getRXR()

Returns RXR (Pharmacy route segment) - creates it if necessary

getRXC

public RXC getRXC()

Returns the first repetition of RXC (Pharmacy component order segment) - creates it if necessary

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (Pharmacy component order 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.

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 component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXC

public RXC insertRXC(int rep)
              throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXC

public RXC removeRXC(int rep)
              throws HL7Exception

Removes a specific repetition of RXC (Pharmacy component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)