ca.uhn.hl7v2.model.v281.group

Class OSM_R26_SPECIMEN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.OSM_R26_SPECIMEN

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OSM_R26_SPECIMEN
extends AbstractGroup

Represents a OSM_R26_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: PRT (Participation Information) optional repeating
• 3: OSM_R26_SPECIMEN_OBSERVATION (a Group object) optional repeating
• 4: OSM_R26_CONTAINER (a Group object) optional repeating
• 5: OSM_R26_SUBJECT_PERSON_ANIMAL_IDENTIFICATION (a Group object) optional
• 6: OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION (a Group object) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OSM_R26_CONTAINER	getCONTAINER() Returns the first repetition of CONTAINER (a Group object) - creates it if necessary
OSM_R26_CONTAINER	getCONTAINER(int rep) Returns a specific repetition of CONTAINER (a Group object) - creates it if necessary
List<OSM_R26_CONTAINER>	getCONTAINERAll() Returns a non-modifiable List containing all current existing repetitions of CONTAINER.
int	getCONTAINERReps() Returns the number of existing repetitions of CONTAINER
PRT	getPRT() Returns the first repetition of PRT (Participation Information) - creates it if necessary
PRT	getPRT(int rep) Returns a specific repetition of PRT (Participation Information) - creates it if necessary
List<PRT>	getPRTAll() Returns a non-modifiable List containing all current existing repetitions of PRT.
int	getPRTReps() Returns the number of existing repetitions of PRT
OSM_R26_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION() Returns the first repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
OSM_R26_SPECIMEN_OBSERVATION	getSPECIMEN_OBSERVATION(int rep) Returns a specific repetition of SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
List<OSM_R26_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
OSM_R26_SUBJECT_PERSON_ANIMAL_IDENTIFICATION	getSUBJECT_PERSON_ANIMAL_IDENTIFICATION() Returns SUBJECT_PERSON_ANIMAL_IDENTIFICATION (a Group object) - creates it if necessary
OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION	getSUBJECT_POPULATION_LOCATION_IDENTIFICATION() Returns SUBJECT_POPULATION_LOCATION_IDENTIFICATION (a Group object) - creates it if necessary
String	getVersion() Returns "2.8.1"
OSM_R26_CONTAINER	insertCONTAINER(int rep) Inserts a specific repetition of CONTAINER (a Group object)
void	insertCONTAINER(OSM_R26_CONTAINER structure, int rep) Inserts a specific repetition of CONTAINER (a Group object)
PRT	insertPRT(int rep) Inserts a specific repetition of PRT (Participation Information)
void	insertPRT(PRT structure, int rep) Inserts a specific repetition of PRT (Participation Information)
OSM_R26_SPECIMEN_OBSERVATION	insertSPECIMEN_OBSERVATION(int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
void	insertSPECIMEN_OBSERVATION(OSM_R26_SPECIMEN_OBSERVATION structure, int rep) Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
OSM_R26_CONTAINER	removeCONTAINER(int rep) Removes a specific repetition of CONTAINER (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
OSM_R26_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

OSM_R26_SPECIMEN

public OSM_R26_SPECIMEN(Group parent,
                        ModelClassFactory factory)

Creates a new OSM_R26_SPECIMEN group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getSPM

public SPM getSPM()

Returns SPM (Specimen) - creates it if necessary

getPRT

public PRT getPRT()

Returns the first repetition of PRT (Participation Information) - creates it if necessary

getPRT

public PRT getPRT(int rep)

Returns a specific repetition of PRT (Participation Information) - 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.

getPRTReps

public int getPRTReps()

Returns the number of existing repetitions of PRT

getPRTAll

public List<PRT> getPRTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRT

public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRT

public PRT insertPRT(int rep)
              throws HL7Exception

Inserts a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRT

public PRT removePRT(int rep)
              throws HL7Exception

Removes a specific repetition of PRT (Participation Information)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSPECIMEN_OBSERVATION

public OSM_R26_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION()

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

getSPECIMEN_OBSERVATION

public OSM_R26_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<OSM_R26_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(OSM_R26_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 OSM_R26_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 OSM_R26_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 OSM_R26_CONTAINER getCONTAINER()

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

getCONTAINER

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

Removes a specific repetition of CONTAINER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSUBJECT_PERSON_ANIMAL_IDENTIFICATION

public OSM_R26_SUBJECT_PERSON_ANIMAL_IDENTIFICATION getSUBJECT_PERSON_ANIMAL_IDENTIFICATION()

Returns SUBJECT_PERSON_ANIMAL_IDENTIFICATION (a Group object) - creates it if necessary

getSUBJECT_POPULATION_LOCATION_IDENTIFICATION

public OSM_R26_SUBJECT_POPULATION_LOCATION_IDENTIFICATION getSUBJECT_POPULATION_LOCATION_IDENTIFICATION()

Returns SUBJECT_POPULATION_LOCATION_IDENTIFICATION (a Group object) - creates it if necessary