ca.uhn.hl7v2.model.v26.group

Class OPR_O38_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPR_O38_SPECIMEN

All Implemented Interfaces:

Group, Structure, Serializable

public class OPR_O38_SPECIMEN
extends AbstractGroup

Represents a OPR_O38_SPECIMEN 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: SPM (Specimen)
• 2: OBX (Observation/Result) optional repeating
• 3: SAC (Specimen Container detail) optional repeating
• 4: OPR_O38_OBSERVATION_REQUEST (a Group object) optional repeating
• 5: OPR_O38_TIMING (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
OPR_O38_OBSERVATION_REQUEST	getOBSERVATION_REQUEST() Returns the first repetition of OBSERVATION_REQUEST (a Group object) - creates it if necessary
OPR_O38_OBSERVATION_REQUEST	getOBSERVATION_REQUEST(int rep) Returns a specific repetition of OBSERVATION_REQUEST (a Group object) - creates it if necessary
List<OPR_O38_OBSERVATION_REQUEST>	getOBSERVATION_REQUESTAll() Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_REQUEST.
int	getOBSERVATION_REQUESTReps() Returns the number of existing repetitions of OBSERVATION_REQUEST
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
SAC	getSAC() Returns the first repetition of SAC (Specimen Container detail) - creates it if necessary
SAC	getSAC(int rep) Returns a specific repetition of SAC (Specimen Container detail) - creates it if necessary
List<SAC>	getSACAll() Returns a non-modifiable List containing all current existing repetitions of SAC.
int	getSACReps() Returns the number of existing repetitions of SAC
SPM	getSPM() Returns SPM (Specimen) - creates it if necessary
OPR_O38_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
OPR_O38_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<OPR_O38_TIMING>	getTIMINGAll() Returns a non-modifiable List containing all current existing repetitions of TIMING.
int	getTIMINGReps() Returns the number of existing repetitions of TIMING
String	getVersion() Returns "2.6"
OPR_O38_OBSERVATION_REQUEST	insertOBSERVATION_REQUEST(int rep) Inserts a specific repetition of OBSERVATION_REQUEST (a Group object)
void	insertOBSERVATION_REQUEST(OPR_O38_OBSERVATION_REQUEST structure, int rep) Inserts a specific repetition of OBSERVATION_REQUEST (a Group object)
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)
SAC	insertSAC(int rep) Inserts a specific repetition of SAC (Specimen Container detail)
void	insertSAC(SAC structure, int rep) Inserts a specific repetition of SAC (Specimen Container detail)
OPR_O38_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(OPR_O38_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
OPR_O38_OBSERVATION_REQUEST	removeOBSERVATION_REQUEST(int rep) Removes a specific repetition of OBSERVATION_REQUEST (a Group object)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)
SAC	removeSAC(int rep) Removes a specific repetition of SAC (Specimen Container detail)
OPR_O38_TIMING	removeTIMING(int rep) Removes a specific repetition of TIMING (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

OPR_O38_SPECIMEN

public OPR_O38_SPECIMEN(Group parent,
                ModelClassFactory factory)

Creates a new OPR_O38_SPECIMEN group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getSPM

public SPM getSPM()

Returns SPM (Specimen) - creates it if necessary

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)

getSAC

public SAC getSAC()

Returns the first repetition of SAC (Specimen Container detail) - creates it if necessary

getSAC

public SAC getSAC(int rep)

Returns a specific repetition of SAC (Specimen Container detail) - 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.

getSACReps

public int getSACReps()

Returns the number of existing repetitions of SAC

getSACAll

public List<SAC> getSACAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSAC

public void insertSAC(SAC structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SAC (Specimen Container detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSAC

public SAC insertSAC(int rep)
              throws HL7Exception

Inserts a specific repetition of SAC (Specimen Container detail)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSAC

public SAC removeSAC(int rep)
              throws HL7Exception

Removes a specific repetition of SAC (Specimen Container detail)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBSERVATION_REQUEST

public OPR_O38_OBSERVATION_REQUEST getOBSERVATION_REQUEST()

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

getOBSERVATION_REQUEST

public OPR_O38_OBSERVATION_REQUEST getOBSERVATION_REQUEST(int rep)

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

getOBSERVATION_REQUESTReps

public int getOBSERVATION_REQUESTReps()

Returns the number of existing repetitions of OBSERVATION_REQUEST

getOBSERVATION_REQUESTAll

public List<OPR_O38_OBSERVATION_REQUEST> getOBSERVATION_REQUESTAll()
                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION_REQUEST

public void insertOBSERVATION_REQUEST(OPR_O38_OBSERVATION_REQUEST structure,
                             int rep)
                               throws HL7Exception

Inserts a specific repetition of OBSERVATION_REQUEST (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION_REQUEST

public OPR_O38_OBSERVATION_REQUEST insertOBSERVATION_REQUEST(int rep)
                                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION_REQUEST (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION_REQUEST

public OPR_O38_OBSERVATION_REQUEST removeOBSERVATION_REQUEST(int rep)
                                                      throws HL7Exception

Removes a specific repetition of OBSERVATION_REQUEST (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getTIMING

public OPR_O38_TIMING getTIMING()

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

getTIMING

public OPR_O38_TIMING getTIMING(int rep)

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

getTIMINGReps

public int getTIMINGReps()

Returns the number of existing repetitions of TIMING

getTIMINGAll

public List<OPR_O38_TIMING> getTIMINGAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING

public void insertTIMING(OPR_O38_TIMING structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTIMING

public OPR_O38_TIMING insertTIMING(int rep)
                            throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTIMING

public OPR_O38_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)