ca.uhn.hl7v2.model.v23.message

Class TBR_Q01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.TBR_Q01

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class TBR_Q01
extends AbstractMessage

Represents a TBR_Q01 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: QAK (Query Acknowledgement)
• 5: RDF (Table Row Definition)
• 6: RDT (Table Row Data) repeating
• 7: 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
TBR_Q01() Creates a new TBR_Q01 message with DefaultModelClassFactory.
TBR_Q01(ModelClassFactory factory) Creates a new TBR_Q01 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
QAK	getQAK() Returns QAK (Query Acknowledgement) - creates it if necessary
RDF	getRDF() Returns RDF (Table Row Definition) - creates it if necessary
RDT	getRDT() Returns the first repetition of RDT (Table Row Data) - creates it if necessary
RDT	getRDT(int rep) Returns a specific repetition of RDT (Table Row Data) - creates it if necessary
List<RDT>	getRDTAll() Returns a non-modifiable List containing all current existing repetitions of RDT.
int	getRDTReps() Returns the number of existing repetitions of RDT
String	getVersion() Returns "2.3"
RDT	insertRDT(int rep) Inserts a specific repetition of RDT (Table Row Data)
void	insertRDT(RDT structure, int rep) Inserts a specific repetition of RDT (Table Row Data)
RDT	removeRDT(int rep) Removes a specific repetition of RDT (Table Row Data)

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

TBR_Q01

public TBR_Q01()

Creates a new TBR_Q01 message with DefaultModelClassFactory.

TBR_Q01

public TBR_Q01(ModelClassFactory factory)

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

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgement) - creates it if necessary

getRDF

public RDF getRDF()

Returns RDF (Table Row Definition) - creates it if necessary

getRDT

public RDT getRDT()

Returns the first repetition of RDT (Table Row Data) - creates it if necessary

getRDT

public RDT getRDT(int rep)

Returns a specific repetition of RDT (Table Row Data) - 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.

getRDTReps

public int getRDTReps()

Returns the number of existing repetitions of RDT

getRDTAll

public List<RDT> getRDTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRDT

public void insertRDT(RDT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRDT

public RDT insertRDT(int rep)
              throws HL7Exception

Inserts a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRDT

public RDT removeRDT(int rep)
              throws HL7Exception

Removes a specific repetition of RDT (Table Row Data)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

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