ca.uhn.hl7v2.model.v25.group

Class CSU_C09_STUDY_OBSERVATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.CSU_C09_STUDY_OBSERVATION

All Implemented Interfaces:

Group, Structure, Serializable

public class CSU_C09_STUDY_OBSERVATION
extends AbstractGroup

Represents a CSU_C09_STUDY_OBSERVATION 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 (Common Order) optional
• 2: OBR (Observation Request)
• 3: CSU_C09_TIMING_QTY (a Group object) optional repeating
• 4: OBX (Observation/Result) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OBX	getOBX() Returns the first repetition of OBX (Observation/Result) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
List<OBX>	getOBXAll() Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps() Returns the number of existing repetitions of OBX
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
CSU_C09_TIMING_QTY	getTIMING_QTY() Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary
CSU_C09_TIMING_QTY	getTIMING_QTY(int rep) Returns a specific repetition of TIMING_QTY (a Group object) - creates it if necessary
List<CSU_C09_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.5"
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (Observation/Result)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (Observation/Result)
void	insertTIMING_QTY(CSU_C09_TIMING_QTY structure, int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
CSU_C09_TIMING_QTY	insertTIMING_QTY(int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)
CSU_C09_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, 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

CSU_C09_STUDY_OBSERVATION

public CSU_C09_STUDY_OBSERVATION(Group parent,
                         ModelClassFactory factory)

Creates a new CSU_C09_STUDY_OBSERVATION group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getTIMING_QTY

public CSU_C09_TIMING_QTY getTIMING_QTY()

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

getTIMING_QTY

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

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation/Result) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation/Result) - 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.

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX

public void insertOBX(OBX structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)