Package ca.uhn.hl7v2.model.v251.group

Class ORL_O36_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.ORL_O36_SPECIMEN

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O36_SPECIMEN
extends AbstractGroup

Represents a ORL_O36_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: ORL_O36_SPECIMEN_CONTAINER (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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
ORL_O36_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER()	Returns the first repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
ORL_O36_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER(int rep)	Returns a specific repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
List<ORL_O36_SPECIMEN_CONTAINER>	getSPECIMEN_CONTAINERAll()	Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_CONTAINER.
int	getSPECIMEN_CONTAINERReps()	Returns the number of existing repetitions of SPECIMEN_CONTAINER
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)
ORL_O36_SPECIMEN_CONTAINER	insertSPECIMEN_CONTAINER(int rep)	Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
void	insertSPECIMEN_CONTAINER(ORL_O36_SPECIMEN_CONTAINER structure, int rep)	Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation/Result)
ORL_O36_SPECIMEN_CONTAINER	removeSPECIMEN_CONTAINER(int rep)	Removes a specific repetition of SPECIMEN_CONTAINER (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 Details

ORL_O36_SPECIMEN

public ORL_O36_SPECIMEN(Group parent,
 ModelClassFactory factory)

Creates a new ORL_O36_SPECIMEN group

Method Details

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)

getSPECIMEN_CONTAINER

public ORL_O36_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER()

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

getSPECIMEN_CONTAINER

public ORL_O36_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER(int rep)

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

getSPECIMEN_CONTAINERReps

public int getSPECIMEN_CONTAINERReps()

Returns the number of existing repetitions of SPECIMEN_CONTAINER

getSPECIMEN_CONTAINERAll

public List<ORL_O36_SPECIMEN_CONTAINER> getSPECIMEN_CONTAINERAll()
                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN_CONTAINER

public void insertSPECIMEN_CONTAINER(ORL_O36_SPECIMEN_CONTAINER structure,
 int rep)
                              throws HL7Exception

Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN_CONTAINER

public ORL_O36_SPECIMEN_CONTAINER insertSPECIMEN_CONTAINER(int rep)
                                                    throws HL7Exception

Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN_CONTAINER

public ORL_O36_SPECIMEN_CONTAINER removeSPECIMEN_CONTAINER(int rep)
                                                    throws HL7Exception

Removes a specific repetition of SPECIMEN_CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)