ca.uhn.hl7v2.model.v23.message

Class OSR_Q06

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.OSR_Q06

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class OSR_Q06
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: MSA (Message acknowledgement segment)
• 3: ERR (Error segment) optional
• 4: NTE (Notes and comments segment) optional repeating
• 5: QRD (Query definition segment)
• 6: QRF (Query filter segment) optional
• 7: OSR_Q06_RESPONSE (a Group object) optional
• 8: 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
OSR_Q06() Creates a new OSR_Q06 message with DefaultModelClassFactory.
OSR_Q06(ModelClassFactory factory) Creates a new OSR_Q06 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (Continuation pointer segment) - creates it if necessary
ERR	getERR() Returns ERR (Error 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
NTE	getNTE() Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
QRD	getQRD() Returns QRD (Query definition segment) - creates it if necessary
QRF	getQRF() Returns QRF (Query filter segment) - creates it if necessary
OSR_Q06_RESPONSE	getRESPONSE() Returns RESPONSE (a Group object) - creates it if necessary
String	getVersion() Returns "2.3"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and comments segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and comments segment)

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

OSR_Q06

public OSR_Q06()

Creates a new OSR_Q06 message with DefaultModelClassFactory.

OSR_Q06

public OSR_Q06(ModelClassFactory factory)

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

getERR

public ERR getERR()

Returns ERR (Error segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

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

getRESPONSE

public OSR_Q06_RESPONSE getRESPONSE()

Returns RESPONSE (a Group object) - creates it if necessary

getDSC

public DSC getDSC()

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