ca.uhn.hl7v2.model.v23.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.v23.message.PPT_PCL

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class PPT_PCL
extends AbstractMessage

Represents a PPT_PCL 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: PPT_PCL_PATIENT (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

Modifier and Type	Method and Description
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
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
List<PPT_PCL_PATIENT>	getPATIENTAll() Returns a non-modifiable List containing all current existing repetitions of PATIENT.
int	getPATIENTReps() Returns the number of existing repetitions of PATIENT
QRD	getQRD() Returns QRD (Query definition segment) - creates it if necessary
String	getVersion() Returns "2.3"
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

accept, 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 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"

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

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

getPATIENTAll

public List<PPT_PCL_PATIENT> getPATIENTAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

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)