ca.uhn.hl7v2.model.v231.group

Class ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG

All Implemented Interfaces:

Group, Structure, Serializable

public class ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG
extends AbstractGroup

Represents a ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG 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: ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE (a Group object) optional
• 3: CTI (CTI - clinical trial identification segment) optional repeating
• 4: BLG (BLG - billing segment) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BLG	getBLG() Returns BLG (BLG - billing segment) - creates it if necessary
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
ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE	getOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE() Returns OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE (a Group object) - creates it if necessary
ORC	getORC() Returns ORC (ORC - common order 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)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (CTI - clinical trial identification 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

ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG

public ORM_O01_ORCOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTECTIBLG(Group parent,
                                                        ModelClassFactory factory)

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

getOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE

public ORM_O01_OBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE getOBRRQDRQ1ODSODTRXONTEDG1RXRRXCNTEOBXNTE()

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

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)

getBLG

public BLG getBLG()

Returns BLG (BLG - billing segment) - creates it if necessary