ORM_O01_ORDER_DETAIL (HAPI - Java HL7 API - Generated Structures v2.5 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v25.group.ORM_O01_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class ORM_O01_ORDER_DETAIL
extends AbstractGroup
```
Represents a ORM_O01_ORDER_DETAIL 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: OBR (Observation Request) choice
- 2: RQD (Requisition Detail) choice
- 3: RQ1 (Requisition Detail-1) choice
- 4: RXO (Pharmacy/Treatment Order) choice
- 5: ODS (Dietary Orders, Supplements, and Preferences) choice
- 6: ODT (Diet Tray Instructions) choice
- 7: NTE (Notes and Comments) optional repeating
- 8: CTD (Contact Data) optional
- 9: DG1 (Diagnosis) optional repeating
- 10: ORM_O01_OBSERVATION (a Group object) 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

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

Constructors
Constructor and Description
`ORM_O01_ORDER_DETAIL(Group parent, ModelClassFactory factory)` Creates a new ORM_O01_ORDER_DETAIL 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
`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
`ORM_O01_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`ORM_O01_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<ORM_O01_OBSERVATION>`	`getOBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
`int`	`getOBSERVATIONReps()` Returns the number of existing repetitions of OBSERVATION
`ODS`	`getODS()` Returns ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
`ODT`	`getODT()` Returns ODT (Diet Tray Instructions) - 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
`String`	`getVersion()` Returns "2.5"
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (Diagnosis)
`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)
`ORM_O01_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertOBSERVATION(ORM_O01_OBSERVATION structure, int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (Diagnosis)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`ORM_O01_OBSERVATION`	`removeOBSERVATION(int rep)` Removes a specific repetition of OBSERVATION (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
  - ORM_O01_ORDER_DETAIL
```
public ORM_O01_ORDER_DETAIL(Group parent,
                            ModelClassFactory factory)
```
    Creates a new ORM_O01_ORDER_DETAIL group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5"
  - 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)
  - 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 ORM_O01_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public ORM_O01_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<ORM_O01_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(ORM_O01_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 ORM_O01_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 ORM_O01_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class ORM_O01_ORDER_DETAIL

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

ORM_O01_ORDER_DETAIL

Method Detail

getVersion

getOBR

getRQD

getRQ1

getRXO

getODS

getODT

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getCTD

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION