Package ca.uhn.hl7v2.model.v24.message

Class ORF_R04

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.ORF_R04

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ORF_R04
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: QRD (Original-Style Query Definition)
• 4: QRF (Original Style Query Filter) optional
• 5: ORF_R04_RESPONSE (a Group object) repeating
• 6: ERR (Error) optional
• 7: QAK (Query Acknowledgment) optional
• 8: DSC (Continuation Pointer) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DSC	getDSC()	Returns DSC (Continuation Pointer) - creates it if necessary
ERR	getERR()	Returns ERR (Error) - creates it if necessary
MSA	getMSA()	Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
QAK	getQAK()	Returns QAK (Query Acknowledgment) - creates it if necessary
QRD	getQRD()	Returns QRD (Original-Style Query Definition) - creates it if necessary
QRF	getQRF()	Returns QRF (Original Style Query Filter) - creates it if necessary
ORF_R04_RESPONSE	getRESPONSE()	Returns the first repetition of RESPONSE (a Group object) - creates it if necessary
ORF_R04_RESPONSE	getRESPONSE(int rep)	Returns a specific repetition of RESPONSE (a Group object) - creates it if necessary
List<ORF_R04_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.4"
ORF_R04_RESPONSE	insertRESPONSE(int rep)	Inserts a specific repetition of RESPONSE (a Group object)
void	insertRESPONSE(ORF_R04_RESPONSE structure, int rep)	Inserts a specific repetition of RESPONSE (a Group object)
ORF_R04_RESPONSE	removeRESPONSE(int rep)	Removes a specific repetition of RESPONSE (a Group object)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, 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 Details

ORF_R04

public ORF_R04()

Creates a new ORF_R04 message with DefaultModelClassFactory.

ORF_R04

public ORF_R04(ModelClassFactory factory)

Creates a new ORF_R04 message with custom ModelClassFactory.

Method Details

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

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (Original Style Query Filter) - creates it if necessary

getRESPONSE

public ORF_R04_RESPONSE getRESPONSE()

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

getRESPONSE

public ORF_R04_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<ORF_R04_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(ORF_R04_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 ORF_R04_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 ORF_R04_RESPONSE removeRESPONSE(int rep)
                                throws HL7Exception

Removes a specific repetition of RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getERR

public ERR getERR()

Returns ERR (Error) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary