ca.uhn.hl7v2.model.v281.group

Class OPL_O37_ORDER_PRIOR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.OPL_O37_ORDER_PRIOR

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OPL_O37_ORDER_PRIOR
extends AbstractGroup

Represents a OPL_O37_ORDER_PRIOR 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: ORC (Common Order) optional
• 3: PRT (Participation Information) optional repeating
• 4: OPL_O37_TIMING (a Group object) optional
• 5: OPL_O37_OBSERVATION_RESULT_GROUP (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
OPL_O37_ORDER_PRIOR(Group parent, ModelClassFactory factory) Creates a new OPL_O37_ORDER_PRIOR group

Method Summary

Modifier and Type	Method and Description
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OPL_O37_OBSERVATION_RESULT_GROUP	getOBSERVATION_RESULT_GROUP() Returns the first repetition of OBSERVATION_RESULT_GROUP (a Group object) - creates it if necessary
OPL_O37_OBSERVATION_RESULT_GROUP	getOBSERVATION_RESULT_GROUP(int rep) Returns a specific repetition of OBSERVATION_RESULT_GROUP (a Group object) - creates it if necessary
List<OPL_O37_OBSERVATION_RESULT_GROUP>	getOBSERVATION_RESULT_GROUPAll() Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_RESULT_GROUP.
int	getOBSERVATION_RESULT_GROUPReps() Returns the number of existing repetitions of OBSERVATION_RESULT_GROUP
ORC	getORC() Returns ORC (Common Order) - 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
OPL_O37_TIMING	getTIMING() Returns TIMING (a Group object) - creates it if necessary
String	getVersion() Returns "2.8.1"
OPL_O37_OBSERVATION_RESULT_GROUP	insertOBSERVATION_RESULT_GROUP(int rep) Inserts a specific repetition of OBSERVATION_RESULT_GROUP (a Group object)
void	insertOBSERVATION_RESULT_GROUP(OPL_O37_OBSERVATION_RESULT_GROUP structure, int rep) Inserts a specific repetition of OBSERVATION_RESULT_GROUP (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)
OPL_O37_OBSERVATION_RESULT_GROUP	removeOBSERVATION_RESULT_GROUP(int rep) Removes a specific repetition of OBSERVATION_RESULT_GROUP (a Group object)
PRT	removePRT(int rep) Removes a specific repetition of PRT (Participation Information)

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

OPL_O37_ORDER_PRIOR

public OPL_O37_ORDER_PRIOR(Group parent,
                           ModelClassFactory factory)

Creates a new OPL_O37_ORDER_PRIOR group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getORC

public ORC getORC()

Returns ORC (Common Order) - 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)

getTIMING

public OPL_O37_TIMING getTIMING()

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

getOBSERVATION_RESULT_GROUP

public OPL_O37_OBSERVATION_RESULT_GROUP getOBSERVATION_RESULT_GROUP()

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

getOBSERVATION_RESULT_GROUP

public OPL_O37_OBSERVATION_RESULT_GROUP getOBSERVATION_RESULT_GROUP(int rep)

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

getOBSERVATION_RESULT_GROUPReps

public int getOBSERVATION_RESULT_GROUPReps()

Returns the number of existing repetitions of OBSERVATION_RESULT_GROUP

getOBSERVATION_RESULT_GROUPAll

public List<OPL_O37_OBSERVATION_RESULT_GROUP> getOBSERVATION_RESULT_GROUPAll()
                                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION_RESULT_GROUP

public void insertOBSERVATION_RESULT_GROUP(OPL_O37_OBSERVATION_RESULT_GROUP structure,
                                           int rep)
                                    throws HL7Exception

Inserts a specific repetition of OBSERVATION_RESULT_GROUP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION_RESULT_GROUP

public OPL_O37_OBSERVATION_RESULT_GROUP insertOBSERVATION_RESULT_GROUP(int rep)
                                                                throws HL7Exception

Inserts a specific repetition of OBSERVATION_RESULT_GROUP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION_RESULT_GROUP

public OPL_O37_OBSERVATION_RESULT_GROUP removeOBSERVATION_RESULT_GROUP(int rep)
                                                                throws HL7Exception

Removes a specific repetition of OBSERVATION_RESULT_GROUP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)