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

Class ORL_O22_OBSERVATION_REQUEST

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.ORL_O22_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O22_OBSERVATION_REQUEST
extends AbstractGroup

Represents a ORL_O22_OBSERVATION_REQUEST 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: OBR (Observation Request)
• 2: ORL_O22_SPECIMEN (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	Description
ORL_O22_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory)	Creates a new ORL_O22_OBSERVATION_REQUEST group

Method Summary

Modifier and Type	Method	Description
OBR	getOBR()	Returns OBR (Observation Request) - creates it if necessary
ORL_O22_SPECIMEN	getSPECIMEN()	Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary
ORL_O22_SPECIMEN	getSPECIMEN(int rep)	Returns a specific repetition of SPECIMEN (a Group object) - creates it if necessary
List<ORL_O22_SPECIMEN>	getSPECIMENAll()	Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
int	getSPECIMENReps()	Returns the number of existing repetitions of SPECIMEN
String	getVersion()	Returns "2.5.1"
ORL_O22_SPECIMEN	insertSPECIMEN(int rep)	Inserts a specific repetition of SPECIMEN (a Group object)
void	insertSPECIMEN(ORL_O22_SPECIMEN structure, int rep)	Inserts a specific repetition of SPECIMEN (a Group object)
ORL_O22_SPECIMEN	removeSPECIMEN(int rep)	Removes a specific repetition of SPECIMEN (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 Details

ORL_O22_OBSERVATION_REQUEST

public ORL_O22_OBSERVATION_REQUEST(Group parent,
 ModelClassFactory factory)

Creates a new ORL_O22_OBSERVATION_REQUEST group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getSPECIMEN

public ORL_O22_SPECIMEN getSPECIMEN()

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

getSPECIMEN

public ORL_O22_SPECIMEN getSPECIMEN(int rep)

Returns a specific repetition of SPECIMEN (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.

getSPECIMENReps

public int getSPECIMENReps()

Returns the number of existing repetitions of SPECIMEN

getSPECIMENAll

public List<ORL_O22_SPECIMEN> getSPECIMENAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN

public void insertSPECIMEN(ORL_O22_SPECIMEN structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN

public ORL_O22_SPECIMEN insertSPECIMEN(int rep)
                                throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN

public ORL_O22_SPECIMEN removeSPECIMEN(int rep)
                                throws HL7Exception

Removes a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)