ca.uhn.hl7v2.model.v281.group

Class CSU_C09_STUDY_OBSERVATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CSU_C09_STUDY_OBSERVATION

All Implemented Interfaces:

Group, Structure, Visitable, 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: CSU_C09_ORCPRT (a Group object) optional
• 2: OBR (Observation Request)
• 3: PRT (Participation Information) optional repeating
• 4: CSU_C09_TIMING_QTY (a Group object) optional repeating
• 5: OBX (Observation/Result)
• 6: PRT (Participation Information) optional 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

Modifier and Type	Method and Description
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OBX	getOBX() Returns OBX (Observation/Result) - creates it if necessary
CSU_C09_ORCPRT	getORCPRT() Returns ORCPRT (a Group object) - creates it if necessary
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT2() Returns the first repetition of PRT2 (Participation Information) - creates it if necessary
PRT	getPRT2(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRT2All() Returns a non-modifiable List containing all current existing repetitions of PRT2.
int	getPRT2Reps() Returns the number of existing repetitions of PRT2
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
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.8.1"
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
PRT	insertPRT2(int rep) Inserts a specific repetition of PRT2 (Participation Information)
void	insertPRT2(PRT structure, int rep) Inserts a specific repetition of PRT2 (Participation Information)
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)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
PRT	removePRT2(int rep) Removes a specific repetition of PRT2 (Participation Information)
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

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

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.8.1"

getORCPRT

public CSU_C09_ORCPRT getORCPRT()

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

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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 OBX (Observation/Result) - creates it if necessary

getPRT2

public PRT getPRT2()

Returns the first repetition of PRT2 (Participation Information) - creates it if necessary

getPRT2

public PRT getPRT2(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRT2Reps

public int getPRT2Reps()

Returns the number of existing repetitions of PRT2

getPRT2All

public List<PRT> getPRT2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT2

public void insertPRT2(PRT structure,
                       int rep)
                throws HL7Exception

Inserts a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT2

public PRT insertPRT2(int rep)
               throws HL7Exception

Inserts a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT2

public PRT removePRT2(int rep)
               throws HL7Exception

Removes a specific repetition of PRT2 (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)