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

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

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class PPT_PCL
extends AbstractMessage

Represents a PPT_PCL message structure (see chapter 12). 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: PPT_PCL_PATIENT (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

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

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
PPT_PCL_PATIENT	getPATIENT() Returns the first repetition of PATIENT (a Group object) - creates it if necessary
PPT_PCL_PATIENT	getPATIENT(int rep) Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
int	getPATIENTReps() Returns the number of existing repetitions of PATIENT
QAK	getQAK() Returns QAK (Query Acknowledgment) - creates it if necessary
QRD	getQRD() Returns QRD (Original-Style Query Definition) - creates it if necessary
String	getVersion() Returns "2.4"
PPT_PCL_PATIENT	insertPATIENT(int rep) Inserts a specific repetition of PATIENT (a Group object)
void	insertPATIENT(PPT_PCL_PATIENT structure, int rep) Inserts a specific repetition of PATIENT (a Group object)
PPT_PCL_PATIENT	removePATIENT(int rep) Removes a specific repetition of PATIENT (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

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

getPATIENT

public PPT_PCL_PATIENT getPATIENT()

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

getPATIENT

public PPT_PCL_PATIENT getPATIENT(int rep)

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

getPATIENTReps

public int getPATIENTReps()

Returns the number of existing repetitions of PATIENT

insertPATIENT

public void insertPATIENT(PPT_PCL_PATIENT structure,
                          int rep)
                   throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPATIENT

public PPT_PCL_PATIENT insertPATIENT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePATIENT

public PPT_PCL_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)