RSP_K31_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.RSP_K31_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class RSP_K31_ORDER
extends AbstractGroup
```
Represents a RSP_K31_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: RSP_K31_TIMING (a Group object) optional repeating
- 4: RSP_K31_ORDER_DETAIL (a Group object) optional
- 5: RSP_K31_ENCODING (a Group object) optional
- 6: RXD (Pharmacy/Treatment Dispense)
- 7: PRT (Participation Information) optional repeating
- 8: RXR (Pharmacy/Treatment Route) repeating
- 9: RXC (Pharmacy/Treatment Component Order) optional repeating
- 10: CDO (Cumulative Dosage) optional repeating
- 11: RSP_K31_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

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CDO`	`getCDO()` Returns the first repetition of CDO (Cumulative Dosage) - creates it if necessary
`CDO`	`getCDO(int rep)` Returns a specific repetition of CDO (Cumulative Dosage) - creates it if necessary
`List<CDO>`	`getCDOAll()` Returns a non-modifiable List containing all current existing repetitions of CDO.
`int`	`getCDOReps()` Returns the number of existing repetitions of CDO
`RSP_K31_ENCODING`	`getENCODING()` Returns ENCODING (a Group object) - creates it if necessary
`RSP_K31_OBSERVATION`	`getOBSERVATION()` Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
`RSP_K31_OBSERVATION`	`getOBSERVATION(int rep)` Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
`List<RSP_K31_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
`RSP_K31_ORDER_DETAIL`	`getORDER_DETAIL()` Returns ORDER_DETAIL (a Group object) - 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
`RXC`	`getRXC()` Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
`RXC`	`getRXC(int rep)` Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
`List<RXC>`	`getRXCAll()` Returns a non-modifiable List containing all current existing repetitions of RXC.
`int`	`getRXCReps()` Returns the number of existing repetitions of RXC
`RXD`	`getRXD()` Returns RXD (Pharmacy/Treatment Dispense) - creates it if necessary
`RXR`	`getRXR()` Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
`RXR`	`getRXR(int rep)` Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
`List<RXR>`	`getRXRAll()` Returns a non-modifiable List containing all current existing repetitions of RXR.
`int`	`getRXRReps()` Returns the number of existing repetitions of RXR
`RSP_K31_TIMING`	`getTIMING()` Returns the first repetition of TIMING (a Group object) - creates it if necessary
`RSP_K31_TIMING`	`getTIMING(int rep)` Returns a specific repetition of TIMING (a Group object) - creates it if necessary
`List<RSP_K31_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`	`insertCDO(CDO structure, int rep)` Inserts a specific repetition of CDO (Cumulative Dosage)
`CDO`	`insertCDO(int rep)` Inserts a specific repetition of CDO (Cumulative Dosage)
`RSP_K31_OBSERVATION`	`insertOBSERVATION(int rep)` Inserts a specific repetition of OBSERVATION (a Group object)
`void`	`insertOBSERVATION(RSP_K31_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)
`RXC`	`insertRXC(int rep)` Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
`void`	`insertRXC(RXC structure, int rep)` Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
`RXR`	`insertRXR(int rep)` Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
`void`	`insertRXR(RXR structure, int rep)` Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
`RSP_K31_TIMING`	`insertTIMING(int rep)` Inserts a specific repetition of TIMING (a Group object)
`void`	`insertTIMING(RSP_K31_TIMING structure, int rep)` Inserts a specific repetition of TIMING (a Group object)
`CDO`	`removeCDO(int rep)` Removes a specific repetition of CDO (Cumulative Dosage)
`RSP_K31_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)
`RXC`	`removeRXC(int rep)` Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
`RXR`	`removeRXR(int rep)` Removes a specific repetition of RXR (Pharmacy/Treatment Route)
`RSP_K31_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
  - RSP_K31_ORDER
```
public RSP_K31_ORDER(Group parent,
                     ModelClassFactory factory)
```
    Creates a new RSP_K31_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 RSP_K31_TIMING getTIMING()
```
    Returns the first repetition of TIMING (a Group object) - creates it if necessary
  - getTIMING
```
public RSP_K31_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<RSP_K31_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(RSP_K31_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 RSP_K31_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 RSP_K31_TIMING removeTIMING(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of TIMING (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getORDER_DETAIL
```
public RSP_K31_ORDER_DETAIL getORDER_DETAIL()
```
    Returns ORDER_DETAIL (a Group object) - creates it if necessary
  - getENCODING
```
public RSP_K31_ENCODING getENCODING()
```
    Returns ENCODING (a Group object) - creates it if necessary
  - getRXD
```
public RXD getRXD()
```
    Returns RXD (Pharmacy/Treatment Dispense) - creates it if necessary
  - 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)
  - getRXR
```
public RXR getRXR()
```
    Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
  - getRXR
```
public RXR getRXR(int rep)
```
    Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.
  - getRXRReps
```
public int getRXRReps()
```
    Returns the number of existing repetitions of RXR
  - getRXRAll
```
public List<RXR> getRXRAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RXR.
    
    Note that unlike getRXR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRXR
```
public void insertRXR(RXR structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRXR
```
public RXR insertRXR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRXR
```
public RXR removeRXR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RXR (Pharmacy/Treatment Route)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getRXC
```
public RXC getRXC()
```
    Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
  - getRXC
```
public RXC getRXC(int rep)
```
    Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.
  - getRXCReps
```
public int getRXCReps()
```
    Returns the number of existing repetitions of RXC
  - getRXCAll
```
public List<RXC> getRXCAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of RXC.
    
    Note that unlike getRXC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertRXC
```
public void insertRXC(RXC structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertRXC
```
public RXC insertRXC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeRXC
```
public RXC removeRXC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getCDO
```
public CDO getCDO()
```
    Returns the first repetition of CDO (Cumulative Dosage) - creates it if necessary
  - getCDO
```
public CDO getCDO(int rep)
```
    Returns a specific repetition of CDO (Cumulative Dosage) - 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.
  - getCDOReps
```
public int getCDOReps()
```
    Returns the number of existing repetitions of CDO
  - getCDOAll
```
public List<CDO> getCDOAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of CDO.
    
    Note that unlike getCDO(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertCDO
```
public void insertCDO(CDO structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertCDO
```
public CDO insertCDO(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeCDO
```
public CDO removeCDO(int rep)
              throws HL7Exception
```
    Removes a specific repetition of CDO (Cumulative Dosage)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBSERVATION
```
public RSP_K31_OBSERVATION getOBSERVATION()
```
    Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
  - getOBSERVATION
```
public RSP_K31_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<RSP_K31_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(RSP_K31_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 RSP_K31_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 RSP_K31_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception
```
    Removes a specific repetition of OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

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

RSP_K31_ORDER

Method Detail

getVersion

getORC

getPRT

getPRT

getPRTReps

getPRTAll

insertPRT

insertPRT

removePRT

getTIMING

getTIMING

getTIMINGReps

getTIMINGAll

insertTIMING

insertTIMING

removeTIMING

getORDER_DETAIL

getENCODING

getRXD

getPRT2

getPRT2

getPRT2Reps

getPRT2All

insertPRT2

insertPRT2

removePRT2

getRXR

getRXR

getRXRReps

getRXRAll

insertRXR

insertRXR

removeRXR

getRXC

getRXC

getRXCReps

getRXCAll

insertRXC

insertRXC

removeRXC

getCDO

getCDO

getCDOReps

getCDOAll

insertCDO

insertCDO

removeCDO

getOBSERVATION

getOBSERVATION

getOBSERVATIONReps

getOBSERVATIONAll

insertOBSERVATION

insertOBSERVATION

removeOBSERVATION