ca.uhn.hl7v2.model.v24.group
Class PTR_PCF_PATIENT

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.PTR_PCF_PATIENT

All Implemented Interfaces:

Group, Structure, Serializable

public class PTR_PCF_PATIENT
extends AbstractGroup

Represents a PTR_PCF_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: PTR_PCF_PATIENT_VISIT (a Group object) optional
• 3: PTR_PCF_PATHWAY (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

PTR_PCF_PATIENT(Group parent, ModelClassFactory factory)
Creates a new PTR_PCF_PATIENT group

Method Summary

PTR_PCF_PATHWAY	getPATHWAY() Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PTR_PCF_PATHWAY	getPATHWAY(int rep) Returns a specific repetition of PATHWAY (a Group object) - creates it if necessary
int	getPATHWAYReps() Returns the number of existing repetitions of PATHWAY
PTR_PCF_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"
PTR_PCF_PATHWAY	insertPATHWAY(int rep) Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PTR_PCF_PATHWAY structure, int rep) Inserts a specific repetition of PATHWAY (a Group object)
PTR_PCF_PATHWAY	removePATHWAY(int rep) Removes a specific repetition of PATHWAY (a Group object)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

PTR_PCF_PATIENT

public PTR_PCF_PATIENT(Group parent,
                       ModelClassFactory factory)

Creates a new PTR_PCF_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getPATIENT_VISIT

public PTR_PCF_PATIENT_VISIT getPATIENT_VISIT()

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

getPATHWAY

public PTR_PCF_PATHWAY getPATHWAY()

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

getPATHWAY

public PTR_PCF_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

insertPATHWAY

public void insertPATHWAY(PTR_PCF_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 PTR_PCF_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 PTR_PCF_PATHWAY removePATHWAY(int rep)
                              throws HL7Exception

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)