PTR_PCF (HAPI - Java HL7 API - Generated Structures v2.6 2.1 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v26.message.PTR_PCF

All Implemented Interfaces:

Group, Message, Structure, Serializable
```
public class PTR_PCF
extends AbstractMessage
```
Represents a PTR_PCF message structure (see chapter 12.3.10). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional
- 4: MSA (Message Acknowledgment)
- 5: ERR (Error) optional repeating
- 6: QAK (Query Acknowledgment) optional
- 7: QRD (Original-Style Query Definition)
- 8: PTR_PCF_PATIENT (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
`PTR_PCF()` Creates a new PTR_PCF message with DefaultModelClassFactory.
`PTR_PCF(ModelClassFactory factory)` Creates a new PTR_PCF message with custom ModelClassFactory.

Method Summary

Methods
Modifier and Type	Method and Description
`ERR`	`getERR()` Returns the first repetition of ERR (Error) - creates it if necessary
`ERR`	`getERR(int rep)` Returns a specific repetition of ERR (Error) - creates it if necessary
`List<ERR>`	`getERRAll()` Returns a non-modifiable List containing all current existing repetitions of ERR.
`int`	`getERRReps()` Returns the number of existing repetitions of ERR
`MSA`	`getMSA()` Returns MSA (Message Acknowledgment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`PTR_PCF_PATIENT`	`getPATIENT()` Returns the first repetition of PATIENT (a Group object) - creates it if necessary
`PTR_PCF_PATIENT`	`getPATIENT(int rep)` Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
`List<PTR_PCF_PATIENT>`	`getPATIENTAll()` Returns a non-modifiable List containing all current existing repetitions of PATIENT.
`int`	`getPATIENTReps()` Returns the number of existing repetitions of PATIENT
`QAK`	`getQAK()` Returns QAK (Query Acknowledgment) - creates it if necessary
`QRD`	`getQRD()` Returns QRD (Original-Style Query Definition) - 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.6"
`void`	`insertERR(ERR structure, int rep)` Inserts a specific repetition of ERR (Error)
`ERR`	`insertERR(int rep)` Inserts a specific repetition of ERR (Error)
`PTR_PCF_PATIENT`	`insertPATIENT(int rep)` Inserts a specific repetition of PATIENT (a Group object)
`void`	`insertPATIENT(PTR_PCF_PATIENT structure, int rep)` Inserts a specific repetition of PATIENT (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)
`ERR`	`removeERR(int rep)` Removes a specific repetition of ERR (Error)
`PTR_PCF_PATIENT`	`removePATIENT(int rep)` Removes a specific repetition of PATIENT (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, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, 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, 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, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getName, isEmpty

- Constructor Detail
  - PTR_PCF
```
public PTR_PCF()
```
    Creates a new PTR_PCF message with DefaultModelClassFactory.
  - PTR_PCF
```
public PTR_PCF(ModelClassFactory factory)
```
    Creates a new PTR_PCF message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.6"
    
    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
  - getMSA
```
public MSA getMSA()
```
    Returns MSA (Message Acknowledgment) - creates it if necessary
  - getERR
```
public ERR getERR()
```
    Returns the first repetition of ERR (Error) - creates it if necessary
  - getERR
```
public ERR getERR(int rep)
```
    Returns a specific repetition of ERR (Error) - 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.
  - getERRReps
```
public int getERRReps()
```
    Returns the number of existing repetitions of ERR
  - getERRAll
```
public List<ERR> getERRAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ERR.
    
    Note that unlike getERR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertERR
```
public void insertERR(ERR structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertERR
```
public ERR insertERR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeERR
```
public ERR removeERR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ERR (Error)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getQAK
```
public QAK getQAK()
```
    Returns QAK (Query Acknowledgment) - creates it if necessary
  - getQRD
```
public QRD getQRD()
```
    Returns QRD (Original-Style Query Definition) - creates it if necessary
  - getPATIENT
```
public PTR_PCF_PATIENT getPATIENT()
```
    Returns the first repetition of PATIENT (a Group object) - creates it if necessary
  - getPATIENT
```
public PTR_PCF_PATIENT getPATIENT(int rep)
```
    Returns a specific repetition of PATIENT (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.
  - getPATIENTReps
```
public int getPATIENTReps()
```
    Returns the number of existing repetitions of PATIENT
  - getPATIENTAll
```
public List<PTR_PCF_PATIENT> getPATIENTAll()
                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PATIENT.
    
    Note that unlike getPATIENT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPATIENT
```
public void insertPATIENT(PTR_PCF_PATIENT structure,
                 int rep)
                   throws HL7Exception
```
    Inserts a specific repetition of PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPATIENT
```
public PTR_PCF_PATIENT insertPATIENT(int rep)
                              throws HL7Exception
```
    Inserts a specific repetition of PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePATIENT
```
public PTR_PCF_PATIENT removePATIENT(int rep)
                              throws HL7Exception
```
    Removes a specific repetition of PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)

Class PTR_PCF

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

Constructor Detail

PTR_PCF

PTR_PCF

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getMSA

getERR

getERR

getERRReps

getERRAll

insertERR

insertERR

removeERR

getQAK

getQRD

getPATIENT

getPATIENT

getPATIENTReps

getPATIENTAll

insertPATIENT

insertPATIENT

removePATIENT