OMQ_O42_ORDER_PRIOR (HAPI - Java HL7 API - Generated Structures v2.8 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v28.group.OMQ_O42_ORDER_PRIOR

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OMQ_O42_ORDER_PRIOR
extends AbstractGroup
```
Represents a OMQ_O42_ORDER_PRIOR 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: OMQ_O42_TIMING_PRIOR (a Group object) optional repeating
- 5: NTE (Notes and Comments) optional repeating
- 6: PRT (Participation Information) optional repeating
- 7: CTD (Contact Data) optional
- 8: OMQ_O42_OBSERVATION_PRIOR (a Group object) repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`OMQ_O42_ORDER_PRIOR(Group parent, ModelClassFactory factory)` Creates a new OMQ_O42_ORDER_PRIOR 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
`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
`OMQ_O42_OBSERVATION_PRIOR`	`getOBSERVATION_PRIOR()` Returns the first repetition of OBSERVATION_PRIOR (a Group object) - creates it if necessary
`OMQ_O42_OBSERVATION_PRIOR`	`getOBSERVATION_PRIOR(int rep)` Returns a specific repetition of OBSERVATION_PRIOR (a Group object) - creates it if necessary
`List<OMQ_O42_OBSERVATION_PRIOR>`	`getOBSERVATION_PRIORAll()` Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_PRIOR.
`int`	`getOBSERVATION_PRIORReps()` Returns the number of existing repetitions of OBSERVATION_PRIOR
`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
`OMQ_O42_TIMING_PRIOR`	`getTIMING_PRIOR()` Returns the first repetition of TIMING_PRIOR (a Group object) - creates it if necessary
`OMQ_O42_TIMING_PRIOR`	`getTIMING_PRIOR(int rep)` Returns a specific repetition of TIMING_PRIOR (a Group object) - creates it if necessary
`List<OMQ_O42_TIMING_PRIOR>`	`getTIMING_PRIORAll()` Returns a non-modifiable List containing all current existing repetitions of TIMING_PRIOR.
`int`	`getTIMING_PRIORReps()` Returns the number of existing repetitions of TIMING_PRIOR
`String`	`getVersion()` Returns "2.8"
`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)
`OMQ_O42_OBSERVATION_PRIOR`	`insertOBSERVATION_PRIOR(int rep)` Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
`void`	`insertOBSERVATION_PRIOR(OMQ_O42_OBSERVATION_PRIOR structure, int rep)` Inserts a specific repetition of OBSERVATION_PRIOR (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)
`OMQ_O42_TIMING_PRIOR`	`insertTIMING_PRIOR(int rep)` Inserts a specific repetition of TIMING_PRIOR (a Group object)
`void`	`insertTIMING_PRIOR(OMQ_O42_TIMING_PRIOR structure, int rep)` Inserts a specific repetition of TIMING_PRIOR (a Group object)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OMQ_O42_OBSERVATION_PRIOR`	`removeOBSERVATION_PRIOR(int rep)` Removes a specific repetition of OBSERVATION_PRIOR (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)
`OMQ_O42_TIMING_PRIOR`	`removeTIMING_PRIOR(int rep)` Removes a specific repetition of TIMING_PRIOR (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
  - OMQ_O42_ORDER_PRIOR
```
public OMQ_O42_ORDER_PRIOR(Group parent,
                           ModelClassFactory factory)
```
    Creates a new OMQ_O42_ORDER_PRIOR group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8"
  - 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
  - getTIMING_PRIOR
```
public OMQ_O42_TIMING_PRIOR getTIMING_PRIOR()
```
    Returns the first repetition of TIMING_PRIOR (a Group object) - creates it if necessary
  - getTIMING_PRIOR
```
public OMQ_O42_TIMING_PRIOR getTIMING_PRIOR(int rep)
```
    Returns a specific repetition of TIMING_PRIOR (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_PRIORReps
```
public int getTIMING_PRIORReps()
```
    Returns the number of existing repetitions of TIMING_PRIOR
  - getTIMING_PRIORAll
```
public List<OMQ_O42_TIMING_PRIOR> getTIMING_PRIORAll()
                                              throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of TIMING_PRIOR.
    
    Note that unlike getTIMING_PRIOR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertTIMING_PRIOR
```
public void insertTIMING_PRIOR(OMQ_O42_TIMING_PRIOR structure,
                               int rep)
                        throws HL7Exception
```
    Inserts a specific repetition of TIMING_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertTIMING_PRIOR
```
public OMQ_O42_TIMING_PRIOR insertTIMING_PRIOR(int rep)
                                        throws HL7Exception
```
    Inserts a specific repetition of TIMING_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeTIMING_PRIOR
```
public OMQ_O42_TIMING_PRIOR removeTIMING_PRIOR(int rep)
                                        throws HL7Exception
```
    Removes a specific repetition of TIMING_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - 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
  - getOBSERVATION_PRIOR
```
public OMQ_O42_OBSERVATION_PRIOR getOBSERVATION_PRIOR()
```
    Returns the first repetition of OBSERVATION_PRIOR (a Group object) - creates it if necessary
  - getOBSERVATION_PRIOR
```
public OMQ_O42_OBSERVATION_PRIOR getOBSERVATION_PRIOR(int rep)
```
    Returns a specific repetition of OBSERVATION_PRIOR (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.
  - getOBSERVATION_PRIORReps
```
public int getOBSERVATION_PRIORReps()
```
    Returns the number of existing repetitions of OBSERVATION_PRIOR
  - getOBSERVATION_PRIORAll
```
public List<OMQ_O42_OBSERVATION_PRIOR> getOBSERVATION_PRIORAll()
                                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_PRIOR.
    
    Note that unlike getOBSERVATION_PRIOR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBSERVATION_PRIOR
```
public void insertOBSERVATION_PRIOR(OMQ_O42_OBSERVATION_PRIOR structure,
                                    int rep)
                             throws HL7Exception
```
    Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBSERVATION_PRIOR
```
public OMQ_O42_OBSERVATION_PRIOR insertOBSERVATION_PRIOR(int rep)
                                                  throws HL7Exception
```
    Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBSERVATION_PRIOR
```
public OMQ_O42_OBSERVATION_PRIOR removeOBSERVATION_PRIOR(int rep)
                                                  throws HL7Exception
```
    Removes a specific repetition of OBSERVATION_PRIOR (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class OMQ_O42_ORDER_PRIOR

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

OMQ_O42_ORDER_PRIOR

Method Detail

getVersion

getORC

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getOBR

getTIMING_PRIOR

getTIMING_PRIOR

getTIMING_PRIORReps

getTIMING_PRIORAll

insertTIMING_PRIOR

insertTIMING_PRIOR

removeTIMING_PRIOR

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getPRT2

getPRT2

getPRT2Reps

getPRT2All

insertPRT2

insertPRT2

removePRT2

getCTD

getOBSERVATION_PRIOR

getOBSERVATION_PRIOR

getOBSERVATION_PRIORReps

getOBSERVATION_PRIORAll

insertOBSERVATION_PRIOR

insertOBSERVATION_PRIOR

removeOBSERVATION_PRIOR