OUL_R23_ORDER (HAPI - Java HL7 API - Generated Structures v2.7 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v27.group.OUL_R23_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OUL_R23_ORDER
extends AbstractGroup
```
Represents a OUL_R23_ORDER 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: ORC (Common Order) optional
- 3: NTE (Notes and Comments) optional repeating
- 4: PRT (Participation Information) optional repeating
- 5: OUL_R23_TIMING_QTY (a Group object) optional repeating
- 6: OUL_R23_RESULT (a Group object) optional repeating
- 7: CTI (Clinical Trial Identification) optional repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CTI`	`getCTI()` Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
`CTI`	`getCTI(int rep)` Returns a specific repetition of CTI (Clinical Trial Identification) - creates it if necessary
`List<CTI>`	`getCTIAll()` Returns a non-modifiable List containing all current existing repetitions of CTI.
`int`	`getCTIReps()` Returns the number of existing repetitions of CTI
`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
`ORC`	`getORC()` Returns ORC (Common Order) - 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
`OUL_R23_RESULT`	`getRESULT()` Returns the first repetition of RESULT (a Group object) - creates it if necessary
`OUL_R23_RESULT`	`getRESULT(int rep)` Returns a specific repetition of RESULT (a Group object) - creates it if necessary
`List<OUL_R23_RESULT>`	`getRESULTAll()` Returns a non-modifiable List containing all current existing repetitions of RESULT.
`int`	`getRESULTReps()` Returns the number of existing repetitions of RESULT
`OUL_R23_TIMING_QTY`	`getTIMING_QTY()` Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary
`OUL_R23_TIMING_QTY`	`getTIMING_QTY(int rep)` Returns a specific repetition of TIMING_QTY (a Group object) - creates it if necessary
`List<OUL_R23_TIMING_QTY>`	`getTIMING_QTYAll()` Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY.
`int`	`getTIMING_QTYReps()` Returns the number of existing repetitions of TIMING_QTY
`String`	`getVersion()` Returns "2.7"
`void`	`insertCTI(CTI structure, int rep)` Inserts a specific repetition of CTI (Clinical Trial Identification)
`CTI`	`insertCTI(int rep)` Inserts a specific repetition of CTI (Clinical Trial Identification)
`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)
`OUL_R23_RESULT`	`insertRESULT(int rep)` Inserts a specific repetition of RESULT (a Group object)
`void`	`insertRESULT(OUL_R23_RESULT structure, int rep)` Inserts a specific repetition of RESULT (a Group object)
`OUL_R23_TIMING_QTY`	`insertTIMING_QTY(int rep)` Inserts a specific repetition of TIMING_QTY (a Group object)
`void`	`insertTIMING_QTY(OUL_R23_TIMING_QTY structure, int rep)` Inserts a specific repetition of TIMING_QTY (a Group object)
`CTI`	`removeCTI(int rep)` Removes a specific repetition of CTI (Clinical Trial Identification)
`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)
`OUL_R23_RESULT`	`removeRESULT(int rep)` Removes a specific repetition of RESULT (a Group object)
`OUL_R23_TIMING_QTY`	`removeTIMING_QTY(int rep)` Removes a specific repetition of TIMING_QTY (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
  - OUL_R23_ORDER
```
public OUL_R23_ORDER(Group parent,
                     ModelClassFactory factory)
```
    Creates a new OUL_R23_ORDER group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.7"
  - getOBR
```
public OBR getOBR()
```
    Returns OBR (Observation Request) - creates it if necessary
  - getORC
```
public ORC getORC()
```
    Returns ORC (Common Order) - 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)
  - getTIMING_QTY
```
public OUL_R23_TIMING_QTY getTIMING_QTY()
```
    Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary
  - getTIMING_QTY
```
public OUL_R23_TIMING_QTY getTIMING_QTY(int rep)
```
    Returns a specific repetition of TIMING_QTY (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.
  - getTIMING_QTYReps
```
public int getTIMING_QTYReps()
```
    Returns the number of existing repetitions of TIMING_QTY
  - getTIMING_QTYAll
```
public List<OUL_R23_TIMING_QTY> getTIMING_QTYAll()
                                          throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY.
    
    Note that unlike getTIMING_QTY(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertTIMING_QTY
```
public void insertTIMING_QTY(OUL_R23_TIMING_QTY structure,
                             int rep)
                      throws HL7Exception
```
    Inserts a specific repetition of TIMING_QTY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertTIMING_QTY
```
public OUL_R23_TIMING_QTY insertTIMING_QTY(int rep)
                                    throws HL7Exception
```
    Inserts a specific repetition of TIMING_QTY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeTIMING_QTY
```
public OUL_R23_TIMING_QTY removeTIMING_QTY(int rep)
                                    throws HL7Exception
```
    Removes a specific repetition of TIMING_QTY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getRESULT
```
public OUL_R23_RESULT getRESULT()
```
    Returns the first repetition of RESULT (a Group object) - creates it if necessary
  - getRESULT
```
public OUL_R23_RESULT getRESULT(int rep)
```
    Returns a specific repetition of RESULT (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.
  - getRESULTReps
```
public int getRESULTReps()
```
    Returns the number of existing repetitions of RESULT
  - getRESULTAll
```
public List<OUL_R23_RESULT> getRESULTAll()
                                  throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RESULT.
    
    Note that unlike getRESULT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRESULT
```
public void insertRESULT(OUL_R23_RESULT structure,
                         int rep)
                  throws HL7Exception
```
    Inserts a specific repetition of RESULT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRESULT
```
public OUL_R23_RESULT insertRESULT(int rep)
                            throws HL7Exception
```
    Inserts a specific repetition of RESULT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRESULT
```
public OUL_R23_RESULT removeRESULT(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of RESULT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getCTI
```
public CTI getCTI()
```
    Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
  - getCTI
```
public CTI getCTI(int rep)
```
    Returns a specific repetition of CTI (Clinical Trial Identification) - 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.
  - getCTIReps
```
public int getCTIReps()
```
    Returns the number of existing repetitions of CTI
  - getCTIAll
```
public List<CTI> getCTIAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of CTI.
    
    Note that unlike getCTI(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertCTI
```
public void insertCTI(CTI structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of CTI (Clinical Trial Identification)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertCTI
```
public CTI insertCTI(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of CTI (Clinical Trial Identification)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeCTI
```
public CTI removeCTI(int rep)
              throws HL7Exception
```
    Removes a specific repetition of CTI (Clinical Trial Identification)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class OUL_R23_ORDER

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

OUL_R23_ORDER

Method Detail

getVersion

getOBR

getORC

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getTIMING_QTY

getTIMING_QTY

getTIMING_QTYReps

getTIMING_QTYAll

insertTIMING_QTY

insertTIMING_QTY

removeTIMING_QTY

getRESULT

getRESULT

getRESULTReps

getRESULTAll

insertRESULT

insertRESULT

removeRESULT

getCTI

getCTI

getCTIReps

getCTIAll

insertCTI

insertCTI

removeCTI