OML_O39_OBSERVATION_REQUEST (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.OML_O39_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OML_O39_OBSERVATION_REQUEST
extends AbstractGroup
```
Represents a OML_O39_OBSERVATION_REQUEST 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: OBR (Observation Request)
- 2: TCD (Test Code Detail) optional
- 3: NTE (Notes and Comments) optional repeating
- 4: PRT (Participation Information) optional repeating
- 5: CTD (Contact Data) optional
- 6: DG1 (Diagnosis) optional repeating
- 7: OML_O39_OBSERVATION (a Group object) optional repeating
- 8: OML_O39_SPECIMEN_SHIPMENT (a Group object) 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_O39_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory)
Creates a new OML_O39_OBSERVATION_REQUEST group

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CTD`	`getCTD()` Returns CTD (Contact Data) - creates it if necessary
`DG1`	`getDG1()` Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
`DG1`	`getDG1(int rep)` Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
`List<DG1>`	`getDG1All()` Returns a non-modifiable List containing all current existing repetitions of DG1.
`int`	`getDG1Reps()` Returns the number of existing repetitions of DG1
`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
`OBR`	`getOBR()` Returns OBR (Observation Request) - creates it if necessary
`OML_O39_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`OML_O39_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<OML_O39_OBSERVATION>`	`getOBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
`int`	`getOBSERVATIONReps()` Returns the number of existing repetitions of OBSERVATION
`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
`OML_O39_SPECIMEN_SHIPMENT`	`getSPECIMEN_SHIPMENT()` Returns the first repetition of SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
`OML_O39_SPECIMEN_SHIPMENT`	`getSPECIMEN_SHIPMENT(int rep)` Returns a specific repetition of SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
`List<OML_O39_SPECIMEN_SHIPMENT>`	`getSPECIMEN_SHIPMENTAll()` Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_SHIPMENT.
`int`	`getSPECIMEN_SHIPMENTReps()` Returns the number of existing repetitions of SPECIMEN_SHIPMENT
`TCD`	`getTCD()` Returns TCD (Test Code Detail) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`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)
`OML_O39_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertOBSERVATION(OML_O39_OBSERVATION structure, int rep)` Inserts a specific repetition of OBSERVATION (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)
`OML_O39_SPECIMEN_SHIPMENT`	`insertSPECIMEN_SHIPMENT(int rep)` Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
`void`	`insertSPECIMEN_SHIPMENT(OML_O39_SPECIMEN_SHIPMENT structure, int rep)` Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OML_O39_OBSERVATION`	`removeOBSERVATION(int rep)` Removes a specific repetition of OBSERVATION (a Group object)
`PRT`	`removePRT(int rep)` Removes a specific repetition of PRT (Participation Information)
`OML_O39_SPECIMEN_SHIPMENT`	`removeSPECIMEN_SHIPMENT(int rep)` Removes a specific repetition of SPECIMEN_SHIPMENT (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
  - OML_O39_OBSERVATION_REQUEST
```
public OML_O39_OBSERVATION_REQUEST(Group parent,
                                   ModelClassFactory factory)
```
    Creates a new OML_O39_OBSERVATION_REQUEST group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
  - getOBR
```
public OBR getOBR()
```
    Returns OBR (Observation Request) - creates it if necessary
  - getTCD
```
public TCD getTCD()
```
    Returns TCD (Test Code Detail) - 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)
  - 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)
  - getCTD
```
public CTD getCTD()
```
    Returns CTD (Contact Data) - creates it if necessary
  - getDG1
```
public DG1 getDG1()
```
    Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
  - getDG1
```
public DG1 getDG1(int rep)
```
    Returns a specific repetition of DG1 (Diagnosis) - 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.
  - getDG1Reps
```
public int getDG1Reps()
```
    Returns the number of existing repetitions of DG1
  - getDG1All
```
public List<DG1> getDG1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DG1.
    
    Note that unlike getDG1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDG1
```
public void insertDG1(DG1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DG1 (Diagnosis)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertDG1
```
public DG1 insertDG1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DG1 (Diagnosis)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeDG1
```
public DG1 removeDG1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DG1 (Diagnosis)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBSERVATION
```
public OML_O39_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public OML_O39_OBSERVATION getOBSERVATION(int rep)
```
    Returns a specific repetition of OBSERVATION (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.
  - getOBSERVATIONReps
```
public int getOBSERVATIONReps()
```
    Returns the number of existing repetitions of OBSERVATION
  - getOBSERVATIONAll
```
public List<OML_O39_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
    
    Note that unlike getOBSERVATION(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBSERVATION
```
public void insertOBSERVATION(OML_O39_OBSERVATION structure,
                              int rep)
                       throws HL7Exception
```
    Inserts a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBSERVATION
```
public OML_O39_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception
```
    Inserts a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBSERVATION
```
public OML_O39_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getSPECIMEN_SHIPMENT
```
public OML_O39_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT()
```
    Returns the first repetition of SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
  - getSPECIMEN_SHIPMENT
```
public OML_O39_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT(int rep)
```
    Returns a specific repetition of SPECIMEN_SHIPMENT (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.
  - getSPECIMEN_SHIPMENTReps
```
public int getSPECIMEN_SHIPMENTReps()
```
    Returns the number of existing repetitions of SPECIMEN_SHIPMENT
  - getSPECIMEN_SHIPMENTAll
```
public List<OML_O39_SPECIMEN_SHIPMENT> getSPECIMEN_SHIPMENTAll()
                                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_SHIPMENT.
    
    Note that unlike getSPECIMEN_SHIPMENT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSPECIMEN_SHIPMENT
```
public void insertSPECIMEN_SHIPMENT(OML_O39_SPECIMEN_SHIPMENT structure,
                                    int rep)
                             throws HL7Exception
```
    Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertSPECIMEN_SHIPMENT
```
public OML_O39_SPECIMEN_SHIPMENT insertSPECIMEN_SHIPMENT(int rep)
                                                  throws HL7Exception
```
    Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeSPECIMEN_SHIPMENT
```
public OML_O39_SPECIMEN_SHIPMENT removeSPECIMEN_SHIPMENT(int rep)
                                                  throws HL7Exception
```
    Removes a specific repetition of SPECIMEN_SHIPMENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class OML_O39_OBSERVATION_REQUEST

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_O39_OBSERVATION_REQUEST

Method Detail

getVersion

getOBR

getTCD

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getCTD

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION

getSPECIMEN_SHIPMENT

getSPECIMEN_SHIPMENT

getSPECIMEN_SHIPMENTReps

getSPECIMEN_SHIPMENTAll

insertSPECIMEN_SHIPMENT

insertSPECIMEN_SHIPMENT

removeSPECIMEN_SHIPMENT