Package ca.uhn.hl7v2.model.v23.message

Class DOC_T12

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.DOC_T12

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class DOC_T12
extends AbstractMessage

Represents a DOC_T12 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: QRD (Query definition segment)
• 5: DOC_T12_RESULT (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	Description
DOC_T12()	Creates a new DOC_T12 message with DefaultModelClassFactory.
DOC_T12(ModelClassFactory factory)	Creates a new DOC_T12 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	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
QRD	getQRD()	Returns QRD (Query definition segment) - creates it if necessary
DOC_T12_RESULT	getRESULT()	Returns the first repetition of RESULT (a Group object) - creates it if necessary
DOC_T12_RESULT	getRESULT(int rep)	Returns a specific repetition of RESULT (a Group object) - creates it if necessary
List<DOC_T12_RESULT>	getRESULTAll()	Returns a non-modifiable List containing all current existing repetitions of RESULT.
int	getRESULTReps()	Returns the number of existing repetitions of RESULT
String	getVersion()	Returns "2.3"
DOC_T12_RESULT	insertRESULT(int rep)	Inserts a specific repetition of RESULT (a Group object)
void	insertRESULT(DOC_T12_RESULT structure, int rep)	Inserts a specific repetition of RESULT (a Group object)
DOC_T12_RESULT	removeRESULT(int rep)	Removes a specific repetition of RESULT (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

DOC_T12

public DOC_T12()

Creates a new DOC_T12 message with DefaultModelClassFactory.

DOC_T12

public DOC_T12(ModelClassFactory factory)

Creates a new DOC_T12 message with custom ModelClassFactory.

Method Details

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

getQRD

public QRD getQRD()

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

getRESULT

public DOC_T12_RESULT getRESULT()

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

getRESULT

public DOC_T12_RESULT getRESULT(int rep)

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

getRESULTReps

public int getRESULTReps()

Returns the number of existing repetitions of RESULT

getRESULTAll

public List<DOC_T12_RESULT> getRESULTAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertRESULT

public void insertRESULT(DOC_T12_RESULT structure,
 int rep)
                  throws HL7Exception

Inserts a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertRESULT

public DOC_T12_RESULT insertRESULT(int rep)
                            throws HL7Exception

Inserts a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeRESULT

public DOC_T12_RESULT removeRESULT(int rep)
                            throws HL7Exception

Removes a specific repetition of RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

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