Package ca.uhn.hl7v2.model.v24.group

Class PPT_PCL_PATIENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.PPT_PCL_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PPT_PCL_PATIENT
extends AbstractGroup

Represents a PPT_PCL_PATIENT group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: PID (Patient identification)
• 2: PPT_PCL_PATIENT_VISIT (a Group object) optional
• 3: PPT_PCL_PATHWAY (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
PPT_PCL_PATIENT(Group parent, ModelClassFactory factory)	Creates a new PPT_PCL_PATIENT group

Method Summary

Modifier and Type	Method	Description
PPT_PCL_PATHWAY	getPATHWAY()	Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PPT_PCL_PATHWAY	getPATHWAY(int rep)	Returns a specific repetition of PATHWAY (a Group object) - creates it if necessary
List<PPT_PCL_PATHWAY>	getPATHWAYAll()	Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
int	getPATHWAYReps()	Returns the number of existing repetitions of PATHWAY
PPT_PCL_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.4"
PPT_PCL_PATHWAY	insertPATHWAY(int rep)	Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PPT_PCL_PATHWAY structure, int rep)	Inserts a specific repetition of PATHWAY (a Group object)
PPT_PCL_PATHWAY	removePATHWAY(int rep)	Removes a specific repetition of PATHWAY (a Group object)

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

accept, 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 ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

PPT_PCL_PATIENT

public PPT_PCL_PATIENT(Group parent,
 ModelClassFactory factory)

Creates a new PPT_PCL_PATIENT group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getPATIENT_VISIT

public PPT_PCL_PATIENT_VISIT getPATIENT_VISIT()

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

getPATHWAY

public PPT_PCL_PATHWAY getPATHWAY()

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

getPATHWAY

public PPT_PCL_PATHWAY getPATHWAY(int rep)

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

getPATHWAYReps

public int getPATHWAYReps()

Returns the number of existing repetitions of PATHWAY

getPATHWAYAll

public List<PPT_PCL_PATHWAY> getPATHWAYAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPATHWAY

public void insertPATHWAY(PPT_PCL_PATHWAY structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPATHWAY

public PPT_PCL_PATHWAY insertPATHWAY(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePATHWAY

public PPT_PCL_PATHWAY removePATHWAY(int rep)
                              throws HL7Exception

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)