ca.uhn.hl7v2.model.v25.message

Class PPP_PCB

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.PPP_PCB

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class PPP_PCB
extends AbstractMessage

Represents a PPP_PCB message structure (see chapter 12.3.3). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: PID (Patient Identification)
• 4: PPP_PCB_PATIENT_VISIT (a Group object) optional
• 5: PPP_PCB_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 and Description
PPP_PCB() Creates a new PPP_PCB message with DefaultModelClassFactory.
PPP_PCB(ModelClassFactory factory) Creates a new PPP_PCB message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
PPP_PCB_PATHWAY	getPATHWAY() Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PPP_PCB_PATHWAY	getPATHWAY(int rep) Returns a specific repetition of PATHWAY (a Group object) - creates it if necessary
List<PPP_PCB_PATHWAY>	getPATHWAYAll() Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
int	getPATHWAYReps() Returns the number of existing repetitions of PATHWAY
PPP_PCB_PATIENT_VISIT	getPATIENT_VISIT() Returns PATIENT_VISIT (a Group object) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - 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"
PPP_PCB_PATHWAY	insertPATHWAY(int rep) Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PPP_PCB_PATHWAY structure, int rep) Inserts a specific repetition of PATHWAY (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)
PPP_PCB_PATHWAY	removePATHWAY(int rep) Removes a specific repetition of PATHWAY (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, 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, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

Constructor Detail

PPP_PCB

public PPP_PCB()

Creates a new PPP_PCB message with DefaultModelClassFactory.

PPP_PCB

public PPP_PCB(ModelClassFactory factory)

Creates a new PPP_PCB message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5"

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)

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPATIENT_VISIT

public PPP_PCB_PATIENT_VISIT getPATIENT_VISIT()

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

getPATHWAY

public PPP_PCB_PATHWAY getPATHWAY()

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

getPATHWAY

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

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)