ca.uhn.hl7v2.model.v25.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.v25.message.ORU_R01

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ORU_R01
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: ORU_R01_PATIENT_RESULT (a Group object) repeating
• 4: DSC (Continuation Pointer) 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) - 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
List<ORU_R01_PATIENT_RESULT>	getPATIENT_RESULTAll() Returns a non-modifiable List containing all current existing repetitions of PATIENT_RESULT.
int	getPATIENT_RESULTReps() Returns the number of existing repetitions of PATIENT_RESULT
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
String	getVersion() Returns "2.5"
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)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
ORU_R01_PATIENT_RESULT	removePATIENT_RESULT(int rep) Removes a specific repetition of PATIENT_RESULT (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

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

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

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 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, isChoiceElement, isGroup, isRepeating, isRequired

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

getName

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

isEmpty, provideLocation

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

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - 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.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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

getPATIENT_RESULTAll

public List<ORU_R01_PATIENT_RESULT> getPATIENT_RESULTAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

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