ca.uhn.hl7v2.model.v26.group

Class OPU_R25_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPU_R25_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class OPU_R25_ORDER
extends AbstractGroup

Represents a OPU_R25_ORDER 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: OBR (Observation Request)
• 2: ORC (Common Order) optional
• 3: NTE (Notes and Comments) optional repeating
• 4: ROL (Role) optional repeating
• 5: OPU_R25_TIMING_QTY (a Group object) optional repeating
• 6: OPU_R25_RESULT (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
OPU_R25_RESULT	getRESULT() Returns the first repetition of RESULT (a Group object) - creates it if necessary
OPU_R25_RESULT	getRESULT(int rep) Returns a specific repetition of RESULT (a Group object) - creates it if necessary
List<OPU_R25_RESULT>	getRESULTAll() Returns a non-modifiable List containing all current existing repetitions of RESULT.
int	getRESULTReps() Returns the number of existing repetitions of RESULT
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
OPU_R25_TIMING_QTY	getTIMING_QTY() Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary
OPU_R25_TIMING_QTY	getTIMING_QTY(int rep) Returns a specific repetition of TIMING_QTY (a Group object) - creates it if necessary
List<OPU_R25_TIMING_QTY>	getTIMING_QTYAll() Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY.
int	getTIMING_QTYReps() Returns the number of existing repetitions of TIMING_QTY
String	getVersion() Returns "2.6"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
OPU_R25_RESULT	insertRESULT(int rep) Inserts a specific repetition of RESULT (a Group object)
void	insertRESULT(OPU_R25_RESULT structure, int rep) Inserts a specific repetition of RESULT (a Group object)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
OPU_R25_TIMING_QTY	insertTIMING_QTY(int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
void	insertTIMING_QTY(OPU_R25_TIMING_QTY structure, int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OPU_R25_RESULT	removeRESULT(int rep) Removes a specific repetition of RESULT (a Group object)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)
OPU_R25_TIMING_QTY	removeTIMING_QTY(int rep) Removes a specific repetition of TIMING_QTY (a Group object)

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

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, 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

OPU_R25_ORDER

public OPU_R25_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new OPU_R25_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - 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.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getTIMING_QTY

public OPU_R25_TIMING_QTY getTIMING_QTY()

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

getTIMING_QTY

public OPU_R25_TIMING_QTY getTIMING_QTY(int rep)

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

getTIMING_QTYReps

public int getTIMING_QTYReps()

Returns the number of existing repetitions of TIMING_QTY

getTIMING_QTYAll

public List<OPU_R25_TIMING_QTY> getTIMING_QTYAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING_QTY

public void insertTIMING_QTY(OPU_R25_TIMING_QTY structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTIMING_QTY

public OPU_R25_TIMING_QTY insertTIMING_QTY(int rep)
                                    throws HL7Exception

Inserts a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTIMING_QTY

public OPU_R25_TIMING_QTY removeTIMING_QTY(int rep)
                                    throws HL7Exception

Removes a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRESULT

public OPU_R25_RESULT getRESULT()

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

getRESULT

public OPU_R25_RESULT getRESULT(int rep)

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

getRESULTReps

public int getRESULTReps()

Returns the number of existing repetitions of RESULT

getRESULTAll

public List<OPU_R25_RESULT> getRESULTAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertRESULT

public void insertRESULT(OPU_R25_RESULT structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRESULT

public OPU_R25_RESULT insertRESULT(int rep)
                            throws HL7Exception

Inserts a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRESULT

public OPU_R25_RESULT removeRESULT(int rep)
                            throws HL7Exception

Removes a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)