Package ca.uhn.hl7v2.model.v23.message

Class PGL_PC7

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.PGL_PC7

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class PGL_PC7
extends AbstractMessage

Represents a PGL_PC7 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (Message header segment)
• 2: PID (Patient Identification)
• 3: PGL_PC7_PATIENT_VISIT (a Group object) optional
• 4: PGL_PC7_GOAL (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
PGL_PC7()	Creates a new PGL_PC7 message with DefaultModelClassFactory.
PGL_PC7(ModelClassFactory factory)	Creates a new PGL_PC7 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
PGL_PC7_GOAL	getGOAL()	Returns the first repetition of GOAL (a Group object) - creates it if necessary
PGL_PC7_GOAL	getGOAL(int rep)	Returns a specific repetition of GOAL (a Group object) - creates it if necessary
List<PGL_PC7_GOAL>	getGOALAll()	Returns a non-modifiable List containing all current existing repetitions of GOAL.
int	getGOALReps()	Returns the number of existing repetitions of GOAL
MSH	getMSH()	Returns MSH (Message header segment) - creates it if necessary
PGL_PC7_PATIENT_VISIT	getPATIENT_VISIT()	Returns PATIENT_VISIT (a Group object) - creates it if necessary
PID	getPID()	Returns PID (Patient Identification) - creates it if necessary
String	getVersion()	Returns "2.3"
PGL_PC7_GOAL	insertGOAL(int rep)	Inserts a specific repetition of GOAL (a Group object)
void	insertGOAL(PGL_PC7_GOAL structure, int rep)	Inserts a specific repetition of GOAL (a Group object)
PGL_PC7_GOAL	removeGOAL(int rep)	Removes a specific repetition of GOAL (a Group object)

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

PGL_PC7

public PGL_PC7()

Creates a new PGL_PC7 message with DefaultModelClassFactory.

PGL_PC7

public PGL_PC7(ModelClassFactory factory)

Creates a new PGL_PC7 message with custom ModelClassFactory.

Method Details

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

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPATIENT_VISIT

public PGL_PC7_PATIENT_VISIT getPATIENT_VISIT()

Returns PATIENT_VISIT (a Group object) - creates it if necessary

getGOAL

public PGL_PC7_GOAL getGOAL()

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

getGOAL

public PGL_PC7_GOAL getGOAL(int rep)

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

getGOALReps

public int getGOALReps()

Returns the number of existing repetitions of GOAL

getGOALAll

public List<PGL_PC7_GOAL> getGOALAll()
                              throws HL7Exception

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

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

Throws:

HL7Exception

insertGOAL

public void insertGOAL(PGL_PC7_GOAL structure,
 int rep)
                throws HL7Exception

Inserts a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertGOAL

public PGL_PC7_GOAL insertGOAL(int rep)
                        throws HL7Exception

Inserts a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeGOAL

public PGL_PC7_GOAL removeGOAL(int rep)
                        throws HL7Exception

Removes a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)