OSR_Q06_ORDER (HAPI - Java HL7 API - Generated Structures v2.6 2.2 API)

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

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class OSR_Q06_ORDER
extends AbstractGroup
```
Represents a OSR_Q06_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: OSR_Q06_TIMING (a Group object) optional repeating
- 3: OBR (Observation Request) choice
- 4: RQD (Requisition Detail) choice
- 5: RQ1 (Requisition Detail-1) choice
- 6: RXO (Pharmacy/Treatment Order) choice
- 7: ODS (Dietary Orders, Supplements, and Preferences) choice
- 8: ODT (Diet Tray Instructions) choice
- 9: NTE (Notes and Comments) optional repeating
- 10: CTI (Clinical Trial Identification) optional repeating
Note that this structure has "choice" elements. This means that one of the structures above marked as "choice" must be present, but no more than one.
See Also:
Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

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
`ODS`	`getODS()` Returns ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
`ODT`	`getODT()` Returns ODT (Diet Tray Instructions) - creates it if necessary
`ORC`	`getORC()` Returns ORC (Common Order) - creates it if necessary
`RQ1`	`getRQ1()` Returns RQ1 (Requisition Detail-1) - creates it if necessary
`RQD`	`getRQD()` Returns RQD (Requisition Detail) - creates it if necessary
`RXO`	`getRXO()` Returns RXO (Pharmacy/Treatment Order) - creates it if necessary
`OSR_Q06_TIMING`	`getTIMING()` Returns the first repetition of TIMING (a Group object) - creates it if necessary
`OSR_Q06_TIMING`	`getTIMING(int rep)` Returns a specific repetition of TIMING (a Group object) - creates it if necessary
`List<OSR_Q06_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"
`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)
`OSR_Q06_TIMING`	`insertTIMING(int rep)` Inserts a specific repetition of TIMING (a Group object)
`void`	`insertTIMING(OSR_Q06_TIMING structure, int rep)` Inserts a specific repetition of TIMING (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)
`OSR_Q06_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
  - OSR_Q06_ORDER
```
public OSR_Q06_ORDER(Group parent,
             ModelClassFactory factory)
```
    Creates a new OSR_Q06_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 OSR_Q06_TIMING getTIMING()
```
    Returns the first repetition of TIMING (a Group object) - creates it if necessary
  - getTIMING
```
public OSR_Q06_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<OSR_Q06_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(OSR_Q06_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 OSR_Q06_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 OSR_Q06_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
  - getRQD
```
public RQD getRQD()
```
    Returns RQD (Requisition Detail) - creates it if necessary
  - getRQ1
```
public RQ1 getRQ1()
```
    Returns RQ1 (Requisition Detail-1) - creates it if necessary
  - getRXO
```
public RXO getRXO()
```
    Returns RXO (Pharmacy/Treatment Order) - creates it if necessary
  - getODS
```
public ODS getODS()
```
    Returns ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
  - getODT
```
public ODT getODT()
```
    Returns ODT (Diet Tray Instructions) - 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)
  - 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 OSR_Q06_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

OSR_Q06_ORDER

Method Detail

getVersion

getORC

getTIMING

getTIMING

getTIMINGReps

getTIMINGAll

insertTIMING

insertTIMING

removeTIMING

getOBR

getRQD

getRQ1

getRXO

getODS

getODT

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getCTI

getCTI

getCTIReps

getCTIAll

insertCTI

insertCTI

removeCTI