ca.uhn.hl7v2.model.v28.group

Class ORL_O40_OBSERVATION_REQUEST

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.ORL_O40_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O40_OBSERVATION_REQUEST
extends AbstractGroup

Represents a ORL_O40_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: PRT (Participation Information) optional repeating
• 3: ORL_O40_SPECIMEN_SHIPMENT (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_O40_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory) Creates a new ORL_O40_OBSERVATION_REQUEST group

Method Summary

Modifier and Type	Method and Description
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
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
ORL_O40_SPECIMEN_SHIPMENT	getSPECIMEN_SHIPMENT() Returns the first repetition of SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
ORL_O40_SPECIMEN_SHIPMENT	getSPECIMEN_SHIPMENT(int rep) Returns a specific repetition of SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
List<ORL_O40_SPECIMEN_SHIPMENT>	getSPECIMEN_SHIPMENTAll() Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_SHIPMENT.
int	getSPECIMEN_SHIPMENTReps() Returns the number of existing repetitions of SPECIMEN_SHIPMENT
String	getVersion() Returns "2.8"
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)
ORL_O40_SPECIMEN_SHIPMENT	insertSPECIMEN_SHIPMENT(int rep) Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
void	insertSPECIMEN_SHIPMENT(ORL_O40_SPECIMEN_SHIPMENT structure, int rep) Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)
ORL_O40_SPECIMEN_SHIPMENT	removeSPECIMEN_SHIPMENT(int rep) Removes a specific repetition of SPECIMEN_SHIPMENT (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_O40_OBSERVATION_REQUEST

public ORL_O40_OBSERVATION_REQUEST(Group parent,
                                   ModelClassFactory factory)

Creates a new ORL_O40_OBSERVATION_REQUEST group

Method Detail

getVersion

public String getVersion()

Returns "2.8"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - 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_SHIPMENT

public ORL_O40_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT()

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

getSPECIMEN_SHIPMENT

public ORL_O40_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT(int rep)

Returns a specific repetition of SPECIMEN_SHIPMENT (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_SHIPMENTReps

public int getSPECIMEN_SHIPMENTReps()

Returns the number of existing repetitions of SPECIMEN_SHIPMENT

getSPECIMEN_SHIPMENTAll

public List<ORL_O40_SPECIMEN_SHIPMENT> getSPECIMEN_SHIPMENTAll()
                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN_SHIPMENT

public void insertSPECIMEN_SHIPMENT(ORL_O40_SPECIMEN_SHIPMENT structure,
                                    int rep)
                             throws HL7Exception

Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN_SHIPMENT

public ORL_O40_SPECIMEN_SHIPMENT insertSPECIMEN_SHIPMENT(int rep)
                                                  throws HL7Exception

Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN_SHIPMENT

public ORL_O40_SPECIMEN_SHIPMENT removeSPECIMEN_SHIPMENT(int rep)
                                                  throws HL7Exception

Removes a specific repetition of SPECIMEN_SHIPMENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)