ca.uhn.hl7v2.model.v281.group

Class ORL_O43_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.ORL_O43_SPECIMEN

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O43_SPECIMEN
extends AbstractGroup

Represents a ORL_O43_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: ORL_O43_SPECIMEN_OBSERVATION (a Group object) optional repeating
• 3: NTE (Notes and Comments) optional repeating
• 4: ORL_O43_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 and Description
ORL_O43_SPECIMEN(Group parent, ModelClassFactory factory) Creates a new ORL_O43_SPECIMEN group

Method Summary

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
ORL_O43_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER() Returns the first repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
ORL_O43_SPECIMEN_CONTAINER	getSPECIMEN_CONTAINER(int rep) Returns a specific repetition of SPECIMEN_CONTAINER (a Group object) - creates it if necessary
List<ORL_O43_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
ORL_O43_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION() Returns the first repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
ORL_O43_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION(int rep) Returns a specific repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
List<ORL_O43_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"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
ORL_O43_SPECIMEN_CONTAINER	insertSPECIMEN_CONTAINER(int rep) Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
void	insertSPECIMEN_CONTAINER(ORL_O43_SPECIMEN_CONTAINER structure, int rep) Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
ORL_O43_SPECIMEN_OBSERVATION	insertSPECIMEN_OBSERVATION(int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
void	insertSPECIMEN_OBSERVATION(ORL_O43_SPECIMEN_OBSERVATION structure, int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
ORL_O43_SPECIMEN_CONTAINER	removeSPECIMEN_CONTAINER(int rep) Removes a specific repetition of SPECIMEN_CONTAINER (a Group object)
ORL_O43_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

ORL_O43_SPECIMEN

public ORL_O43_SPECIMEN(Group parent,
                        ModelClassFactory factory)

Creates a new ORL_O43_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 ORL_O43_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION()

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

getSPECIMEN_OBSERVATION

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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSPECIMEN_CONTAINER

public ORL_O43_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER()

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

getSPECIMEN_CONTAINER

public ORL_O43_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_O43_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_O43_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_O43_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_O43_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)