OMP_O09_ORDER (HAPI - Java HL7 API - Generated Structures v2.6 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v26.group.OMP_O09_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OMP_O09_ORDER
extends AbstractGroup
```
Represents a OMP_O09_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: ORC (Common Order)
- 2: OMP_O09_TIMING (a Group object) optional repeating
- 3: RXO (Pharmacy/Treatment Order)
- 4: NTE (Notes and Comments) optional repeating
- 5: RXR (Pharmacy/Treatment Route) repeating
- 6: OMP_O09_COMPONENT (a Group object) optional repeating
- 7: OMP_O09_OBSERVATION (a Group object) optional repeating
- 8: FT1 (Financial Transaction) optional repeating
- 9: BLG (Billing) optional
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BLG`	`getBLG()` Returns BLG (Billing) - creates it if necessary
`OMP_O09_COMPONENT`	`getCOMPONENT()` Returns the first repetition of COMPONENT (a Group object) - creates it if necessary
`OMP_O09_COMPONENT`	`getCOMPONENT(int rep)` Returns a specific repetition of COMPONENT (a Group object) - creates it if necessary
`List<OMP_O09_COMPONENT>`	`getCOMPONENTAll()` Returns a non-modifiable List containing all current existing repetitions of COMPONENT.
`int`	`getCOMPONENTReps()` Returns the number of existing repetitions of COMPONENT
`FT1`	`getFT1()` Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary
`FT1`	`getFT1(int rep)` Returns a specific repetition of FT1 (Financial Transaction) - creates it if necessary
`List<FT1>`	`getFT1All()` Returns a non-modifiable List containing all current existing repetitions of FT1.
`int`	`getFT1Reps()` Returns the number of existing repetitions of FT1
`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
`OMP_O09_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`OMP_O09_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<OMP_O09_OBSERVATION>`	`getOBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
`int`	`getOBSERVATIONReps()` Returns the number of existing repetitions of OBSERVATION
`ORC`	`getORC()` Returns ORC (Common Order) - creates it if necessary
`RXO`	`getRXO()` Returns RXO (Pharmacy/Treatment Order) - creates it if necessary
`RXR`	`getRXR()` Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
`RXR`	`getRXR(int rep)` Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
`List<RXR>`	`getRXRAll()` Returns a non-modifiable List containing all current existing repetitions of RXR.
`int`	`getRXRReps()` Returns the number of existing repetitions of RXR
`OMP_O09_TIMING`	`getTIMING()` Returns the first repetition of TIMING (a Group object) - creates it if necessary
`OMP_O09_TIMING`	`getTIMING(int rep)` Returns a specific repetition of TIMING (a Group object) - creates it if necessary
`List<OMP_O09_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.6"
`OMP_O09_COMPONENT`	`insertCOMPONENT(int rep)` Inserts a specific repetition of COMPONENT (a Group object)
`void`	`insertCOMPONENT(OMP_O09_COMPONENT structure, int rep)` Inserts a specific repetition of COMPONENT (a Group object)
`void`	`insertFT1(FT1 structure, int rep)` Inserts a specific repetition of FT1 (Financial Transaction)
`FT1`	`insertFT1(int rep)` Inserts a specific repetition of FT1 (Financial Transaction)
`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)
`OMP_O09_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertOBSERVATION(OMP_O09_OBSERVATION structure, int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`RXR`	`insertRXR(int rep)` Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
`void`	`insertRXR(RXR structure, int rep)` Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
`OMP_O09_TIMING`	`insertTIMING(int rep)` Inserts a specific repetition of TIMING (a Group object)
`void`	`insertTIMING(OMP_O09_TIMING structure, int rep)` Inserts a specific repetition of TIMING (a Group object)
`OMP_O09_COMPONENT`	`removeCOMPONENT(int rep)` Removes a specific repetition of COMPONENT (a Group object)
`FT1`	`removeFT1(int rep)` Removes a specific repetition of FT1 (Financial Transaction)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OMP_O09_OBSERVATION`	`removeOBSERVATION(int rep)` Removes a specific repetition of OBSERVATION (a Group object)
`RXR`	`removeRXR(int rep)` Removes a specific repetition of RXR (Pharmacy/Treatment Route)
`OMP_O09_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
  - OMP_O09_ORDER
```
public OMP_O09_ORDER(Group parent,
                     ModelClassFactory factory)
```
    Creates a new OMP_O09_ORDER group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.6"
  - getORC
```
public ORC getORC()
```
    Returns ORC (Common Order) - creates it if necessary
  - getTIMING
```
public OMP_O09_TIMING getTIMING()
```
    Returns the first repetition of TIMING (a Group object) - creates it if necessary
  - getTIMING
```
public OMP_O09_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<OMP_O09_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(OMP_O09_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 OMP_O09_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 OMP_O09_TIMING removeTIMING(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getRXO
```
public RXO getRXO()
```
    Returns RXO (Pharmacy/Treatment 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)
  - getRXR
```
public RXR getRXR()
```
    Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
  - getRXR
```
public RXR getRXR(int rep)
```
    Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.
  - getRXRReps
```
public int getRXRReps()
```
    Returns the number of existing repetitions of RXR
  - getRXRAll
```
public List<RXR> getRXRAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RXR.
    
    Note that unlike getRXR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRXR
```
public void insertRXR(RXR structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRXR
```
public RXR insertRXR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRXR
```
public RXR removeRXR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getCOMPONENT
```
public OMP_O09_COMPONENT getCOMPONENT()
```
    Returns the first repetition of COMPONENT (a Group object) - creates it if necessary
  - getCOMPONENT
```
public OMP_O09_COMPONENT getCOMPONENT(int rep)
```
    Returns a specific repetition of COMPONENT (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.
  - getCOMPONENTReps
```
public int getCOMPONENTReps()
```
    Returns the number of existing repetitions of COMPONENT
  - getCOMPONENTAll
```
public List<OMP_O09_COMPONENT> getCOMPONENTAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of COMPONENT.
    
    Note that unlike getCOMPONENT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertCOMPONENT
```
public void insertCOMPONENT(OMP_O09_COMPONENT structure,
                            int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of COMPONENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertCOMPONENT
```
public OMP_O09_COMPONENT insertCOMPONENT(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of COMPONENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeCOMPONENT
```
public OMP_O09_COMPONENT removeCOMPONENT(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of COMPONENT (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBSERVATION
```
public OMP_O09_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public OMP_O09_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<OMP_O09_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(OMP_O09_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 OMP_O09_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 OMP_O09_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getFT1
```
public FT1 getFT1()
```
    Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary
  - getFT1
```
public FT1 getFT1(int rep)
```
    Returns a specific repetition of FT1 (Financial Transaction) - 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.
  - getFT1Reps
```
public int getFT1Reps()
```
    Returns the number of existing repetitions of FT1
  - getFT1All
```
public List<FT1> getFT1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of FT1.
    
    Note that unlike getFT1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertFT1
```
public void insertFT1(FT1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of FT1 (Financial Transaction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertFT1
```
public FT1 insertFT1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of FT1 (Financial Transaction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeFT1
```
public FT1 removeFT1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of FT1 (Financial Transaction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getBLG
```
public BLG getBLG()
```
    Returns BLG (Billing) - creates it if necessary

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

OMP_O09_ORDER

Method Detail

getVersion

getORC

getTIMING

getTIMING

getTIMINGReps

getTIMINGAll

insertTIMING

insertTIMING

removeTIMING

getRXO

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getRXR

getRXR

getRXRReps

getRXRAll

insertRXR

insertRXR

removeRXR

getCOMPONENT

getCOMPONENT

getCOMPONENTReps

getCOMPONENTAll

insertCOMPONENT

insertCOMPONENT

removeCOMPONENT

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION

getFT1

getFT1

getFT1Reps

getFT1All

insertFT1

insertFT1

removeFT1

getBLG