OML_O35_PATIENT (HAPI - Java HL7 API - Generated Structures v2.5.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v251.group.OML_O35_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OML_O35_PATIENT
extends AbstractGroup
```
Represents a OML_O35_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: NTE (Notes and Comments) optional repeating
- 4: NK1 (Next of Kin / Associated Parties) optional repeating
- 5: OML_O35_PATIENT_VISIT (a Group object) optional
- 6: OML_O35_INSURANCE (a Group object) optional repeating
- 7: GT1 (Guarantor) optional
- 8: 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

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

Constructors
Constructor and Description
`OML_O35_PATIENT(Group parent, ModelClassFactory factory)` Creates a new OML_O35_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
`GT1`	`getGT1()` Returns GT1 (Guarantor) - creates it if necessary
`OML_O35_INSURANCE`	`getINSURANCE()` Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
`OML_O35_INSURANCE`	`getINSURANCE(int rep)` Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
`List<OML_O35_INSURANCE>`	`getINSURANCEAll()` Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
`int`	`getINSURANCEReps()` Returns the number of existing repetitions of INSURANCE
`NK1`	`getNK1()` Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
`NK1`	`getNK1(int rep)` Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
`List<NK1>`	`getNK1All()` Returns a non-modifiable List containing all current existing repetitions of NK1.
`int`	`getNK1Reps()` Returns the number of existing repetitions of NK1
`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
`OML_O35_PATIENT_VISIT`	`getPATIENT_VISIT()` Returns PATIENT_VISIT (a Group object) - creates it if necessary
`PD1`	`getPD1()` Returns PD1 (Patient Additional Demographic) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`String`	`getVersion()` Returns "2.5.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)
`OML_O35_INSURANCE`	`insertINSURANCE(int rep)` Inserts a specific repetition of INSURANCE (a Group object)
`void`	`insertINSURANCE(OML_O35_INSURANCE structure, int rep)` Inserts a specific repetition of INSURANCE (a Group object)
`NK1`	`insertNK1(int rep)` Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
`void`	`insertNK1(NK1 structure, int rep)` Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
`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)
`AL1`	`removeAL1(int rep)` Removes a specific repetition of AL1 (Patient Allergy Information)
`OML_O35_INSURANCE`	`removeINSURANCE(int rep)` Removes a specific repetition of INSURANCE (a Group object)
`NK1`	`removeNK1(int rep)` Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)

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
  - OML_O35_PATIENT
```
public OML_O35_PATIENT(Group parent,
                       ModelClassFactory factory)
```
    Creates a new OML_O35_PATIENT group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5.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
  - 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)
  - getNK1
```
public NK1 getNK1()
```
    Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
  - getNK1
```
public NK1 getNK1(int rep)
```
    Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - 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.
  - getNK1Reps
```
public int getNK1Reps()
```
    Returns the number of existing repetitions of NK1
  - getNK1All
```
public List<NK1> getNK1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of NK1.
    
    Note that unlike getNK1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertNK1
```
public void insertNK1(NK1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertNK1
```
public NK1 insertNK1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeNK1
```
public NK1 removeNK1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getPATIENT_VISIT
```
public OML_O35_PATIENT_VISIT getPATIENT_VISIT()
```
    Returns PATIENT_VISIT (a Group object) - creates it if necessary
  - getINSURANCE
```
public OML_O35_INSURANCE getINSURANCE()
```
    Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
  - getINSURANCE
```
public OML_O35_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<OML_O35_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(OML_O35_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 OML_O35_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 OML_O35_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of INSURANCE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getGT1
```
public GT1 getGT1()
```
    Returns GT1 (Guarantor) - creates it if necessary
  - 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 OML_O35_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

OML_O35_PATIENT

Method Detail

getVersion

getPID

getPD1

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getNK1

getNK1

getNK1Reps

getNK1All

insertNK1

insertNK1

removeNK1

getPATIENT_VISIT

getINSURANCE

getINSURANCE

getINSURANCEReps

getINSURANCEAll

insertINSURANCE

insertINSURANCE

removeINSURANCE

getGT1

getAL1

getAL1

getAL1Reps

getAL1All

insertAL1

insertAL1

removeAL1