CSU_C09_PATIENT (HAPI - Java HL7 API - Generated Structures v2.8 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v28.group.CSU_C09_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class CSU_C09_PATIENT
extends AbstractGroup
```
Represents a CSU_C09_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: PD1 (Patient Additional Demographic) optional
- 3: PRT (Participation Information) optional repeating
- 4: ARV (Access Restriction) optional repeating
- 5: NTE (Notes and Comments) optional repeating
- 6: CSU_C09_VISIT (a Group object) optional
- 7: CSR (Clinical Study Registration)
- 8: CSU_C09_STUDY_PHASE (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

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

Constructors
Constructor and Description
`CSU_C09_PATIENT(Group parent, ModelClassFactory factory)` Creates a new CSU_C09_PATIENT group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ARV`	`getARV()` Returns the first repetition of ARV (Access Restriction) - creates it if necessary
`ARV`	`getARV(int rep)` Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
`List<ARV>`	`getARVAll()` Returns a non-modifiable List containing all current existing repetitions of ARV.
`int`	`getARVReps()` Returns the number of existing repetitions of ARV
`CSR`	`getCSR()` Returns CSR (Clinical Study Registration) - creates it if necessary
`NTE`	`getNTE()` Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
`NTE`	`getNTE(int rep)` Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
`List<NTE>`	`getNTEAll()` Returns a non-modifiable List containing all current existing repetitions of NTE.
`int`	`getNTEReps()` Returns the number of existing repetitions of NTE
`PD1`	`getPD1()` Returns PD1 (Patient Additional Demographic) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`PRT`	`getPRT()` Returns the first repetition of PRT (Participation Information) - creates it if necessary
`PRT`	`getPRT(int rep)` Returns a specific repetition of PRT (Participation Information) - creates it if necessary
`List<PRT>`	`getPRTAll()` Returns a non-modifiable List containing all current existing repetitions of PRT.
`int`	`getPRTReps()` Returns the number of existing repetitions of PRT
`CSU_C09_STUDY_PHASE`	`getSTUDY_PHASE()` Returns the first repetition of STUDY_PHASE (a Group object) - creates it if necessary
`CSU_C09_STUDY_PHASE`	`getSTUDY_PHASE(int rep)` Returns a specific repetition of STUDY_PHASE (a Group object) - creates it if necessary
`List<CSU_C09_STUDY_PHASE>`	`getSTUDY_PHASEAll()` Returns a non-modifiable List containing all current existing repetitions of STUDY_PHASE.
`int`	`getSTUDY_PHASEReps()` Returns the number of existing repetitions of STUDY_PHASE
`String`	`getVersion()` Returns "2.8"
`CSU_C09_VISIT`	`getVISIT()` Returns VISIT (a Group object) - creates it if necessary
`void`	`insertARV(ARV structure, int rep)` Inserts a specific repetition of ARV (Access Restriction)
`ARV`	`insertARV(int rep)` Inserts a specific repetition of ARV (Access Restriction)
`NTE`	`insertNTE(int rep)` Inserts a specific repetition of NTE (Notes and Comments)
`void`	`insertNTE(NTE structure, int rep)` Inserts a specific repetition of NTE (Notes and Comments)
`PRT`	`insertPRT(int rep)` Inserts a specific repetition of PRT (Participation Information)
`void`	`insertPRT(PRT structure, int rep)` Inserts a specific repetition of PRT (Participation Information)
`void`	`insertSTUDY_PHASE(CSU_C09_STUDY_PHASE structure, int rep)` Inserts a specific repetition of STUDY_PHASE (a Group object)
`CSU_C09_STUDY_PHASE`	`insertSTUDY_PHASE(int rep)` Inserts a specific repetition of STUDY_PHASE (a Group object)
`ARV`	`removeARV(int rep)` Removes a specific repetition of ARV (Access Restriction)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`PRT`	`removePRT(int rep)` Removes a specific repetition of PRT (Participation Information)
`CSU_C09_STUDY_PHASE`	`removeSTUDY_PHASE(int rep)` Removes a specific repetition of STUDY_PHASE (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
accept, 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 ca.uhn.hl7v2.model.AbstractStructure
getMessage, getParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getMessage, getParent

- Constructor Detail
  - CSU_C09_PATIENT
```
public CSU_C09_PATIENT(Group parent,
                       ModelClassFactory factory)
```
    Creates a new CSU_C09_PATIENT group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8"
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getPD1
```
public PD1 getPD1()
```
    Returns PD1 (Patient Additional Demographic) - creates it if necessary
  - getPRT
```
public PRT getPRT()
```
    Returns the first repetition of PRT (Participation Information) - creates it if necessary
  - getPRT
```
public PRT getPRT(int rep)
```
    Returns a specific repetition of PRT (Participation Information) - 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.
  - getPRTReps
```
public int getPRTReps()
```
    Returns the number of existing repetitions of PRT
  - getPRTAll
```
public List<PRT> getPRTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PRT.
    
    Note that unlike getPRT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPRT
```
public void insertPRT(PRT structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertPRT
```
public PRT insertPRT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removePRT
```
public PRT removePRT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of PRT (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getARV
```
public ARV getARV()
```
    Returns the first repetition of ARV (Access Restriction) - creates it if necessary
  - getARV
```
public ARV getARV(int rep)
```
    Returns a specific repetition of ARV (Access Restriction) - 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.
  - getARVReps
```
public int getARVReps()
```
    Returns the number of existing repetitions of ARV
  - getARVAll
```
public List<ARV> getARVAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ARV.
    
    Note that unlike getARV(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertARV
```
public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertARV
```
public ARV insertARV(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeARV
```
public ARV removeARV(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getNTE
```
public NTE getNTE()
```
    Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
  - getNTE
```
public NTE getNTE(int rep)
```
    Returns a specific repetition of NTE (Notes and Comments) - 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.
  - getNTEReps
```
public int getNTEReps()
```
    Returns the number of existing repetitions of NTE
  - getNTEAll
```
public List<NTE> getNTEAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of NTE.
    
    Note that unlike getNTE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertNTE
```
public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of NTE (Notes and Comments)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertNTE
```
public NTE insertNTE(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NTE (Notes and Comments)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeNTE
```
public NTE removeNTE(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NTE (Notes and Comments)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getVISIT
```
public CSU_C09_VISIT getVISIT()
```
    Returns VISIT (a Group object) - creates it if necessary
  - getCSR
```
public CSR getCSR()
```
    Returns CSR (Clinical Study Registration) - creates it if necessary
  - getSTUDY_PHASE
```
public CSU_C09_STUDY_PHASE getSTUDY_PHASE()
```
    Returns the first repetition of STUDY_PHASE (a Group object) - creates it if necessary
  - getSTUDY_PHASE
```
public CSU_C09_STUDY_PHASE getSTUDY_PHASE(int rep)
```
    Returns a specific repetition of STUDY_PHASE (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.
  - getSTUDY_PHASEReps
```
public int getSTUDY_PHASEReps()
```
    Returns the number of existing repetitions of STUDY_PHASE
  - getSTUDY_PHASEAll
```
public List<CSU_C09_STUDY_PHASE> getSTUDY_PHASEAll()
                                            throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of STUDY_PHASE.
    
    Note that unlike getSTUDY_PHASE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSTUDY_PHASE
```
public void insertSTUDY_PHASE(CSU_C09_STUDY_PHASE structure,
                              int rep)
                       throws HL7Exception
```
    Inserts a specific repetition of STUDY_PHASE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertSTUDY_PHASE
```
public CSU_C09_STUDY_PHASE insertSTUDY_PHASE(int rep)
                                      throws HL7Exception
```
    Inserts a specific repetition of STUDY_PHASE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeSTUDY_PHASE
```
public CSU_C09_STUDY_PHASE removeSTUDY_PHASE(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of STUDY_PHASE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class CSU_C09_PATIENT

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CSU_C09_PATIENT

Method Detail

getVersion

getPID

getPD1

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getARV

getARV

getARVReps

getARVAll

insertARV

insertARV

removeARV

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getVISIT

getCSR

getSTUDY_PHASE

getSTUDY_PHASE

getSTUDY_PHASEReps

getSTUDY_PHASEAll

insertSTUDY_PHASE

insertSTUDY_PHASE

removeSTUDY_PHASE