ca.uhn.hl7v2.model.v231.message

Class PPT_PCL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.PPT_PCL

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class PPT_PCL
extends AbstractMessage

Represents a PPT_PCL 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: PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object) repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
PPT_PCL() Creates a new PPT_PCL message with DefaultModelClassFactory.
PPT_PCL(ModelClassFactory factory) Creates a new PPT_PCL message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
ERR	getERR() Returns ERR (ERR - error segment) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR	getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR() Returns the first repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR	getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep) Returns a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
List<PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR>	getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARAll() Returns a non-modifiable List containing all current existing repetitions of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR.
int	getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARReps() Returns the number of existing repetitions of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR
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"
PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR	insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep) Inserts a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object)
void	insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR structure, int rep) Inserts a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object)
PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR	removePIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep) Removes a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (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

PPT_PCL

public PPT_PCL()

Creates a new PPT_PCL message with DefaultModelClassFactory.

PPT_PCL

public PPT_PCL(ModelClassFactory factory)

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

getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR()

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

getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep)

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

getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARReps

public int getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARReps()

Returns the number of existing repetitions of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARAll

public List<PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR> getPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVARAll()
                                                                                                                                                                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public void insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR structure,
                                                                                                    int rep)
                                                                                                      throws HL7Exception

Inserts a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR insertPIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                                                                                                                                                    throws HL7Exception

Inserts a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PPT_PCL_PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR removePIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                                                                                                                                                    throws HL7Exception

Removes a specific repetition of PIDPV1PV2PTHNTEVARROLVARGOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)