DFT_P03 (HAPI - Java HL7 API - Generated Structures v2.3.1 2.2 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v231.message.DFT_P03

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable
```
public class DFT_P03
extends AbstractMessage
```
Represents a DFT_P03 message structure (see chapter ?). This structure contains the following elements:
- 1: MSH (MSH - message header segment)
- 2: EVN (EVN - event type segment)
- 3: PID (PID - patient identification segment)
- 4: PD1 (PD1 - patient additional demographic segment) optional
- 5: PV1 (PV1 - patient visit segment-) optional
- 6: PV2 (PV2 - patient visit - additional information segment) optional
- 7: DB1 (DB1 - Disability segment) optional repeating
- 8: OBX (OBX - observation/result segment) optional repeating
- 9: DFT_P03_FT1PR1ROL (a Group object) repeating
- 10: DG1 (DG1 - diagnosis segment) optional repeating
- 11: DRG (DRG - diagnosis related group segment) optional
- 12: GT1 (GT1 - guarantor segment) optional repeating
- 13: DFT_P03_IN1IN2IN3 (a Group object) optional repeating
- 14: ACC (ACC - accident segment) optional
See Also:
Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`DFT_P03()` Creates a new DFT_P03 message with DefaultModelClassFactory.
`DFT_P03(ModelClassFactory factory)` Creates a new DFT_P03 message with custom ModelClassFactory.

Method Summary

Methods
Modifier and Type	Method and Description
`ACC`	`getACC()` Returns ACC (ACC - accident segment) - creates it if necessary
`DB1`	`getDB1()` Returns the first repetition of DB1 (DB1 - Disability segment) - creates it if necessary
`DB1`	`getDB1(int rep)` Returns a specific repetition of DB1 (DB1 - Disability segment) - creates it if necessary
`List<DB1>`	`getDB1All()` Returns a non-modifiable List containing all current existing repetitions of DB1.
`int`	`getDB1Reps()` Returns the number of existing repetitions of DB1
`DG1`	`getDG1()` Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
`DG1`	`getDG1(int rep)` Returns a specific repetition of DG1 (DG1 - diagnosis segment) - 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
`DRG`	`getDRG()` Returns DRG (DRG - diagnosis related group segment) - creates it if necessary
`EVN`	`getEVN()` Returns EVN (EVN - event type segment) - creates it if necessary
`DFT_P03_FT1PR1ROL`	`getFT1PR1ROL()` Returns the first repetition of FT1PR1ROL (a Group object) - creates it if necessary
`DFT_P03_FT1PR1ROL`	`getFT1PR1ROL(int rep)` Returns a specific repetition of FT1PR1ROL (a Group object) - creates it if necessary
`List<DFT_P03_FT1PR1ROL>`	`getFT1PR1ROLAll()` Returns a non-modifiable List containing all current existing repetitions of FT1PR1ROL.
`int`	`getFT1PR1ROLReps()` Returns the number of existing repetitions of FT1PR1ROL
`GT1`	`getGT1()` Returns the first repetition of GT1 (GT1 - guarantor segment) - creates it if necessary
`GT1`	`getGT1(int rep)` Returns a specific repetition of GT1 (GT1 - guarantor segment) - creates it if necessary
`List<GT1>`	`getGT1All()` Returns a non-modifiable List containing all current existing repetitions of GT1.
`int`	`getGT1Reps()` Returns the number of existing repetitions of GT1
`DFT_P03_IN1IN2IN3`	`getIN1IN2IN3()` Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
`DFT_P03_IN1IN2IN3`	`getIN1IN2IN3(int rep)` Returns a specific repetition of IN1IN2IN3 (a Group object) - creates it if necessary
`List<DFT_P03_IN1IN2IN3>`	`getIN1IN2IN3All()` Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
`int`	`getIN1IN2IN3Reps()` Returns the number of existing repetitions of IN1IN2IN3
`MSH`	`getMSH()` Returns MSH (MSH - message header segment) - creates it if necessary
`OBX`	`getOBX()` Returns the first repetition of OBX (OBX - observation/result segment) - creates it if necessary
`OBX`	`getOBX(int rep)` Returns a specific repetition of OBX (OBX - observation/result segment) - 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 (PD1 - patient additional demographic segment) - creates it if necessary
`PID`	`getPID()` Returns PID (PID - patient identification segment) - creates it if necessary
`PV1`	`getPV1()` Returns PV1 (PV1 - patient visit segment-) - creates it if necessary
`PV2`	`getPV2()` Returns PV2 (PV2 - patient visit - additional information segment) - creates it if necessary
`String`	`getVersion()` Returns "2.3.1"
`void`	`insertDB1(DB1 structure, int rep)` Inserts a specific repetition of DB1 (DB1 - Disability segment)
`DB1`	`insertDB1(int rep)` Inserts a specific repetition of DB1 (DB1 - Disability segment)
`void`	`insertDG1(DG1 structure, int rep)` Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
`DG1`	`insertDG1(int rep)` Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
`void`	`insertFT1PR1ROL(DFT_P03_FT1PR1ROL structure, int rep)` Inserts a specific repetition of FT1PR1ROL (a Group object)
`DFT_P03_FT1PR1ROL`	`insertFT1PR1ROL(int rep)` Inserts a specific repetition of FT1PR1ROL (a Group object)
`void`	`insertGT1(GT1 structure, int rep)` Inserts a specific repetition of GT1 (GT1 - guarantor segment)
`GT1`	`insertGT1(int rep)` Inserts a specific repetition of GT1 (GT1 - guarantor segment)
`void`	`insertIN1IN2IN3(DFT_P03_IN1IN2IN3 structure, int rep)` Inserts a specific repetition of IN1IN2IN3 (a Group object)
`DFT_P03_IN1IN2IN3`	`insertIN1IN2IN3(int rep)` Inserts a specific repetition of IN1IN2IN3 (a Group object)
`OBX`	`insertOBX(int rep)` Inserts a specific repetition of OBX (OBX - observation/result segment)
`void`	`insertOBX(OBX structure, int rep)` Inserts a specific repetition of OBX (OBX - observation/result segment)
`DB1`	`removeDB1(int rep)` Removes a specific repetition of DB1 (DB1 - Disability segment)
`DG1`	`removeDG1(int rep)` Removes a specific repetition of DG1 (DG1 - diagnosis segment)
`DFT_P03_FT1PR1ROL`	`removeFT1PR1ROL(int rep)` Removes a specific repetition of FT1PR1ROL (a Group object)
`GT1`	`removeGT1(int rep)` Removes a specific repetition of GT1 (GT1 - guarantor segment)
`DFT_P03_IN1IN2IN3`	`removeIN1IN2IN3(int rep)` Removes a specific repetition of IN1IN2IN3 (a Group object)
`OBX`	`removeOBX(int rep)` Removes a specific repetition of OBX (OBX - observation/result segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage
accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable
isEmpty, provideLocation

- Constructor Detail
  - DFT_P03
```
public DFT_P03()
```
    Creates a new DFT_P03 message with DefaultModelClassFactory.
  - DFT_P03
```
public DFT_P03(ModelClassFactory factory)
```
    Creates a new DFT_P03 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.3.1"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (MSH - message header segment) - creates it if necessary
  - getEVN
```
public EVN getEVN()
```
    Returns EVN (EVN - event type segment) - creates it if necessary
  - getPID
```
public PID getPID()
```
    Returns PID (PID - patient identification segment) - creates it if necessary
  - getPD1
```
public PD1 getPD1()
```
    Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary
  - getPV1
```
public PV1 getPV1()
```
    Returns PV1 (PV1 - patient visit segment-) - creates it if necessary
  - getPV2
```
public PV2 getPV2()
```
    Returns PV2 (PV2 - patient visit - additional information segment) - creates it if necessary
  - getDB1
```
public DB1 getDB1()
```
    Returns the first repetition of DB1 (DB1 - Disability segment) - creates it if necessary
  - getDB1
```
public DB1 getDB1(int rep)
```
    Returns a specific repetition of DB1 (DB1 - Disability segment) - 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.
  - getDB1Reps
```
public int getDB1Reps()
```
    Returns the number of existing repetitions of DB1
  - getDB1All
```
public List<DB1> getDB1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of DB1.
    
    Note that unlike getDB1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertDB1
```
public void insertDB1(DB1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of DB1 (DB1 - Disability segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDB1
```
public DB1 insertDB1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DB1 (DB1 - Disability segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDB1
```
public DB1 removeDB1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DB1 (DB1 - Disability segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getOBX
```
public OBX getOBX()
```
    Returns the first repetition of OBX (OBX - observation/result segment) - creates it if necessary
  - getOBX
```
public OBX getOBX(int rep)
```
    Returns a specific repetition of OBX (OBX - observation/result segment) - 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 (OBX - observation/result segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBX
```
public OBX insertOBX(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of OBX (OBX - observation/result segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBX
```
public OBX removeOBX(int rep)
              throws HL7Exception
```
    Removes a specific repetition of OBX (OBX - observation/result segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getFT1PR1ROL
```
public DFT_P03_FT1PR1ROL getFT1PR1ROL()
```
    Returns the first repetition of FT1PR1ROL (a Group object) - creates it if necessary
  - getFT1PR1ROL
```
public DFT_P03_FT1PR1ROL getFT1PR1ROL(int rep)
```
    Returns a specific repetition of FT1PR1ROL (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.
  - getFT1PR1ROLReps
```
public int getFT1PR1ROLReps()
```
    Returns the number of existing repetitions of FT1PR1ROL
  - getFT1PR1ROLAll
```
public List<DFT_P03_FT1PR1ROL> getFT1PR1ROLAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of FT1PR1ROL.
    
    Note that unlike getFT1PR1ROL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertFT1PR1ROL
```
public void insertFT1PR1ROL(DFT_P03_FT1PR1ROL structure,
                   int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of FT1PR1ROL (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertFT1PR1ROL
```
public DFT_P03_FT1PR1ROL insertFT1PR1ROL(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of FT1PR1ROL (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeFT1PR1ROL
```
public DFT_P03_FT1PR1ROL removeFT1PR1ROL(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of FT1PR1ROL (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getDG1
```
public DG1 getDG1()
```
    Returns the first repetition of DG1 (DG1 - diagnosis segment) - creates it if necessary
  - getDG1
```
public DG1 getDG1(int rep)
```
    Returns a specific repetition of DG1 (DG1 - diagnosis segment) - 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 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertDG1
```
public DG1 insertDG1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeDG1
```
public DG1 removeDG1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of DG1 (DG1 - diagnosis segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getDRG
```
public DRG getDRG()
```
    Returns DRG (DRG - diagnosis related group segment) - creates it if necessary
  - getGT1
```
public GT1 getGT1()
```
    Returns the first repetition of GT1 (GT1 - guarantor segment) - creates it if necessary
  - getGT1
```
public GT1 getGT1(int rep)
```
    Returns a specific repetition of GT1 (GT1 - guarantor segment) - 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.
  - getGT1Reps
```
public int getGT1Reps()
```
    Returns the number of existing repetitions of GT1
  - getGT1All
```
public List<GT1> getGT1All()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of GT1.
    
    Note that unlike getGT1(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertGT1
```
public void insertGT1(GT1 structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of GT1 (GT1 - guarantor segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertGT1
```
public GT1 insertGT1(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of GT1 (GT1 - guarantor segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeGT1
```
public GT1 removeGT1(int rep)
              throws HL7Exception
```
    Removes a specific repetition of GT1 (GT1 - guarantor segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getIN1IN2IN3
```
public DFT_P03_IN1IN2IN3 getIN1IN2IN3()
```
    Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
  - getIN1IN2IN3
```
public DFT_P03_IN1IN2IN3 getIN1IN2IN3(int rep)
```
    Returns a specific repetition of IN1IN2IN3 (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.
  - getIN1IN2IN3Reps
```
public int getIN1IN2IN3Reps()
```
    Returns the number of existing repetitions of IN1IN2IN3
  - getIN1IN2IN3All
```
public List<DFT_P03_IN1IN2IN3> getIN1IN2IN3All()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
    
    Note that unlike getIN1IN2IN3(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertIN1IN2IN3
```
public void insertIN1IN2IN3(DFT_P03_IN1IN2IN3 structure,
                   int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of IN1IN2IN3 (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertIN1IN2IN3
```
public DFT_P03_IN1IN2IN3 insertIN1IN2IN3(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of IN1IN2IN3 (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeIN1IN2IN3
```
public DFT_P03_IN1IN2IN3 removeIN1IN2IN3(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of IN1IN2IN3 (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup.removeRepetition(String, int)
  - getACC
```
public ACC getACC()
```
    Returns ACC (ACC - accident segment) - creates it if necessary

Class DFT_P03

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Group

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

Constructor Detail

DFT_P03

DFT_P03

Method Detail

getVersion

getMSH

getEVN

getPID

getPD1

getPV1

getPV2

getDB1

getDB1

getDB1Reps

getDB1All

insertDB1

insertDB1

removeDB1

getOBX

getOBX

getOBXReps

getOBXAll

insertOBX

insertOBX

removeOBX

getFT1PR1ROL

getFT1PR1ROL

getFT1PR1ROLReps

getFT1PR1ROLAll

insertFT1PR1ROL

insertFT1PR1ROL

removeFT1PR1ROL

getDG1

getDG1

getDG1Reps

getDG1All

insertDG1

insertDG1

removeDG1

getDRG

getGT1

getGT1

getGT1Reps

getGT1All

insertGT1

insertGT1

removeGT1

getIN1IN2IN3

getIN1IN2IN3

getIN1IN2IN3Reps

getIN1IN2IN3All

insertIN1IN2IN3

insertIN1IN2IN3

removeIN1IN2IN3

getACC