OPL_O37_PATIENT (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.v281.group.OPL_O37_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OPL_O37_PATIENT
extends AbstractGroup
```
Represents a OPL_O37_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: OPL_O37_OBSERVATIONS_ON_PATIENT (a Group object) optional repeating
- 6: OPL_O37_INSURANCE (a Group object) optional repeating
- 7: AL1 (Patient Allergy Information) optional repeating
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AL1`	`getAL1()` Returns the first repetition of AL1 (Patient Allergy Information) - creates it if necessary
`AL1`	`getAL1(int rep)` Returns a specific repetition of AL1 (Patient Allergy Information) - creates it if necessary
`List<AL1>`	`getAL1All()` Returns a non-modifiable List containing all current existing repetitions of AL1.
`int`	`getAL1Reps()` Returns the number of existing repetitions of AL1
`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
`OPL_O37_INSURANCE`	`getINSURANCE()` Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
`OPL_O37_INSURANCE`	`getINSURANCE(int rep)` Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
`List<OPL_O37_INSURANCE>`	`getINSURANCEAll()` Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
`int`	`getINSURANCEReps()` Returns the number of existing repetitions of INSURANCE
`OPL_O37_OBSERVATIONS_ON_PATIENT`	`getOBSERVATIONS_ON_PATIENT()` Returns the first repetition of OBSERVATIONS_ON_PATIENT (a Group object) - creates it if necessary
`OPL_O37_OBSERVATIONS_ON_PATIENT`	`getOBSERVATIONS_ON_PATIENT(int rep)` Returns a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object) - creates it if necessary
`List<OPL_O37_OBSERVATIONS_ON_PATIENT>`	`getOBSERVATIONS_ON_PATIENTAll()` Returns a non-modifiable List containing all current existing repetitions of OBSERVATIONS_ON_PATIENT.
`int`	`getOBSERVATIONS_ON_PATIENTReps()` Returns the number of existing repetitions of OBSERVATIONS_ON_PATIENT
`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
`String`	`getVersion()` Returns "2.8.1"
`void`	`insertAL1(AL1 structure, int rep)` Inserts a specific repetition of AL1 (Patient Allergy Information)
`AL1`	`insertAL1(int rep)` Inserts a specific repetition of AL1 (Patient Allergy Information)
`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)
`OPL_O37_INSURANCE`	`insertINSURANCE(int rep)` Inserts a specific repetition of INSURANCE (a Group object)
`void`	`insertINSURANCE(OPL_O37_INSURANCE structure, int rep)` Inserts a specific repetition of INSURANCE (a Group object)
`OPL_O37_OBSERVATIONS_ON_PATIENT`	`insertOBSERVATIONS_ON_PATIENT(int rep)` Inserts a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
`void`	`insertOBSERVATIONS_ON_PATIENT(OPL_O37_OBSERVATIONS_ON_PATIENT structure, int rep)` Inserts a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
`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)
`AL1`	`removeAL1(int rep)` Removes a specific repetition of AL1 (Patient Allergy Information)
`ARV`	`removeARV(int rep)` Removes a specific repetition of ARV (Access Restriction)
`OPL_O37_INSURANCE`	`removeINSURANCE(int rep)` Removes a specific repetition of INSURANCE (a Group object)
`OPL_O37_OBSERVATIONS_ON_PATIENT`	`removeOBSERVATIONS_ON_PATIENT(int rep)` Removes a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
`PRT`	`removePRT(int rep)` Removes a specific repetition of PRT (Participation Information)

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
  - OPL_O37_PATIENT
```
public OPL_O37_PATIENT(Group parent,
                       ModelClassFactory factory)
```
    Creates a new OPL_O37_PATIENT group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
  - 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)
  - getOBSERVATIONS_ON_PATIENT
```
public OPL_O37_OBSERVATIONS_ON_PATIENT getOBSERVATIONS_ON_PATIENT()
```
    Returns the first repetition of OBSERVATIONS_ON_PATIENT (a Group object) - creates it if necessary
  - getOBSERVATIONS_ON_PATIENT
```
public OPL_O37_OBSERVATIONS_ON_PATIENT getOBSERVATIONS_ON_PATIENT(int rep)
```
    Returns a specific repetition of OBSERVATIONS_ON_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.
  - getOBSERVATIONS_ON_PATIENTReps
```
public int getOBSERVATIONS_ON_PATIENTReps()
```
    Returns the number of existing repetitions of OBSERVATIONS_ON_PATIENT
  - getOBSERVATIONS_ON_PATIENTAll
```
public List<OPL_O37_OBSERVATIONS_ON_PATIENT> getOBSERVATIONS_ON_PATIENTAll()
                                                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBSERVATIONS_ON_PATIENT.
    
    Note that unlike getOBSERVATIONS_ON_PATIENT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBSERVATIONS_ON_PATIENT
```
public void insertOBSERVATIONS_ON_PATIENT(OPL_O37_OBSERVATIONS_ON_PATIENT structure,
                                          int rep)
                                   throws HL7Exception
```
    Inserts a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBSERVATIONS_ON_PATIENT
```
public OPL_O37_OBSERVATIONS_ON_PATIENT insertOBSERVATIONS_ON_PATIENT(int rep)
                                                              throws HL7Exception
```
    Inserts a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBSERVATIONS_ON_PATIENT
```
public OPL_O37_OBSERVATIONS_ON_PATIENT removeOBSERVATIONS_ON_PATIENT(int rep)
                                                              throws HL7Exception
```
    Removes a specific repetition of OBSERVATIONS_ON_PATIENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getINSURANCE
```
public OPL_O37_INSURANCE getINSURANCE()
```
    Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
  - getINSURANCE
```
public OPL_O37_INSURANCE getINSURANCE(int rep)
```
    Returns a specific repetition of INSURANCE (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.
  - getINSURANCEReps
```
public int getINSURANCEReps()
```
    Returns the number of existing repetitions of INSURANCE
  - getINSURANCEAll
```
public List<OPL_O37_INSURANCE> getINSURANCEAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
    
    Note that unlike getINSURANCE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertINSURANCE
```
public void insertINSURANCE(OPL_O37_INSURANCE structure,
                            int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of INSURANCE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertINSURANCE
```
public OPL_O37_INSURANCE insertINSURANCE(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of INSURANCE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeINSURANCE
```
public OPL_O37_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of INSURANCE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getAL1
```
public AL1 getAL1()
```
    Returns the first repetition of AL1 (Patient Allergy Information) - creates it if necessary
  - getAL1
```
public AL1 getAL1(int rep)
```
    Returns a specific repetition of AL1 (Patient Allergy 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.
  - getAL1Reps
```
public int getAL1Reps()
```
    Returns the number of existing repetitions of AL1
  - getAL1All
```
public List<AL1> getAL1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of AL1.
    
    Note that unlike getAL1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertAL1
```
public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertAL1
```
public AL1 insertAL1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeAL1
```
public AL1 removeAL1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class OPL_O37_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

OPL_O37_PATIENT

Method Detail

getVersion

getPID

getPD1

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getARV

getARV

getARVReps

getARVAll

insertARV

insertARV

removeARV

getOBSERVATIONS_ON_PATIENT

getOBSERVATIONS_ON_PATIENT

getOBSERVATIONS_ON_PATIENTReps

getOBSERVATIONS_ON_PATIENTAll

insertOBSERVATIONS_ON_PATIENT

insertOBSERVATIONS_ON_PATIENT

removeOBSERVATIONS_ON_PATIENT

getINSURANCE

getINSURANCE

getINSURANCEReps

getINSURANCEAll

insertINSURANCE

insertINSURANCE

removeINSURANCE

getAL1

getAL1

getAL1Reps

getAL1All

insertAL1

insertAL1

removeAL1