OPL_O37_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.OPL_O37_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OPL_O37_OBSERVATION_REQUEST
extends AbstractGroup
```
Represents a OPL_O37_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: ORC (Common Order)
- 2: PRT (Participation Information) optional repeating
- 3: OBR (Observation Request)
- 4: PRT (Participation Information) optional repeating
- 5: OPL_O37_TIMING (a Group object) optional repeating
- 6: TCD (Test Code Detail) optional
- 7: DG1 (Diagnosis) optional repeating
- 8: OPL_O37_ORDER_RELATED_OBSERVATION (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

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`OBR`	`getOBR()` Returns OBR (Observation Request) - creates it if necessary
`ORC`	`getORC()` Returns ORC (Common Order) - creates it if necessary
`OPL_O37_ORDER_RELATED_OBSERVATION`	`getORDER_RELATED_OBSERVATION()` Returns the first repetition of ORDER_RELATED_OBSERVATION (a Group object) - creates it if necessary
`OPL_O37_ORDER_RELATED_OBSERVATION`	`getORDER_RELATED_OBSERVATION(int rep)` Returns a specific repetition of ORDER_RELATED_OBSERVATION (a Group object) - creates it if necessary
`List<OPL_O37_ORDER_RELATED_OBSERVATION>`	`getORDER_RELATED_OBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of ORDER_RELATED_OBSERVATION.
`int`	`getORDER_RELATED_OBSERVATIONReps()` Returns the number of existing repetitions of ORDER_RELATED_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
`PRT`	`getPRT2()` Returns the first repetition of PRT2 (Participation Information) - creates it if necessary
`PRT`	`getPRT2(int rep)` Returns a specific repetition of PRT (Participation Information) - creates it if necessary
`List<PRT>`	`getPRT2All()` Returns a non-modifiable List containing all current existing repetitions of PRT2.
`int`	`getPRT2Reps()` Returns the number of existing repetitions of PRT2
`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
`TCD`	`getTCD()` Returns TCD (Test Code Detail) - creates it if necessary
`OPL_O37_TIMING`	`getTIMING()` Returns the first repetition of TIMING (a Group object) - creates it if necessary
`OPL_O37_TIMING`	`getTIMING(int rep)` Returns a specific repetition of TIMING (a Group object) - creates it if necessary
`List<OPL_O37_TIMING>`	`getTIMINGAll()` Returns a non-modifiable List containing all current existing repetitions of TIMING.
`int`	`getTIMINGReps()` Returns the number of existing repetitions of TIMING
`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)
`OPL_O37_ORDER_RELATED_OBSERVATION`	`insertORDER_RELATED_OBSERVATION(int rep)` Inserts a specific repetition of ORDER_RELATED_OBSERVATION (a Group object)
`void`	`insertORDER_RELATED_OBSERVATION(OPL_O37_ORDER_RELATED_OBSERVATION structure, int rep)` Inserts a specific repetition of ORDER_RELATED_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)
`PRT`	`insertPRT2(int rep)` Inserts a specific repetition of PRT2 (Participation Information)
`void`	`insertPRT2(PRT structure, int rep)` Inserts a specific repetition of PRT2 (Participation Information)
`OPL_O37_TIMING`	`insertTIMING(int rep)` Inserts a specific repetition of TIMING (a Group object)
`void`	`insertTIMING(OPL_O37_TIMING structure, int rep)` Inserts a specific repetition of TIMING (a Group object)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`OPL_O37_ORDER_RELATED_OBSERVATION`	`removeORDER_RELATED_OBSERVATION(int rep)` Removes a specific repetition of ORDER_RELATED_OBSERVATION (a Group object)
`PRT`	`removePRT(int rep)` Removes a specific repetition of PRT (Participation Information)
`PRT`	`removePRT2(int rep)` Removes a specific repetition of PRT2 (Participation Information)
`OPL_O37_TIMING`	`removeTIMING(int rep)` Removes a specific repetition of TIMING (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
  - OPL_O37_OBSERVATION_REQUEST
```
public OPL_O37_OBSERVATION_REQUEST(Group parent,
                                   ModelClassFactory factory)
```
    Creates a new OPL_O37_OBSERVATION_REQUEST group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
  - getORC
```
public ORC getORC()
```
    Returns ORC (Common Order) - 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)
  - getOBR
```
public OBR getOBR()
```
    Returns OBR (Observation Request) - creates it if necessary
  - getPRT2
```
public PRT getPRT2()
```
    Returns the first repetition of PRT2 (Participation Information) - creates it if necessary
  - getPRT2
```
public PRT getPRT2(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.
  - getPRT2Reps
```
public int getPRT2Reps()
```
    Returns the number of existing repetitions of PRT2
  - getPRT2All
```
public List<PRT> getPRT2All()
                     throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PRT2.
    
    Note that unlike getPRT2(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPRT2
```
public void insertPRT2(PRT structure,
                       int rep)
                throws HL7Exception
```
    Inserts a specific repetition of PRT2 (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertPRT2
```
public PRT insertPRT2(int rep)
               throws HL7Exception
```
    Inserts a specific repetition of PRT2 (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removePRT2
```
public PRT removePRT2(int rep)
               throws HL7Exception
```
    Removes a specific repetition of PRT2 (Participation Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getTIMING
```
public OPL_O37_TIMING getTIMING()
```
    Returns the first repetition of TIMING (a Group object) - creates it if necessary
  - getTIMING
```
public OPL_O37_TIMING getTIMING(int rep)
```
    Returns a specific repetition of TIMING (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.
  - getTIMINGReps
```
public int getTIMINGReps()
```
    Returns the number of existing repetitions of TIMING
  - getTIMINGAll
```
public List<OPL_O37_TIMING> getTIMINGAll()
                                  throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of TIMING.
    
    Note that unlike getTIMING(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertTIMING
```
public void insertTIMING(OPL_O37_TIMING structure,
                         int rep)
                  throws HL7Exception
```
    Inserts a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertTIMING
```
public OPL_O37_TIMING insertTIMING(int rep)
                            throws HL7Exception
```
    Inserts a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeTIMING
```
public OPL_O37_TIMING removeTIMING(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getTCD
```
public TCD getTCD()
```
    Returns TCD (Test Code Detail) - 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)
  - getORDER_RELATED_OBSERVATION
```
public OPL_O37_ORDER_RELATED_OBSERVATION getORDER_RELATED_OBSERVATION()
```
    Returns the first repetition of ORDER_RELATED_OBSERVATION (a Group object) - creates it if necessary
  - getORDER_RELATED_OBSERVATION
```
public OPL_O37_ORDER_RELATED_OBSERVATION getORDER_RELATED_OBSERVATION(int rep)
```
    Returns a specific repetition of ORDER_RELATED_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.
  - getORDER_RELATED_OBSERVATIONReps
```
public int getORDER_RELATED_OBSERVATIONReps()
```
    Returns the number of existing repetitions of ORDER_RELATED_OBSERVATION
  - getORDER_RELATED_OBSERVATIONAll
```
public List<OPL_O37_ORDER_RELATED_OBSERVATION> getORDER_RELATED_OBSERVATIONAll()
                                                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ORDER_RELATED_OBSERVATION.
    
    Note that unlike getORDER_RELATED_OBSERVATION(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertORDER_RELATED_OBSERVATION
```
public void insertORDER_RELATED_OBSERVATION(OPL_O37_ORDER_RELATED_OBSERVATION structure,
                                            int rep)
                                     throws HL7Exception
```
    Inserts a specific repetition of ORDER_RELATED_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertORDER_RELATED_OBSERVATION
```
public OPL_O37_ORDER_RELATED_OBSERVATION insertORDER_RELATED_OBSERVATION(int rep)
                                                                  throws HL7Exception
```
    Inserts a specific repetition of ORDER_RELATED_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeORDER_RELATED_OBSERVATION
```
public OPL_O37_ORDER_RELATED_OBSERVATION removeORDER_RELATED_OBSERVATION(int rep)
                                                                  throws HL7Exception
```
    Removes a specific repetition of ORDER_RELATED_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

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

OPL_O37_OBSERVATION_REQUEST

Method Detail

getVersion

getORC

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getOBR

getPRT2

getPRT2

getPRT2Reps

getPRT2All

insertPRT2

insertPRT2

removePRT2

getTIMING

getTIMING

getTIMINGReps

getTIMINGAll

insertTIMING

insertTIMING

removeTIMING

getTCD

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getORDER_RELATED_OBSERVATION

getORDER_RELATED_OBSERVATION

getORDER_RELATED_OBSERVATIONReps

getORDER_RELATED_OBSERVATIONAll

insertORDER_RELATED_OBSERVATION

insertORDER_RELATED_OBSERVATION

removeORDER_RELATED_OBSERVATION