CQU_I19_MEDICATION_HISTORY (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.CQU_I19_MEDICATION_HISTORY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class CQU_I19_MEDICATION_HISTORY
extends AbstractGroup
```
Represents a CQU_I19_MEDICATION_HISTORY 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: CQU_I19_MEDICATION_ORDER_DETAIL (a Group object) optional
- 3: CQU_I19_MEDICATION_ENCODING_DETAIL (a Group object) optional
- 4: CQU_I19_MEDICATION_ADMINISTRATION_DETAIL (a Group object) optional repeating
- 5: CTI (Clinical Trial Identification) optional repeating
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete 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
`CQU_I19_MEDICATION_ADMINISTRATION_DETAIL`	`getMEDICATION_ADMINISTRATION_DETAIL()` Returns the first repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object) - creates it if necessary
`CQU_I19_MEDICATION_ADMINISTRATION_DETAIL`	`getMEDICATION_ADMINISTRATION_DETAIL(int rep)` Returns a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object) - creates it if necessary
`List<CQU_I19_MEDICATION_ADMINISTRATION_DETAIL>`	`getMEDICATION_ADMINISTRATION_DETAILAll()` Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ADMINISTRATION_DETAIL.
`int`	`getMEDICATION_ADMINISTRATION_DETAILReps()` Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_DETAIL
`CQU_I19_MEDICATION_ENCODING_DETAIL`	`getMEDICATION_ENCODING_DETAIL()` Returns MEDICATION_ENCODING_DETAIL (a Group object) - creates it if necessary
`CQU_I19_MEDICATION_ORDER_DETAIL`	`getMEDICATION_ORDER_DETAIL()` Returns MEDICATION_ORDER_DETAIL (a Group object) - creates it if necessary
`ORC`	`getORC()` Returns ORC (Common Order) - creates it if necessary
`String`	`getVersion()` Returns "2.8.1"
`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)
`void`	`insertMEDICATION_ADMINISTRATION_DETAIL(CQU_I19_MEDICATION_ADMINISTRATION_DETAIL structure, int rep)` Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
`CQU_I19_MEDICATION_ADMINISTRATION_DETAIL`	`insertMEDICATION_ADMINISTRATION_DETAIL(int rep)` Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
`CTI`	`removeCTI(int rep)` Removes a specific repetition of CTI (Clinical Trial Identification)
`CQU_I19_MEDICATION_ADMINISTRATION_DETAIL`	`removeMEDICATION_ADMINISTRATION_DETAIL(int rep)` Removes a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (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
  - CQU_I19_MEDICATION_HISTORY
```
public CQU_I19_MEDICATION_HISTORY(Group parent,
                                  ModelClassFactory factory)
```
    Creates a new CQU_I19_MEDICATION_HISTORY group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8.1"
  - getORC
```
public ORC getORC()
```
    Returns ORC (Common Order) - creates it if necessary
  - getMEDICATION_ORDER_DETAIL
```
public CQU_I19_MEDICATION_ORDER_DETAIL getMEDICATION_ORDER_DETAIL()
```
    Returns MEDICATION_ORDER_DETAIL (a Group object) - creates it if necessary
  - getMEDICATION_ENCODING_DETAIL
```
public CQU_I19_MEDICATION_ENCODING_DETAIL getMEDICATION_ENCODING_DETAIL()
```
    Returns MEDICATION_ENCODING_DETAIL (a Group object) - creates it if necessary
  - getMEDICATION_ADMINISTRATION_DETAIL
```
public CQU_I19_MEDICATION_ADMINISTRATION_DETAIL getMEDICATION_ADMINISTRATION_DETAIL()
```
    Returns the first repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object) - creates it if necessary
  - getMEDICATION_ADMINISTRATION_DETAIL
```
public CQU_I19_MEDICATION_ADMINISTRATION_DETAIL getMEDICATION_ADMINISTRATION_DETAIL(int rep)
```
    Returns a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (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.
  - getMEDICATION_ADMINISTRATION_DETAILReps
```
public int getMEDICATION_ADMINISTRATION_DETAILReps()
```
    Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_DETAIL
  - getMEDICATION_ADMINISTRATION_DETAILAll
```
public List<CQU_I19_MEDICATION_ADMINISTRATION_DETAIL> getMEDICATION_ADMINISTRATION_DETAILAll()
                                                                                      throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ADMINISTRATION_DETAIL.
    
    Note that unlike getMEDICATION_ADMINISTRATION_DETAIL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertMEDICATION_ADMINISTRATION_DETAIL
```
public void insertMEDICATION_ADMINISTRATION_DETAIL(CQU_I19_MEDICATION_ADMINISTRATION_DETAIL structure,
                                                   int rep)
                                            throws HL7Exception
```
    Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertMEDICATION_ADMINISTRATION_DETAIL
```
public CQU_I19_MEDICATION_ADMINISTRATION_DETAIL insertMEDICATION_ADMINISTRATION_DETAIL(int rep)
                                                                                throws HL7Exception
```
    Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeMEDICATION_ADMINISTRATION_DETAIL
```
public CQU_I19_MEDICATION_ADMINISTRATION_DETAIL removeMEDICATION_ADMINISTRATION_DETAIL(int rep)
                                                                                throws HL7Exception
```
    Removes a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
    
    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 CQU_I19_MEDICATION_HISTORY

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

CQU_I19_MEDICATION_HISTORY

Method Detail

getVersion

getORC

getMEDICATION_ORDER_DETAIL

getMEDICATION_ENCODING_DETAIL

getMEDICATION_ADMINISTRATION_DETAIL

getMEDICATION_ADMINISTRATION_DETAIL

getMEDICATION_ADMINISTRATION_DETAILReps

getMEDICATION_ADMINISTRATION_DETAILAll

insertMEDICATION_ADMINISTRATION_DETAIL

insertMEDICATION_ADMINISTRATION_DETAIL

removeMEDICATION_ADMINISTRATION_DETAIL

getCTI

getCTI

getCTIReps

getCTIAll

insertCTI

insertCTI

removeCTI