ca.uhn.hl7v2.model.v23.message

Class ORF_R02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.ORF_R02

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ORF_R02
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: MSA (Message acknowledgement segment)
• 3: QRD (Query definition segment)
• 4: QRF (Query filter segment) optional
• 5: ORF_R02_QUERY_RESPONSE (a Group object) repeating
• 6: 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
ORF_R02() Creates a new ORF_R02 message with DefaultModelClassFactory.
ORF_R02(ModelClassFactory factory) Creates a new ORF_R02 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation pointer segment) - creates it if necessary
MSA	getMSA() Returns MSA (Message acknowledgement segment) - creates it if necessary
MSH	getMSH() Returns MSH (Message header segment) - creates it if necessary
QRD	getQRD() Returns QRD (Query definition segment) - creates it if necessary
QRF	getQRF() Returns QRF (Query filter segment) - creates it if necessary
ORF_R02_QUERY_RESPONSE	getQUERY_RESPONSE() Returns the first repetition of QUERY_RESPONSE (a Group object) - creates it if necessary
ORF_R02_QUERY_RESPONSE	getQUERY_RESPONSE(int rep) Returns a specific repetition of QUERY_RESPONSE (a Group object) - creates it if necessary
List<ORF_R02_QUERY_RESPONSE>	getQUERY_RESPONSEAll() Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
int	getQUERY_RESPONSEReps() Returns the number of existing repetitions of QUERY_RESPONSE
String	getVersion() Returns "2.3"
ORF_R02_QUERY_RESPONSE	insertQUERY_RESPONSE(int rep) Inserts a specific repetition of QUERY_RESPONSE (a Group object)
void	insertQUERY_RESPONSE(ORF_R02_QUERY_RESPONSE structure, int rep) Inserts a specific repetition of QUERY_RESPONSE (a Group object)
ORF_R02_QUERY_RESPONSE	removeQUERY_RESPONSE(int rep) Removes a specific repetition of QUERY_RESPONSE (a Group object)

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

ORF_R02

public ORF_R02()

Creates a new ORF_R02 message with DefaultModelClassFactory.

ORF_R02

public ORF_R02(ModelClassFactory factory)

Creates a new ORF_R02 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

getMSA

public MSA getMSA()

Returns MSA (Message acknowledgement segment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (Query definition segment) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (Query filter segment) - creates it if necessary

getQUERY_RESPONSE

public ORF_R02_QUERY_RESPONSE getQUERY_RESPONSE()

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

getQUERY_RESPONSE

public ORF_R02_QUERY_RESPONSE getQUERY_RESPONSE(int rep)

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

getQUERY_RESPONSEReps

public int getQUERY_RESPONSEReps()

Returns the number of existing repetitions of QUERY_RESPONSE

getQUERY_RESPONSEAll

public List<ORF_R02_QUERY_RESPONSE> getQUERY_RESPONSEAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertQUERY_RESPONSE

public void insertQUERY_RESPONSE(ORF_R02_QUERY_RESPONSE structure,
                                 int rep)
                          throws HL7Exception

Inserts a specific repetition of QUERY_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertQUERY_RESPONSE

public ORF_R02_QUERY_RESPONSE insertQUERY_RESPONSE(int rep)
                                            throws HL7Exception

Inserts a specific repetition of QUERY_RESPONSE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeQUERY_RESPONSE

public ORF_R02_QUERY_RESPONSE removeQUERY_RESPONSE(int rep)
                                            throws HL7Exception

Removes a specific repetition of QUERY_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