ca.uhn.hl7v2.model.v231.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.v231.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 (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: ERR (ERR - error segment) optional
• 4: QAK (Query Acknowledgement) optional
• 5: QRD (QRD - original-style query definition segment)
• 6: DOC_T12_EVNPIDPV1TXAOBX (a Group object) repeating
• 7: DSC (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
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

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (DSC - Continuation pointer segment) - creates it if necessary
ERR	getERR() Returns ERR (ERR - error segment) - creates it if necessary
DOC_T12_EVNPIDPV1TXAOBX	getEVNPIDPV1TXAOBX() Returns the first repetition of EVNPIDPV1TXAOBX (a Group object) - creates it if necessary
DOC_T12_EVNPIDPV1TXAOBX	getEVNPIDPV1TXAOBX(int rep) Returns a specific repetition of EVNPIDPV1TXAOBX (a Group object) - creates it if necessary
List<DOC_T12_EVNPIDPV1TXAOBX>	getEVNPIDPV1TXAOBXAll() Returns a non-modifiable List containing all current existing repetitions of EVNPIDPV1TXAOBX.
int	getEVNPIDPV1TXAOBXReps() Returns the number of existing repetitions of EVNPIDPV1TXAOBX
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
QAK	getQAK() Returns QAK (Query Acknowledgement) - creates it if necessary
QRD	getQRD() Returns QRD (QRD - original-style query definition segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertEVNPIDPV1TXAOBX(DOC_T12_EVNPIDPV1TXAOBX structure, int rep) Inserts a specific repetition of EVNPIDPV1TXAOBX (a Group object)
DOC_T12_EVNPIDPV1TXAOBX	insertEVNPIDPV1TXAOBX(int rep) Inserts a specific repetition of EVNPIDPV1TXAOBX (a Group object)
DOC_T12_EVNPIDPV1TXAOBX	removeEVNPIDPV1TXAOBX(int rep) Removes a specific repetition of EVNPIDPV1TXAOBX (a Group object)

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

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.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (ERR - error segment) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgement) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (QRD - original-style query definition segment) - creates it if necessary

getEVNPIDPV1TXAOBX

public DOC_T12_EVNPIDPV1TXAOBX getEVNPIDPV1TXAOBX()

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

getEVNPIDPV1TXAOBX

public DOC_T12_EVNPIDPV1TXAOBX getEVNPIDPV1TXAOBX(int rep)

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

getEVNPIDPV1TXAOBXReps

public int getEVNPIDPV1TXAOBXReps()

Returns the number of existing repetitions of EVNPIDPV1TXAOBX

getEVNPIDPV1TXAOBXAll

public List<DOC_T12_EVNPIDPV1TXAOBX> getEVNPIDPV1TXAOBXAll()
                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertEVNPIDPV1TXAOBX

public void insertEVNPIDPV1TXAOBX(DOC_T12_EVNPIDPV1TXAOBX structure,
                         int rep)
                           throws HL7Exception

Inserts a specific repetition of EVNPIDPV1TXAOBX (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertEVNPIDPV1TXAOBX

public DOC_T12_EVNPIDPV1TXAOBX insertEVNPIDPV1TXAOBX(int rep)
                                              throws HL7Exception

Inserts a specific repetition of EVNPIDPV1TXAOBX (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeEVNPIDPV1TXAOBX

public DOC_T12_EVNPIDPV1TXAOBX removeEVNPIDPV1TXAOBX(int rep)
                                              throws HL7Exception

Removes a specific repetition of EVNPIDPV1TXAOBX (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

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