PPG_PCG (HAPI - Java HL7 API - Generated Structures v2.8.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v281.message.PPG_PCG

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class PPG_PCG
extends AbstractMessage
```
Represents a PPG_PCG message structure (see chapter 12.3.4). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: PID (Patient Identification)
- 5: PPG_PCG_PATIENT_VISIT (a Group object) optional
- 6: PPG_PCG_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
`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`List<PPG_PCG_PATHWAY>`	`getPATHWAYAll()` Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
`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
`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
`UAC`	`getUAC()` Returns UAC (User Authentication Credential Segment) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`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)
`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)
`PPG_PCG_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
accept, 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 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.8.1"
    
    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)
  - getUAC
```
public UAC getUAC()
```
    Returns UAC (User Authentication Credential Segment) - 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
  - getPATHWAYAll
```
public List<PPG_PCG_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(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)

Class PPG_PCG

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

PPG_PCG

PPG_PCG

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getPID

getPATIENT_VISIT

getPATHWAY

getPATHWAY

getPATHWAYReps

getPATHWAYAll

insertPATHWAY

insertPATHWAY

removePATHWAY