ca.uhn.hl7v2.model.v251.group

Class OML_O33_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.OML_O33_SPECIMEN

All Implemented Interfaces:

Group, Structure, Serializable

public class OML_O33_SPECIMEN
extends AbstractGroup

Represents a OML_O33_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: OML_O33_ORDER (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
OML_O33_SPECIMEN(Group parent, ModelClassFactory factory) Creates a new OML_O33_SPECIMEN group

Method Summary

Methods

Modifier and Type	Method and Description
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
OML_O33_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
OML_O33_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<OML_O33_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
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
String	getVersion() Returns "2.5.1"
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)
OML_O33_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(OML_O33_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
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)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)
OML_O33_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)
SAC	removeSAC(int rep) Removes a specific repetition of SAC (Specimen Container detail)

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

OML_O33_SPECIMEN

public OML_O33_SPECIMEN(Group parent,
                ModelClassFactory factory)

Creates a new OML_O33_SPECIMEN group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

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)

getORDER

public OML_O33_ORDER getORDER()

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

getORDER

public OML_O33_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<OML_O33_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(OML_O33_ORDER structure,
               int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER

public OML_O33_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER

public OML_O33_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)