ca.uhn.hl7v2.model.v24.message
Class DOC_T12

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.DOC_T12

All Implemented Interfaces:

Group, Message, Structure, 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)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional
• 4: QAK (Query Acknowledgment) optional
• 5: QRD (Original-Style Query Definition)
• 6: DOC_T12_RESULT (a Group object) repeating
• 7: DSC (Continuation Pointer) optional

See Also:

Serialized Form

Constructor Summary

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

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
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
int	getRESULTReps() Returns the number of existing repetitions of RESULT
String	getVersion() Returns "2.4"
void	insertRESULT(DOC_T12_RESULT structure, int rep) Inserts a specific repetition of RESULT (a Group object)
DOC_T12_RESULT	insertRESULT(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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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

Constructor Detail

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 Detail

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

getERR

public ERR getERR()

Returns ERR (Error) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - 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

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) - creates it if necessary