DFT_P03_COMMON_ORDER (HAPI - Java HL7 API - Generated Structures v2.5.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v251.group.DFT_P03_COMMON_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class DFT_P03_COMMON_ORDER
extends AbstractGroup
```
Represents a DFT_P03_COMMON_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) optional
- 2: DFT_P03_TIMING_QUANTITY (a Group object) optional repeating
- 3: DFT_P03_ORDER (a Group object) optional
- 4: DFT_P03_OBSERVATION (a Group object) optional repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DFT_P03_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`DFT_P03_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<DFT_P03_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
`DFT_P03_ORDER`	`getORDER()` Returns ORDER (a Group object) - creates it if necessary
`DFT_P03_TIMING_QUANTITY`	`getTIMING_QUANTITY()` Returns the first repetition of TIMING_QUANTITY (a Group object) - creates it if necessary
`DFT_P03_TIMING_QUANTITY`	`getTIMING_QUANTITY(int rep)` Returns a specific repetition of TIMING_QUANTITY (a Group object) - creates it if necessary
`List<DFT_P03_TIMING_QUANTITY>`	`getTIMING_QUANTITYAll()` Returns a non-modifiable List containing all current existing repetitions of TIMING_QUANTITY.
`int`	`getTIMING_QUANTITYReps()` Returns the number of existing repetitions of TIMING_QUANTITY
`String`	`getVersion()` Returns "2.5.1"
`void`	`insertOBSERVATION(DFT_P03_OBSERVATION structure, int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`DFT_P03_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertTIMING_QUANTITY(DFT_P03_TIMING_QUANTITY structure, int rep)` Inserts a specific repetition of TIMING_QUANTITY (a Group object)
`DFT_P03_TIMING_QUANTITY`	`insertTIMING_QUANTITY(int rep)` Inserts a specific repetition of TIMING_QUANTITY (a Group object)
`DFT_P03_OBSERVATION`	`removeOBSERVATION(int rep)` Removes a specific repetition of OBSERVATION (a Group object)
`DFT_P03_TIMING_QUANTITY`	`removeTIMING_QUANTITY(int rep)` Removes a specific repetition of TIMING_QUANTITY (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
  - DFT_P03_COMMON_ORDER
```
public DFT_P03_COMMON_ORDER(Group parent,
                            ModelClassFactory factory)
```
    Creates a new DFT_P03_COMMON_ORDER group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5.1"
  - getORC
```
public ORC getORC()
```
    Returns ORC (Common Order) - creates it if necessary
  - getTIMING_QUANTITY
```
public DFT_P03_TIMING_QUANTITY getTIMING_QUANTITY()
```
    Returns the first repetition of TIMING_QUANTITY (a Group object) - creates it if necessary
  - getTIMING_QUANTITY
```
public DFT_P03_TIMING_QUANTITY getTIMING_QUANTITY(int rep)
```
    Returns a specific repetition of TIMING_QUANTITY (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_QUANTITYReps
```
public int getTIMING_QUANTITYReps()
```
    Returns the number of existing repetitions of TIMING_QUANTITY
  - getTIMING_QUANTITYAll
```
public List<DFT_P03_TIMING_QUANTITY> getTIMING_QUANTITYAll()
                                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of TIMING_QUANTITY.
    
    Note that unlike getTIMING_QUANTITY(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertTIMING_QUANTITY
```
public void insertTIMING_QUANTITY(DFT_P03_TIMING_QUANTITY structure,
                                  int rep)
                           throws HL7Exception
```
    Inserts a specific repetition of TIMING_QUANTITY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertTIMING_QUANTITY
```
public DFT_P03_TIMING_QUANTITY insertTIMING_QUANTITY(int rep)
                                              throws HL7Exception
```
    Inserts a specific repetition of TIMING_QUANTITY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeTIMING_QUANTITY
```
public DFT_P03_TIMING_QUANTITY removeTIMING_QUANTITY(int rep)
                                              throws HL7Exception
```
    Removes a specific repetition of TIMING_QUANTITY (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getORDER
```
public DFT_P03_ORDER getORDER()
```
    Returns ORDER (a Group object) - creates it if necessary
  - getOBSERVATION
```
public DFT_P03_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public DFT_P03_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<DFT_P03_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(DFT_P03_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 DFT_P03_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 DFT_P03_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

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

DFT_P03_COMMON_ORDER

Method Detail

getVersion

getORC

getTIMING_QUANTITY

getTIMING_QUANTITY

getTIMING_QUANTITYReps

getTIMING_QUANTITYAll

insertTIMING_QUANTITY

insertTIMING_QUANTITY

removeTIMING_QUANTITY

getORDER

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION