ca.uhn.hl7v2.model.v24.message
Class PPG_PCG

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.PPG_PCG

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class PPG_PCG
extends AbstractMessage

Represents a PPG_PCG message structure (see chapter 12). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: PID (Patient identification)
• 3: PPG_PCG_PATIENT_VISIT (a Group object) optional
• 4: PPG_PCG_PATHWAY (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

PPG_PCG()
Creates a new PPG_PCG message with DefaultModelClassFactory.

PPG_PCG(ModelClassFactory factory)
Creates a new PPG_PCG message with custom ModelClassFactory.

Method Summary

MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
PPG_PCG_PATHWAY	getPATHWAY() Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PPG_PCG_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
PPG_PCG_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"
PPG_PCG_PATHWAY	insertPATHWAY(int rep) Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PPG_PCG_PATHWAY structure, int rep) Inserts a specific repetition of PATHWAY (a Group object)
PPG_PCG_PATHWAY	removePATHWAY(int rep) Removes a specific repetition of PATHWAY (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

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

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, isGroup, isRepeating, isRequired

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

getName, getParent

Constructor Detail

PPG_PCG

public PPG_PCG()

Creates a new PPG_PCG message with DefaultModelClassFactory.

PPG_PCG

public PPG_PCG(ModelClassFactory factory)

Creates a new PPG_PCG message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getPATIENT_VISIT

public PPG_PCG_PATIENT_VISIT getPATIENT_VISIT()

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

getPATHWAY

public PPG_PCG_PATHWAY getPATHWAY()

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

getPATHWAY

public PPG_PCG_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(PPG_PCG_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 PPG_PCG_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 PPG_PCG_PATHWAY removePATHWAY(int rep)
                              throws HL7Exception

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)