ca.uhn.hl7v2.model.v23.message

Class ORU_R01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.ORU_R01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ORU_R01
extends AbstractMessage

Represents a ORU_R01 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (Message header segment)
• 2: ORU_R01_RESPONSE (a Group object) repeating
• 3: DSC (Continuation pointer segment) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ORU_R01() Creates a new ORU_R01 message with DefaultModelClassFactory.
ORU_R01(ModelClassFactory factory) Creates a new ORU_R01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation pointer segment) - creates it if necessary
MSH	getMSH() Returns MSH (Message header segment) - creates it if necessary
ORU_R01_RESPONSE	getRESPONSE() Returns the first repetition of RESPONSE (a Group object) - creates it if necessary
ORU_R01_RESPONSE	getRESPONSE(int rep) Returns a specific repetition of RESPONSE (a Group object) - creates it if necessary
List<ORU_R01_RESPONSE>	getRESPONSEAll() Returns a non-modifiable List containing all current existing repetitions of RESPONSE.
int	getRESPONSEReps() Returns the number of existing repetitions of RESPONSE
String	getVersion() Returns "2.3"
ORU_R01_RESPONSE	insertRESPONSE(int rep) Inserts a specific repetition of RESPONSE (a Group object)
void	insertRESPONSE(ORU_R01_RESPONSE structure, int rep) Inserts a specific repetition of RESPONSE (a Group object)
ORU_R01_RESPONSE	removeRESPONSE(int rep) Removes a specific repetition of RESPONSE (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Constructor Detail

ORU_R01

public ORU_R01()

Creates a new ORU_R01 message with DefaultModelClassFactory.

ORU_R01

public ORU_R01(ModelClassFactory factory)

Creates a new ORU_R01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getRESPONSE

public ORU_R01_RESPONSE getRESPONSE()

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

getRESPONSE

public ORU_R01_RESPONSE getRESPONSE(int rep)

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

getRESPONSEReps

public int getRESPONSEReps()

Returns the number of existing repetitions of RESPONSE

getRESPONSEAll

public List<ORU_R01_RESPONSE> getRESPONSEAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertRESPONSE

public void insertRESPONSE(ORU_R01_RESPONSE structure,
                  int rep)
                    throws HL7Exception

Inserts a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRESPONSE

public ORU_R01_RESPONSE insertRESPONSE(int rep)
                                throws HL7Exception

Inserts a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRESPONSE

public ORU_R01_RESPONSE removeRESPONSE(int rep)
                                throws HL7Exception

Removes a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation pointer segment) - creates it if necessary