ca.uhn.hl7v2.model.v231.group

Class RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI

All Implemented Interfaces:

Group, Structure, Serializable

public class RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI
extends AbstractGroup

Represents a RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI 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)
• 2: RDE_O01_RXONTERXRRXCNTE (a Group object) optional
• 3: RXE (RXE - pharmacy/treatment encoded order segment)
• 4: RXR (RXR - pharmacy/treatment route segment) repeating
• 5: RXC (RXC - pharmacy/treatment component order segment) optional repeating
• 6: RDE_O01_OBXNTE (a Group object) optional repeating
• 7: CTI (CTI - clinical trial identification 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
RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI(Group parent, ModelClassFactory factory) Creates a new RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI group

Method Summary

Methods

Modifier and Type	Method and Description
CTI	getCTI() Returns the first repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary
CTI	getCTI(int rep) Returns a specific repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary
List<CTI>	getCTIAll() Returns a non-modifiable List containing all current existing repetitions of CTI.
int	getCTIReps() Returns the number of existing repetitions of CTI
RDE_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
RDE_O01_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<RDE_O01_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
RXC	getRXC() Returns the first repetition of RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
RXC	getRXC(int rep) Returns a specific repetition of RXC (RXC - pharmacy/treatment 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 (RXE - pharmacy/treatment encoded order segment) - creates it if necessary
RDE_O01_RXONTERXRRXCNTE	getRXONTERXRRXCNTE() Returns RXONTERXRRXCNTE (a Group object) - creates it if necessary
RXR	getRXR() Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
RXR	getRXR(int rep) Returns a specific repetition of RXR (RXR - pharmacy/treatment route segment) - 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
String	getVersion() Returns "2.3.1"
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
RDE_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(RDE_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
RXC	insertRXC(int rep) Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
void	insertRXC(RXC structure, int rep) Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
RXR	insertRXR(int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
void	insertRXR(RXR structure, int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (CTI - clinical trial identification segment)
RDE_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
RXC	removeRXC(int rep) Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
RXR	removeRXR(int rep) Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)

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

RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI

public RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI(Group parent,
                                            ModelClassFactory factory)

Creates a new RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI 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

getRXONTERXRRXCNTE

public RDE_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE()

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

getRXE

public RXE getRXE()

Returns RXE (RXE - pharmacy/treatment encoded order segment) - creates it if necessary

getRXR

public RXR getRXR()

Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (RXR - pharmacy/treatment route 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.

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 (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXC

public RXC getRXC()

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

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (RXC - pharmacy/treatment 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 (RXC - pharmacy/treatment 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 (RXC - pharmacy/treatment 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 (RXC - pharmacy/treatment component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTE

public RDE_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public RDE_O01_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<RDE_O01_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(RDE_O01_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 RDE_O01_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 RDE_O01_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (CTI - clinical trial identification segment) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (CTI - clinical trial identification 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

getCTIAll

public List<CTI> getCTIAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCTI

public void insertCTI(CTI structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (CTI - clinical trial identification segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)