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

Class ORG_O20_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.ORG_O20_SPECIMEN

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORG_O20_SPECIMEN
extends AbstractGroup

Represents a ORG_O20_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: SAC (Specimen Container detail) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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"
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)
SAC	removeSAC(int rep)	Removes a specific repetition of SAC (Specimen Container detail)

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

ORG_O20_SPECIMEN

public ORG_O20_SPECIMEN(Group parent,
 ModelClassFactory factory)

Creates a new ORG_O20_SPECIMEN group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getSPM

public SPM getSPM()

Returns SPM (Specimen) - creates it if necessary

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)