Package ca.uhn.hl7v2.model.v24.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.v24.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 6.4.3). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: EVN (Event Type)
• 3: PID (Patient identification)
• 4: PD1 (patient additional demographic) optional
• 5: ROL (Role) optional repeating
• 6: PV1 (Patient visit) optional
• 7: PV2 (Patient visit - additional information) optional
• 8: ROL (Role) optional repeating
• 9: DB1 (Disability) optional repeating
• 10: DFT_P03_COMMON_ORDER (a Group object) optional repeating
• 11: DFT_P03_FINANCIAL (a Group object) repeating
• 12: DG1 (Diagnosis) optional repeating

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
DFT_P03_COMMON_ORDER	getCOMMON_ORDER()	Returns the first repetition of COMMON_ORDER (a Group object) - creates it if necessary
DFT_P03_COMMON_ORDER	getCOMMON_ORDER(int rep)	Returns a specific repetition of COMMON_ORDER (a Group object) - creates it if necessary
List<DFT_P03_COMMON_ORDER>	getCOMMON_ORDERAll()	Returns a non-modifiable List containing all current existing repetitions of COMMON_ORDER.
int	getCOMMON_ORDERReps()	Returns the number of existing repetitions of COMMON_ORDER
DB1	getDB1()	Returns the first repetition of DB1 (Disability) - creates it if necessary
DB1	getDB1(int rep)	Returns a specific repetition of DB1 (Disability) - 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
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
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
PD1	getPD1()	Returns PD1 (patient additional 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
ROL	getROL()	Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep)	Returns a specific repetition of ROL (Role) - creates it if necessary
ROL	getROL2()	Returns the first repetition of ROL2 (Role) - creates it if necessary
ROL	getROL2(int rep)	Returns a specific repetition of ROL2 (Role) - creates it if necessary
List<ROL>	getROL2All()	Returns a non-modifiable List containing all current existing repetitions of ROL2.
int	getROL2Reps()	Returns the number of existing repetitions of ROL2
List<ROL>	getROLAll()	Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps()	Returns the number of existing repetitions of ROL
String	getVersion()	Returns "2.4"
DFT_P03_COMMON_ORDER	insertCOMMON_ORDER(int rep)	Inserts a specific repetition of COMMON_ORDER (a Group object)
void	insertCOMMON_ORDER(DFT_P03_COMMON_ORDER structure, int rep)	Inserts a specific repetition of COMMON_ORDER (a Group object)
DB1	insertDB1(int rep)	Inserts a specific repetition of DB1 (Disability)
void	insertDB1(DB1 structure, int rep)	Inserts a specific repetition of DB1 (Disability)
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)
ROL	insertROL(int rep)	Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep)	Inserts a specific repetition of ROL (Role)
ROL	insertROL2(int rep)	Inserts a specific repetition of ROL2 (Role)
void	insertROL2(ROL structure, int rep)	Inserts a specific repetition of ROL2 (Role)
DFT_P03_COMMON_ORDER	removeCOMMON_ORDER(int rep)	Removes a specific repetition of COMMON_ORDER (a Group object)
DB1	removeDB1(int rep)	Removes a specific repetition of DB1 (Disability)
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)
ROL	removeROL(int rep)	Removes a specific repetition of ROL (Role)
ROL	removeROL2(int rep)	Removes a specific repetition of ROL2 (Role)

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.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - 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 additional demographic) - creates it if necessary

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - 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.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

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

getROL2

public ROL getROL2()

Returns the first repetition of ROL2 (Role) - creates it if necessary

getROL2

public ROL getROL2(int rep)

Returns a specific repetition of ROL2 (Role) - 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.

getROL2Reps

public int getROL2Reps()

Returns the number of existing repetitions of ROL2

getROL2All

public List<ROL> getROL2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertROL2

public void insertROL2(ROL structure,
 int rep)
                throws HL7Exception

Inserts a specific repetition of ROL2 (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertROL2

public ROL insertROL2(int rep)
               throws HL7Exception

Inserts a specific repetition of ROL2 (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeROL2

public ROL removeROL2(int rep)
               throws HL7Exception

Removes a specific repetition of ROL2 (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDB1

public DB1 getDB1()

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

getDB1

public DB1 getDB1(int rep)

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

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDB1

public DB1 insertDB1(int rep)
              throws HL7Exception

Inserts a specific repetition of DB1 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDB1

public DB1 removeDB1(int rep)
              throws HL7Exception

Removes a specific repetition of DB1 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getCOMMON_ORDER

public DFT_P03_COMMON_ORDER getCOMMON_ORDER()

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

getCOMMON_ORDER

public DFT_P03_COMMON_ORDER getCOMMON_ORDER(int rep)

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

getCOMMON_ORDERReps

public int getCOMMON_ORDERReps()

Returns the number of existing repetitions of COMMON_ORDER

getCOMMON_ORDERAll

public List<DFT_P03_COMMON_ORDER> getCOMMON_ORDERAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMMON_ORDER

public void insertCOMMON_ORDER(DFT_P03_COMMON_ORDER structure,
 int rep)
                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCOMMON_ORDER

public DFT_P03_COMMON_ORDER insertCOMMON_ORDER(int rep)
                                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCOMMON_ORDER

public DFT_P03_COMMON_ORDER removeCOMMON_ORDER(int rep)
                                        throws HL7Exception

Removes a specific repetition of COMMON_ORDER (a Group object)

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)