Package ca.uhn.hl7v2.model.v23.message

Class DFT_P03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.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 (Message header segment)
• 2: EVN (Event type)
• 3: PID (Patient Identification)
• 4: PD1 (Patient Demographic) optional
• 5: PV1 (Patient visit) optional
• 6: PV2 (Patient visit - additional information) optional
• 7: DB1 (Disability Segment) optional repeating
• 8: OBX (Observation segment) optional repeating
• 9: DFT_P03_FINANCIAL (a Group object) repeating
• 10: DG1 (Diagnosis) optional repeating
• 11: DRG (Diagnosis Related Group) optional
• 12: GT1 (Guarantor) optional repeating
• 13: DFT_P03_INSURANCE (a Group object) optional repeating
• 14: ACC (Accident) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	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

Modifier and Type	Method	Description
ACC	getACC()	Returns ACC (Accident) - creates it if necessary
DB1	getDB1()	Returns the first repetition of DB1 (Disability Segment) - creates it if necessary
DB1	getDB1(int rep)	Returns a specific repetition of 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 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep)	Returns a specific repetition of DG1 (Diagnosis) - 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 (Diagnosis Related Group) - creates it if necessary
EVN	getEVN()	Returns EVN (Event type) - creates it if necessary
DFT_P03_FINANCIAL	getFINANCIAL()	Returns the first repetition of FINANCIAL (a Group object) - creates it if necessary
DFT_P03_FINANCIAL	getFINANCIAL(int rep)	Returns a specific repetition of FINANCIAL (a Group object) - creates it if necessary
List<DFT_P03_FINANCIAL>	getFINANCIALAll()	Returns a non-modifiable List containing all current existing repetitions of FINANCIAL.
int	getFINANCIALReps()	Returns the number of existing repetitions of FINANCIAL
GT1	getGT1()	Returns the first repetition of GT1 (Guarantor) - creates it if necessary
GT1	getGT1(int rep)	Returns a specific repetition of GT1 (Guarantor) - 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_INSURANCE	getINSURANCE()	Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
DFT_P03_INSURANCE	getINSURANCE(int rep)	Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
List<DFT_P03_INSURANCE>	getINSURANCEAll()	Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
int	getINSURANCEReps()	Returns the number of existing repetitions of INSURANCE
MSH	getMSH()	Returns MSH (Message header segment) - creates it if necessary
OBX	getOBX()	Returns the first repetition of OBX (Observation segment) - creates it if necessary
OBX	getOBX(int rep)	Returns a specific repetition of OBX (Observation 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 (Patient Demographic) - creates it if necessary
PID	getPID()	Returns PID (Patient Identification) - creates it if necessary
PV1	getPV1()	Returns PV1 (Patient visit) - creates it if necessary
PV2	getPV2()	Returns PV2 (Patient visit - additional information) - creates it if necessary
String	getVersion()	Returns "2.3"
DB1	insertDB1(int rep)	Inserts a specific repetition of DB1 (Disability Segment)
void	insertDB1(DB1 structure, int rep)	Inserts a specific repetition of DB1 (Disability Segment)
DG1	insertDG1(int rep)	Inserts a specific repetition of DG1 (Diagnosis)
void	insertDG1(DG1 structure, int rep)	Inserts a specific repetition of DG1 (Diagnosis)
DFT_P03_FINANCIAL	insertFINANCIAL(int rep)	Inserts a specific repetition of FINANCIAL (a Group object)
void	insertFINANCIAL(DFT_P03_FINANCIAL structure, int rep)	Inserts a specific repetition of FINANCIAL (a Group object)
GT1	insertGT1(int rep)	Inserts a specific repetition of GT1 (Guarantor)
void	insertGT1(GT1 structure, int rep)	Inserts a specific repetition of GT1 (Guarantor)
DFT_P03_INSURANCE	insertINSURANCE(int rep)	Inserts a specific repetition of INSURANCE (a Group object)
void	insertINSURANCE(DFT_P03_INSURANCE structure, int rep)	Inserts a specific repetition of INSURANCE (a Group object)
OBX	insertOBX(int rep)	Inserts a specific repetition of OBX (Observation segment)
void	insertOBX(OBX structure, int rep)	Inserts a specific repetition of OBX (Observation segment)
DB1	removeDB1(int rep)	Removes a specific repetition of DB1 (Disability Segment)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
DFT_P03_FINANCIAL	removeFINANCIAL(int rep)	Removes a specific repetition of FINANCIAL (a Group object)
GT1	removeGT1(int rep)	Removes a specific repetition of GT1 (Guarantor)
DFT_P03_INSURANCE	removeINSURANCE(int rep)	Removes a specific repetition of INSURANCE (a Group object)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation segment)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, 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 Details

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 Details

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getEVN

public EVN getEVN()

Returns EVN (Event type) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (Patient Demographic) - creates it if necessary

getPV1

public PV1 getPV1()

Returns PV1 (Patient visit) - creates it if necessary

getPV2

public PV2 getPV2()

Returns PV2 (Patient visit - additional information) - creates it if necessary

getDB1

public DB1 getDB1()

Returns the first repetition of DB1 (Disability Segment) - creates it if necessary

getDB1

public DB1 getDB1(int rep)

Returns a specific repetition of 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 (Disability Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDB1

public DB1 insertDB1(int rep)
              throws HL7Exception

Inserts a specific repetition of 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 (Disability Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation segment) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation 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 (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getFINANCIAL

public DFT_P03_FINANCIAL getFINANCIAL()

Returns the first repetition of FINANCIAL (a Group object) - creates it if necessary

getFINANCIAL

public DFT_P03_FINANCIAL getFINANCIAL(int rep)

Returns a specific repetition of FINANCIAL (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.

getFINANCIALReps

public int getFINANCIALReps()

Returns the number of existing repetitions of FINANCIAL

getFINANCIALAll

public List<DFT_P03_FINANCIAL> getFINANCIALAll()
                                        throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of FINANCIAL.

Note that unlike getFINANCIAL(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertFINANCIAL

public void insertFINANCIAL(DFT_P03_FINANCIAL structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of FINANCIAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertFINANCIAL

public DFT_P03_FINANCIAL insertFINANCIAL(int rep)
                                  throws HL7Exception

Inserts a specific repetition of FINANCIAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeFINANCIAL

public DFT_P03_FINANCIAL removeFINANCIAL(int rep)
                                  throws HL7Exception

Removes a specific repetition of FINANCIAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (Diagnosis) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

Returns a specific repetition of DG1 (Diagnosis) - 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 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDRG

public DRG getDRG()

Returns DRG (Diagnosis Related Group) - creates it if necessary

getGT1

public GT1 getGT1()

Returns the first repetition of GT1 (Guarantor) - creates it if necessary

getGT1

public GT1 getGT1(int rep)

Returns a specific repetition of GT1 (Guarantor) - 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 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertGT1

public GT1 insertGT1(int rep)
              throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeGT1

public GT1 removeGT1(int rep)
              throws HL7Exception

Removes a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getINSURANCE

public DFT_P03_INSURANCE getINSURANCE()

Returns the first repetition of INSURANCE (a Group object) - creates it if necessary

getINSURANCE

public DFT_P03_INSURANCE getINSURANCE(int rep)

Returns a specific repetition of INSURANCE (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.

getINSURANCEReps

public int getINSURANCEReps()

Returns the number of existing repetitions of INSURANCE

getINSURANCEAll

public List<DFT_P03_INSURANCE> getINSURANCEAll()
                                        throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of INSURANCE.

Note that unlike getINSURANCE(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertINSURANCE

public void insertINSURANCE(DFT_P03_INSURANCE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertINSURANCE

public DFT_P03_INSURANCE insertINSURANCE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeINSURANCE

public DFT_P03_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception

Removes a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getACC

public ACC getACC()

Returns ACC (Accident) - creates it if necessary