PRR_PC5_ORDER_DETAIL (HAPI - Java HL7 API - Generated Structures v2.7 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v27.group.PRR_PC5_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class PRR_PC5_ORDER_DETAIL
extends AbstractGroup
```
Represents a PRR_PC5_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: Hxx (any HL7 segment) choice
- 3: NTE (Notes and Comments) optional repeating
- 4: VAR (Variance) optional repeating
- 5: PRR_PC5_ORDER_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

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Hxx`	`getHxx()` Returns Hxx (any HL7 segment) - 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
`OBR`	`getOBR()` Returns OBR (Observation Request) - creates it if necessary
`PRR_PC5_ORDER_OBSERVATION`	`getORDER_OBSERVATION()` Returns the first repetition of ORDER_OBSERVATION (a Group object) - creates it if necessary
`PRR_PC5_ORDER_OBSERVATION`	`getORDER_OBSERVATION(int rep)` Returns a specific repetition of ORDER_OBSERVATION (a Group object) - creates it if necessary
`List<PRR_PC5_ORDER_OBSERVATION>`	`getORDER_OBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of ORDER_OBSERVATION.
`int`	`getORDER_OBSERVATIONReps()` Returns the number of existing repetitions of ORDER_OBSERVATION
`VAR`	`getVAR()` Returns the first repetition of VAR (Variance) - creates it if necessary
`VAR`	`getVAR(int rep)` Returns a specific repetition of VAR (Variance) - creates it if necessary
`List<VAR>`	`getVARAll()` Returns a non-modifiable List containing all current existing repetitions of VAR.
`int`	`getVARReps()` Returns the number of existing repetitions of VAR
`String`	`getVersion()` Returns "2.7"
`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)
`PRR_PC5_ORDER_OBSERVATION`	`insertORDER_OBSERVATION(int rep)` Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
`void`	`insertORDER_OBSERVATION(PRR_PC5_ORDER_OBSERVATION structure, int rep)` Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
`VAR`	`insertVAR(int rep)` Inserts a specific repetition of VAR (Variance)
`void`	`insertVAR(VAR structure, int rep)` Inserts a specific repetition of VAR (Variance)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`PRR_PC5_ORDER_OBSERVATION`	`removeORDER_OBSERVATION(int rep)` Removes a specific repetition of ORDER_OBSERVATION (a Group object)
`VAR`	`removeVAR(int rep)` Removes a specific repetition of VAR (Variance)

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
  - PRR_PC5_ORDER_DETAIL
```
public PRR_PC5_ORDER_DETAIL(Group parent,
                            ModelClassFactory factory)
```
    Creates a new PRR_PC5_ORDER_DETAIL group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.7"
  - getOBR
```
public OBR getOBR()
```
    Returns OBR (Observation Request) - creates it if necessary
  - getHxx
```
public Hxx getHxx()
```
    Returns Hxx (any HL7 segment) - 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)
  - getVAR
```
public VAR getVAR()
```
    Returns the first repetition of VAR (Variance) - creates it if necessary
  - getVAR
```
public VAR getVAR(int rep)
```
    Returns a specific repetition of VAR (Variance) - 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.
  - getVARReps
```
public int getVARReps()
```
    Returns the number of existing repetitions of VAR
  - getVARAll
```
public List<VAR> getVARAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of VAR.
    
    Note that unlike getVAR(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertVAR
```
public void insertVAR(VAR structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of VAR (Variance)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertVAR
```
public VAR insertVAR(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of VAR (Variance)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeVAR
```
public VAR removeVAR(int rep)
              throws HL7Exception
```
    Removes a specific repetition of VAR (Variance)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getORDER_OBSERVATION
```
public PRR_PC5_ORDER_OBSERVATION getORDER_OBSERVATION()
```
    Returns the first repetition of ORDER_OBSERVATION (a Group object) - creates it if necessary
  - getORDER_OBSERVATION
```
public PRR_PC5_ORDER_OBSERVATION getORDER_OBSERVATION(int rep)
```
    Returns a specific repetition of ORDER_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.
  - getORDER_OBSERVATIONReps
```
public int getORDER_OBSERVATIONReps()
```
    Returns the number of existing repetitions of ORDER_OBSERVATION
  - getORDER_OBSERVATIONAll
```
public List<PRR_PC5_ORDER_OBSERVATION> getORDER_OBSERVATIONAll()
                                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ORDER_OBSERVATION.
    
    Note that unlike getORDER_OBSERVATION(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertORDER_OBSERVATION
```
public void insertORDER_OBSERVATION(PRR_PC5_ORDER_OBSERVATION structure,
                                    int rep)
                             throws HL7Exception
```
    Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertORDER_OBSERVATION
```
public PRR_PC5_ORDER_OBSERVATION insertORDER_OBSERVATION(int rep)
                                                  throws HL7Exception
```
    Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeORDER_OBSERVATION
```
public PRR_PC5_ORDER_OBSERVATION removeORDER_OBSERVATION(int rep)
                                                  throws HL7Exception
```
    Removes a specific repetition of ORDER_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

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

PRR_PC5_ORDER_DETAIL

Method Detail

getVersion

getOBR

getHxx

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getVAR

getVAR

getVARReps

getVARAll

insertVAR

insertVAR

removeVAR

getORDER_OBSERVATION

getORDER_OBSERVATION

getORDER_OBSERVATIONReps

getORDER_OBSERVATIONAll

insertORDER_OBSERVATION

insertORDER_OBSERVATION

removeORDER_OBSERVATION