ca.uhn.hl7v2.model.v24.message
Class ORU_R01

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.ORU_R01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ORU_R01
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: ORU_R01_PATIENT_RESULT (a Group object) repeating
• 3: DSC (Continuation Pointer) optional

See Also:

Serialized Form

Constructor Summary

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

DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
ORU_R01_PATIENT_RESULT	getPATIENT_RESULT() Returns the first repetition of PATIENT_RESULT (a Group object) - creates it if necessary
ORU_R01_PATIENT_RESULT	getPATIENT_RESULT(int rep) Returns a specific repetition of PATIENT_RESULT (a Group object) - creates it if necessary
int	getPATIENT_RESULTReps() Returns the number of existing repetitions of PATIENT_RESULT
String	getVersion() Returns "2.4"
ORU_R01_PATIENT_RESULT	insertPATIENT_RESULT(int rep) Inserts a specific repetition of PATIENT_RESULT (a Group object)
void	insertPATIENT_RESULT(ORU_R01_PATIENT_RESULT structure, int rep) Inserts a specific repetition of PATIENT_RESULT (a Group object)
ORU_R01_PATIENT_RESULT	removePATIENT_RESULT(int rep) Removes a specific repetition of PATIENT_RESULT (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

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.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getPATIENT_RESULT

public ORU_R01_PATIENT_RESULT getPATIENT_RESULT()

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

getPATIENT_RESULT

public ORU_R01_PATIENT_RESULT getPATIENT_RESULT(int rep)

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

getPATIENT_RESULTReps

public int getPATIENT_RESULTReps()

Returns the number of existing repetitions of PATIENT_RESULT

insertPATIENT_RESULT

public void insertPATIENT_RESULT(ORU_R01_PATIENT_RESULT structure,
                                 int rep)
                          throws HL7Exception

Inserts a specific repetition of PATIENT_RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPATIENT_RESULT

public ORU_R01_PATIENT_RESULT insertPATIENT_RESULT(int rep)
                                            throws HL7Exception

Inserts a specific repetition of PATIENT_RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePATIENT_RESULT

public ORU_R01_PATIENT_RESULT removePATIENT_RESULT(int rep)
                                            throws HL7Exception

Removes a specific repetition of PATIENT_RESULT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary