ca.uhn.hl7v2.model.v231.group

Class VXU_V04_ORCRXARXROBXNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.VXU_V04_ORCRXARXROBXNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class VXU_V04_ORCRXARXROBXNTE
extends AbstractGroup

Represents a VXU_V04_ORCRXARXROBXNTE 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 (ORC - common order segment) optional
• 2: RXA (RXA - pharmacy/treatment administration segment)
• 3: RXR (RXR - pharmacy/treatment route segment) optional
• 4: VXU_V04_OBXNTE (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VXU_V04_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
VXU_V04_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<VXU_V04_OBXNTE>	getOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
ORC	getORC() Returns ORC (ORC - common order segment) - creates it if necessary
RXA	getRXA() Returns RXA (RXA - pharmacy/treatment administration segment) - creates it if necessary
RXR	getRXR() Returns RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
VXU_V04_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(VXU_V04_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
VXU_V04_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

VXU_V04_ORCRXARXROBXNTE

public VXU_V04_ORCRXARXROBXNTE(Group parent,
                       ModelClassFactory factory)

Creates a new VXU_V04_ORCRXARXROBXNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getORC

public ORC getORC()

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

getRXA

public RXA getRXA()

Returns RXA (RXA - pharmacy/treatment administration segment) - creates it if necessary

getRXR

public RXR getRXR()

Returns RXR (RXR - pharmacy/treatment route segment) - creates it if necessary

getOBXNTE

public VXU_V04_OBXNTE getOBXNTE()

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

getOBXNTE

public VXU_V04_OBXNTE getOBXNTE(int rep)

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

getOBXNTEReps

public int getOBXNTEReps()

Returns the number of existing repetitions of OBXNTE

getOBXNTEAll

public List<VXU_V04_OBXNTE> getOBXNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertOBXNTE

public void insertOBXNTE(VXU_V04_OBXNTE structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTE

public VXU_V04_OBXNTE insertOBXNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTE

public VXU_V04_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)