ca.uhn.hl7v2.model.v26.group

Class OPU_R25_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.OPU_R25_SPECIMEN

All Implemented Interfaces:

Group, Structure, Serializable

public class OPU_R25_SPECIMEN
extends AbstractGroup

Represents a OPU_R25_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: OPU_R25_SPECIMEN_OBSERVATION (a Group object) optional repeating
• 3: OPU_R25_CONTAINER (a Group object) optional repeating
• 4: OPU_R25_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
OPU_R25_SPECIMEN(Group parent, ModelClassFactory factory) Creates a new OPU_R25_SPECIMEN group

Method Summary

Methods

Modifier and Type	Method and Description
OPU_R25_CONTAINER	getCONTAINER() Returns the first repetition of CONTAINER (a Group object) - creates it if necessary
OPU_R25_CONTAINER	getCONTAINER(int rep) Returns a specific repetition of CONTAINER (a Group object) - creates it if necessary
List<OPU_R25_CONTAINER>	getCONTAINERAll() Returns a non-modifiable List containing all current existing repetitions of CONTAINER.
int	getCONTAINERReps() Returns the number of existing repetitions of CONTAINER
OPU_R25_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
OPU_R25_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<OPU_R25_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
OPU_R25_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION() Returns the first repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
OPU_R25_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION(int rep) Returns a specific repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
List<OPU_R25_SPECIMEN_OBSERVATION>	getSPECIMEN_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_OBSERVATION.
int	getSPECIMEN_OBSERVATIONReps() Returns the number of existing repetitions of SPECIMEN_OBSERVATION
SPM	getSPM() Returns SPM (Specimen) - creates it if necessary
String	getVersion() Returns "2.6"
OPU_R25_CONTAINER	insertCONTAINER(int rep) Inserts a specific repetition of CONTAINER (a Group object)
void	insertCONTAINER(OPU_R25_CONTAINER structure, int rep) Inserts a specific repetition of CONTAINER (a Group object)
OPU_R25_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(OPU_R25_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
OPU_R25_SPECIMEN_OBSERVATION	insertSPECIMEN_OBSERVATION(int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
void	insertSPECIMEN_OBSERVATION(OPU_R25_SPECIMEN_OBSERVATION structure, int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
OPU_R25_CONTAINER	removeCONTAINER(int rep) Removes a specific repetition of CONTAINER (a Group object)
OPU_R25_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)
OPU_R25_SPECIMEN_OBSERVATION	removeSPECIMEN_OBSERVATION(int rep) Removes a specific repetition of SPECIMEN_OBSERVATION (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

OPU_R25_SPECIMEN

public OPU_R25_SPECIMEN(Group parent,
                ModelClassFactory factory)

Creates a new OPU_R25_SPECIMEN group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getSPM

public SPM getSPM()

Returns SPM (Specimen) - creates it if necessary

getSPECIMEN_OBSERVATION

public OPU_R25_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION()

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

getSPECIMEN_OBSERVATION

public OPU_R25_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION(int rep)

Returns a specific repetition of SPECIMEN_OBSERVATION (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_OBSERVATIONReps

public int getSPECIMEN_OBSERVATIONReps()

Returns the number of existing repetitions of SPECIMEN_OBSERVATION

getSPECIMEN_OBSERVATIONAll

public List<OPU_R25_SPECIMEN_OBSERVATION> getSPECIMEN_OBSERVATIONAll()
                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN_OBSERVATION

public void insertSPECIMEN_OBSERVATION(OPU_R25_SPECIMEN_OBSERVATION structure,
                              int rep)
                                throws HL7Exception

Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN_OBSERVATION

public OPU_R25_SPECIMEN_OBSERVATION insertSPECIMEN_OBSERVATION(int rep)
                                                        throws HL7Exception

Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN_OBSERVATION

public OPU_R25_SPECIMEN_OBSERVATION removeSPECIMEN_OBSERVATION(int rep)
                                                        throws HL7Exception

Removes a specific repetition of SPECIMEN_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCONTAINER

public OPU_R25_CONTAINER getCONTAINER()

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

getCONTAINER

public OPU_R25_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<OPU_R25_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(OPU_R25_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 OPU_R25_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 OPU_R25_CONTAINER removeCONTAINER(int rep)
                                  throws HL7Exception

Removes a specific repetition of CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getORDER

public OPU_R25_ORDER getORDER()

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

getORDER

public OPU_R25_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<OPU_R25_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(OPU_R25_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 OPU_R25_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 OPU_R25_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)