ca.uhn.hl7v2.model.v281.group

Class ORU_R01_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.ORU_R01_SPECIMEN

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORU_R01_SPECIMEN
extends AbstractGroup

Represents a ORU_R01_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: ORU_R01_SPECIMEN_OBSERVATION (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ORU_R01_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION() Returns the first repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
ORU_R01_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION(int rep) Returns a specific repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
List<ORU_R01_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.8.1"
ORU_R01_SPECIMEN_OBSERVATION	insertSPECIMEN_OBSERVATION(int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
void	insertSPECIMEN_OBSERVATION(ORU_R01_SPECIMEN_OBSERVATION structure, int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
ORU_R01_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

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 Detail

ORU_R01_SPECIMEN

public ORU_R01_SPECIMEN(Group parent,
                        ModelClassFactory factory)

Creates a new ORU_R01_SPECIMEN group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getSPM

public SPM getSPM()

Returns SPM (Specimen) - creates it if necessary

getSPECIMEN_OBSERVATION

public ORU_R01_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION()

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

getSPECIMEN_OBSERVATION

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