Package ca.uhn.hl7v2.model.v251.message

Class PRR_PC5

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.PRR_PC5

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class PRR_PC5
extends AbstractMessage

Represents a PRR_PC5 message structure (see chapter 12.3.6). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: MSA (Message Acknowledgment)
• 4: ERR (Error) optional repeating
• 5: QAK (Query Acknowledgment) optional
• 6: QRD (Original-Style Query Definition)
• 7: PRR_PC5_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	Description
PRR_PC5()	Creates a new PRR_PC5 message with DefaultModelClassFactory.
PRR_PC5(ModelClassFactory factory)	Creates a new PRR_PC5 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
ERR	getERR()	Returns the first repetition of ERR (Error) - creates it if necessary
ERR	getERR(int rep)	Returns a specific repetition of ERR (Error) - creates it if necessary
List<ERR>	getERRAll()	Returns a non-modifiable List containing all current existing repetitions of ERR.
int	getERRReps()	Returns the number of existing repetitions of ERR
MSA	getMSA()	Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
PRR_PC5_PATIENT	getPATIENT()	Returns the first repetition of PATIENT (a Group object) - creates it if necessary
PRR_PC5_PATIENT	getPATIENT(int rep)	Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
List<PRR_PC5_PATIENT>	getPATIENTAll()	Returns a non-modifiable List containing all current existing repetitions of PATIENT.
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
SFT	getSFT()	Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep)	Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll()	Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps()	Returns the number of existing repetitions of SFT
String	getVersion()	Returns "2.5.1"
ERR	insertERR(int rep)	Inserts a specific repetition of ERR (Error)
void	insertERR(ERR structure, int rep)	Inserts a specific repetition of ERR (Error)
PRR_PC5_PATIENT	insertPATIENT(int rep)	Inserts a specific repetition of PATIENT (a Group object)
void	insertPATIENT(PRR_PC5_PATIENT structure, int rep)	Inserts a specific repetition of PATIENT (a Group object)
SFT	insertSFT(int rep)	Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep)	Inserts a specific repetition of SFT (Software Segment)
ERR	removeERR(int rep)	Removes a specific repetition of ERR (Error)
PRR_PC5_PATIENT	removePATIENT(int rep)	Removes a specific repetition of PATIENT (a Group object)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

accept, copy, 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 Details

PRR_PC5

public PRR_PC5()

Creates a new PRR_PC5 message with DefaultModelClassFactory.

PRR_PC5

public PRR_PC5(ModelClassFactory factory)

Creates a new PRR_PC5 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - 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.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getERR

public ERR getERR()

Returns the first repetition of ERR (Error) - creates it if necessary

getERR

public ERR getERR(int rep)

Returns a specific repetition of ERR (Error) - 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.

getERRReps

public int getERRReps()

Returns the number of existing repetitions of ERR

getERRAll

public List<ERR> getERRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertERR

public void insertERR(ERR structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertERR

public ERR insertERR(int rep)
              throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeERR

public ERR removeERR(int rep)
              throws HL7Exception

Removes a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

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 PRR_PC5_PATIENT getPATIENT()

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

getPATIENT

public PRR_PC5_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<PRR_PC5_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(PRR_PC5_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 PRR_PC5_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 PRR_PC5_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)