DRC_O47_DONOR (HAPI - Java HL7 API - Generated Structures v2.8 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v28.group.DRC_O47_DONOR

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class DRC_O47_DONOR
extends AbstractGroup
```
Represents a DRC_O47_DONOR 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: PID (Patient Identification)
- 2: PD1 (Patient Additional Demographic) optional
- 3: OBX (Observation/Result) optional repeating
- 4: NTE (Notes and Comments) optional repeating
- 5: AL1 (Patient Allergy Information) optional repeating
- 6: ARV (Access Restriction) optional repeating
- 7: DRC_O47_DONOR_REGISTRATION (a Group object) optional
See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AL1`	`getAL1()` Returns the first repetition of AL1 (Patient Allergy Information) - creates it if necessary
`AL1`	`getAL1(int rep)` Returns a specific repetition of AL1 (Patient Allergy Information) - creates it if necessary
`List<AL1>`	`getAL1All()` Returns a non-modifiable List containing all current existing repetitions of AL1.
`int`	`getAL1Reps()` Returns the number of existing repetitions of AL1
`ARV`	`getARV()` Returns the first repetition of ARV (Access Restriction) - creates it if necessary
`ARV`	`getARV(int rep)` Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
`List<ARV>`	`getARVAll()` Returns a non-modifiable List containing all current existing repetitions of ARV.
`int`	`getARVReps()` Returns the number of existing repetitions of ARV
`DRC_O47_DONOR_REGISTRATION`	`getDONOR_REGISTRATION()` Returns DONOR_REGISTRATION (a Group object) - creates it if necessary
`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
`OBX`	`getOBX()` Returns the first repetition of OBX (Observation/Result) - creates it if necessary
`OBX`	`getOBX(int rep)` Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
`List<OBX>`	`getOBXAll()` Returns a non-modifiable List containing all current existing repetitions of OBX.
`int`	`getOBXReps()` Returns the number of existing repetitions of OBX
`PD1`	`getPD1()` Returns PD1 (Patient Additional Demographic) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`String`	`getVersion()` Returns "2.8"
`void`	`insertAL1(AL1 structure, int rep)` Inserts a specific repetition of AL1 (Patient Allergy Information)
`AL1`	`insertAL1(int rep)` Inserts a specific repetition of AL1 (Patient Allergy Information)
`void`	`insertARV(ARV structure, int rep)` Inserts a specific repetition of ARV (Access Restriction)
`ARV`	`insertARV(int rep)` Inserts a specific repetition of ARV (Access Restriction)
`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)
`OBX`	`insertOBX(int rep)` Inserts a specific repetition of OBX (Observation/Result)
`void`	`insertOBX(OBX structure, int rep)` Inserts a specific repetition of OBX (Observation/Result)
`AL1`	`removeAL1(int rep)` Removes a specific repetition of AL1 (Patient Allergy Information)
`ARV`	`removeARV(int rep)` Removes a specific repetition of ARV (Access Restriction)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`OBX`	`removeOBX(int rep)` Removes a specific repetition of OBX (Observation/Result)

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
  - DRC_O47_DONOR
```
public DRC_O47_DONOR(Group parent,
                     ModelClassFactory factory)
```
    Creates a new DRC_O47_DONOR group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.8"
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getPD1
```
public PD1 getPD1()
```
    Returns PD1 (Patient Additional Demographic) - creates it if necessary
  - getOBX
```
public OBX getOBX()
```
    Returns the first repetition of OBX (Observation/Result) - creates it if necessary
  - getOBX
```
public OBX getOBX(int rep)
```
    Returns a specific repetition of OBX (Observation/Result) - 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.
  - getOBXReps
```
public int getOBXReps()
```
    Returns the number of existing repetitions of OBX
  - getOBXAll
```
public List<OBX> getOBXAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBX.
    
    Note that unlike getOBX(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBX
```
public void insertOBX(OBX structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBX
```
public OBX insertOBX(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBX
```
public OBX removeOBX(int rep)
              throws HL7Exception
```
    Removes a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - 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)
  - getAL1
```
public AL1 getAL1()
```
    Returns the first repetition of AL1 (Patient Allergy Information) - creates it if necessary
  - getAL1
```
public AL1 getAL1(int rep)
```
    Returns a specific repetition of AL1 (Patient Allergy 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.
  - getAL1Reps
```
public int getAL1Reps()
```
    Returns the number of existing repetitions of AL1
  - getAL1All
```
public List<AL1> getAL1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of AL1.
    
    Note that unlike getAL1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertAL1
```
public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertAL1
```
public AL1 insertAL1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeAL1
```
public AL1 removeAL1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of AL1 (Patient Allergy Information)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getARV
```
public ARV getARV()
```
    Returns the first repetition of ARV (Access Restriction) - creates it if necessary
  - getARV
```
public ARV getARV(int rep)
```
    Returns a specific repetition of ARV (Access Restriction) - 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.
  - getARVReps
```
public int getARVReps()
```
    Returns the number of existing repetitions of ARV
  - getARVAll
```
public List<ARV> getARVAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ARV.
    
    Note that unlike getARV(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertARV
```
public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertARV
```
public ARV insertARV(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeARV
```
public ARV removeARV(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ARV (Access Restriction)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getDONOR_REGISTRATION
```
public DRC_O47_DONOR_REGISTRATION getDONOR_REGISTRATION()
```
    Returns DONOR_REGISTRATION (a Group object) - creates it if necessary

Class DRC_O47_DONOR

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

DRC_O47_DONOR

Method Detail

getVersion

getPID

getPD1

getOBX

getOBX

getOBXReps

getOBXAll

insertOBX

insertOBX

removeOBX

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getAL1

getAL1

getAL1Reps

getAL1All

insertAL1

insertAL1

removeAL1

getARV

getARV

getARVReps

getARVAll

insertARV

insertARV

removeARV

getDONOR_REGISTRATION