ca.uhn.hl7v2.model.v231.group

Class RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI
extends AbstractGroup

Represents a RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI 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: RAS_O01_RXONTERXRRXCNTE (a Group object) optional
• 3: RAS_O01_RXERXRRXC (a Group object) optional
• 4: RXA (RXA - pharmacy/treatment administration segment) repeating
• 5: RXR (RXR - pharmacy/treatment route segment)
• 6: RAS_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
RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI(Group parent, ModelClassFactory factory) Creates a new RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI group

Method Summary

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
RAS_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
RAS_O01_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<RAS_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
RXA	getRXA() Returns the first repetition of RXA (RXA - pharmacy/treatment administration segment) - creates it if necessary
RXA	getRXA(int rep) Returns a specific repetition of RXA (RXA - pharmacy/treatment 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
RAS_O01_RXERXRRXC	getRXERXRRXC() Returns RXERXRRXC (a Group object) - creates it if necessary
RAS_O01_RXONTERXRRXCNTE	getRXONTERXRRXCNTE() Returns RXONTERXRRXCNTE (a Group object) - creates it if necessary
RXR	getRXR() Returns RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
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)
RAS_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(RAS_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
RXA	insertRXA(int rep) Inserts a specific repetition of RXA (RXA - pharmacy/treatment administration segment)
void	insertRXA(RXA structure, int rep) Inserts a specific repetition of RXA (RXA - pharmacy/treatment administration segment)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (CTI - clinical trial identification segment)
RAS_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
RXA	removeRXA(int rep) Removes a specific repetition of RXA (RXA - pharmacy/treatment 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

RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI

public RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI(Group parent,
                                                          ModelClassFactory factory)

Creates a new RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI 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 RAS_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE()

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

getRXERXRRXC

public RAS_O01_RXERXRRXC getRXERXRRXC()

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

getRXA

public RXA getRXA()

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

getRXA

public RXA getRXA(int rep)

Returns a specific repetition of RXA (RXA - pharmacy/treatment 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 (RXA - pharmacy/treatment administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXA

public RXA insertRXA(int rep)
              throws HL7Exception

Inserts a specific repetition of RXA (RXA - pharmacy/treatment administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXA

public RXA removeRXA(int rep)
              throws HL7Exception

Removes a specific repetition of RXA (RXA - pharmacy/treatment administration segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXR

public RXR getRXR()

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

getOBXNTE

public RAS_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public RAS_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<RAS_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(RAS_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 RAS_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 RAS_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)