ca.uhn.hl7v2.model.v26.group

Class OPL_O37_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPL_O37_SPECIMEN

All Implemented Interfaces:

Group, Structure, Serializable

public class OPL_O37_SPECIMEN
extends AbstractGroup

Represents a OPL_O37_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: OPL_O37_CONTAINER (a Group object) optional repeating
• 4: OPL_O37_OBSERVATION_REQUEST (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
OPL_O37_SPECIMEN(Group parent, ModelClassFactory factory) Creates a new OPL_O37_SPECIMEN group

Method Summary

Methods

Modifier and Type	Method and Description
OPL_O37_CONTAINER	getCONTAINER() Returns the first repetition of CONTAINER (a Group object) - creates it if necessary
OPL_O37_CONTAINER	getCONTAINER(int rep) Returns a specific repetition of CONTAINER (a Group object) - creates it if necessary
List<OPL_O37_CONTAINER>	getCONTAINERAll() Returns a non-modifiable List containing all current existing repetitions of CONTAINER.
int	getCONTAINERReps() Returns the number of existing repetitions of CONTAINER
OPL_O37_OBSERVATION_REQUEST	getOBSERVATION_REQUEST() Returns the first repetition of OBSERVATION_REQUEST (a Group object) - creates it if necessary
OPL_O37_OBSERVATION_REQUEST	getOBSERVATION_REQUEST(int rep) Returns a specific repetition of OBSERVATION_REQUEST (a Group object) - creates it if necessary
List<OPL_O37_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
SPM	getSPM() Returns SPM (Specimen) - creates it if necessary
String	getVersion() Returns "2.6"
OPL_O37_CONTAINER	insertCONTAINER(int rep) Inserts a specific repetition of CONTAINER (a Group object)
void	insertCONTAINER(OPL_O37_CONTAINER structure, int rep) Inserts a specific repetition of CONTAINER (a Group object)
OPL_O37_OBSERVATION_REQUEST	insertOBSERVATION_REQUEST(int rep) Inserts a specific repetition of OBSERVATION_REQUEST (a Group object)
void	insertOBSERVATION_REQUEST(OPL_O37_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)
OPL_O37_CONTAINER	removeCONTAINER(int rep) Removes a specific repetition of CONTAINER (a Group object)
OPL_O37_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)

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

OPL_O37_SPECIMEN

public OPL_O37_SPECIMEN(Group parent,
                ModelClassFactory factory)

Creates a new OPL_O37_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)

getCONTAINER

public OPL_O37_CONTAINER getCONTAINER()

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

getCONTAINER

public OPL_O37_CONTAINER getCONTAINER(int rep)

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

getCONTAINERReps

public int getCONTAINERReps()

Returns the number of existing repetitions of CONTAINER

getCONTAINERAll

public List<OPL_O37_CONTAINER> getCONTAINERAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertCONTAINER

public void insertCONTAINER(OPL_O37_CONTAINER structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCONTAINER

public OPL_O37_CONTAINER insertCONTAINER(int rep)
                                  throws HL7Exception

Inserts a specific repetition of CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCONTAINER

public OPL_O37_CONTAINER removeCONTAINER(int rep)
                                  throws HL7Exception

Removes a specific repetition of CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBSERVATION_REQUEST

public OPL_O37_OBSERVATION_REQUEST getOBSERVATION_REQUEST()

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

getOBSERVATION_REQUEST

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