ca.uhn.hl7v2.model.v25.group

Class ORL_O34_OBSERVATION_REQUEST

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.ORL_O34_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O34_OBSERVATION_REQUEST
extends AbstractGroup

Represents a ORL_O34_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_O34_ORDER_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 and Description
ORL_O34_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory) Creates a new ORL_O34_OBSERVATION_REQUEST group

Method Summary

Methods

Modifier and Type	Method and Description
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
ORL_O34_ORDER_SPECIMEN	getORDER_SPECIMEN() Returns the first repetition of ORDER_SPECIMEN (a Group object) - creates it if necessary
ORL_O34_ORDER_SPECIMEN	getORDER_SPECIMEN(int rep) Returns a specific repetition of ORDER_SPECIMEN (a Group object) - creates it if necessary
List<ORL_O34_ORDER_SPECIMEN>	getORDER_SPECIMENAll() Returns a non-modifiable List containing all current existing repetitions of ORDER_SPECIMEN.
int	getORDER_SPECIMENReps() Returns the number of existing repetitions of ORDER_SPECIMEN
String	getVersion() Returns "2.5"
ORL_O34_ORDER_SPECIMEN	insertORDER_SPECIMEN(int rep) Inserts a specific repetition of ORDER_SPECIMEN (a Group object)
void	insertORDER_SPECIMEN(ORL_O34_ORDER_SPECIMEN structure, int rep) Inserts a specific repetition of ORDER_SPECIMEN (a Group object)
ORL_O34_ORDER_SPECIMEN	removeORDER_SPECIMEN(int rep) Removes a specific repetition of ORDER_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 Detail

ORL_O34_OBSERVATION_REQUEST

public ORL_O34_OBSERVATION_REQUEST(Group parent,
                           ModelClassFactory factory)

Creates a new ORL_O34_OBSERVATION_REQUEST group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getORDER_SPECIMEN

public ORL_O34_ORDER_SPECIMEN getORDER_SPECIMEN()

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

getORDER_SPECIMEN

public ORL_O34_ORDER_SPECIMEN getORDER_SPECIMEN(int rep)

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

getORDER_SPECIMENReps

public int getORDER_SPECIMENReps()

Returns the number of existing repetitions of ORDER_SPECIMEN

getORDER_SPECIMENAll

public List<ORL_O34_ORDER_SPECIMEN> getORDER_SPECIMENAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_SPECIMEN

public void insertORDER_SPECIMEN(ORL_O34_ORDER_SPECIMEN structure,
                        int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER_SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER_SPECIMEN

public ORL_O34_ORDER_SPECIMEN insertORDER_SPECIMEN(int rep)
                                            throws HL7Exception

Inserts a specific repetition of ORDER_SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER_SPECIMEN

public ORL_O34_ORDER_SPECIMEN removeORDER_SPECIMEN(int rep)
                                            throws HL7Exception

Removes a specific repetition of ORDER_SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)