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

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OMI_O23_ORDER
extends AbstractGroup
```
Represents a OMI_O23_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: PRT (Participation Information) optional repeating
- 3: OMI_O23_TIMING (a Group object) optional repeating
- 4: OBR (Observation Request)
- 5: NTE (Notes and Comments) optional repeating
- 6: PRT (Participation Information) optional repeating
- 7: CTD (Contact Data) optional
- 8: DG1 (Diagnosis) optional repeating
- 9: OMI_O23_OBSERVATION (a Group object) optional repeating
- 10: IPC (Imaging Procedure Control Segment) repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`OMI_O23_ORDER(Group parent, ModelClassFactory factory)` Creates a new OMI_O23_ORDER 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
`IPC`	`getIPC()` Returns the first repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary
`IPC`	`getIPC(int rep)` Returns a specific repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary
`List<IPC>`	`getIPCAll()` Returns a non-modifiable List containing all current existing repetitions of IPC.
`int`	`getIPCReps()` Returns the number of existing repetitions of IPC
`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
`OMI_O23_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`OMI_O23_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<OMI_O23_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
`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
`OMI_O23_TIMING`	`getTIMING()` Returns the first repetition of TIMING (a Group object) - creates it if necessary
`OMI_O23_TIMING`	`getTIMING(int rep)` Returns a specific repetition of TIMING (a Group object) - creates it if necessary
`List<OMI_O23_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)
`IPC`	`insertIPC(int rep)` Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
`void`	`insertIPC(IPC structure, int rep)` Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
`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)
`OMI_O23_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertOBSERVATION(OMI_O23_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)
`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)
`OMI_O23_TIMING`	`insertTIMING(int rep)` Inserts a specific repetition of TIMING (a Group object)
`void`	`insertTIMING(OMI_O23_TIMING structure, int rep)` Inserts a specific repetition of TIMING (a Group object)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`IPC`	`removeIPC(int rep)` Removes a specific repetition of IPC (Imaging Procedure Control Segment)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OMI_O23_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)
`PRT`	`removePRT2(int rep)` Removes a specific repetition of PRT2 (Participation Information)
`OMI_O23_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
  - OMI_O23_ORDER
```
public OMI_O23_ORDER(Group parent,
                     ModelClassFactory factory)
```
    Creates a new OMI_O23_ORDER 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)
  - getTIMING
```
public OMI_O23_TIMING getTIMING()
```
    Returns the first repetition of TIMING (a Group object) - creates it if necessary
  - getTIMING
```
public OMI_O23_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<OMI_O23_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(OMI_O23_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 OMI_O23_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 OMI_O23_TIMING removeTIMING(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBR
```
public OBR getOBR()
```
    Returns OBR (Observation Request) - 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)
  - 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)
  - 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 OMI_O23_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public OMI_O23_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<OMI_O23_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(OMI_O23_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 OMI_O23_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 OMI_O23_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getIPC
```
public IPC getIPC()
```
    Returns the first repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary
  - getIPC
```
public IPC getIPC(int rep)
```
    Returns a specific repetition of IPC (Imaging Procedure Control Segment) - 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.
  - getIPCReps
```
public int getIPCReps()
```
    Returns the number of existing repetitions of IPC
  - getIPCAll
```
public List<IPC> getIPCAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of IPC.
    
    Note that unlike getIPC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertIPC
```
public void insertIPC(IPC structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertIPC
```
public IPC insertIPC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeIPC
```
public IPC removeIPC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of IPC (Imaging Procedure Control Segment)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

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

OMI_O23_ORDER

Method Detail

getVersion

getORC

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getTIMING

getTIMING

getTIMINGReps

getTIMINGAll

insertTIMING

insertTIMING

removeTIMING

getOBR

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getPRT2

getPRT2

getPRT2Reps

getPRT2All

insertPRT2

insertPRT2

removePRT2

getCTD

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION

getIPC

getIPC

getIPCReps

getIPCAll

insertIPC

insertIPC

removeIPC