Package ca.uhn.hl7v2.model.v24.message

Class ADT_A03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.ADT_A03

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ADT_A03
extends AbstractMessage

Represents a ADT_A03 message structure (see chapter 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)
• 7: PV2 (Patient visit - additional information) optional
• 8: ROL (Role) optional repeating
• 9: DB1 (Disability) optional repeating
• 10: DG1 (Diagnosis) optional repeating
• 11: DRG (Diagnosis Related Group) optional
• 12: ADT_A03_PROCEDURE (a Group object) optional repeating
• 13: OBX (Observation/Result) optional repeating
• 14: PDA (Patient death and autopsy) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ADT_A03()	Creates a new ADT_A03 message with DefaultModelClassFactory.
ADT_A03(ModelClassFactory factory)	Creates a new ADT_A03 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
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
DRG	getDRG()	Returns DRG (Diagnosis Related Group) - creates it if necessary
EVN	getEVN()	Returns EVN (Event Type) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
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
PDA	getPDA()	Returns PDA (Patient death and autopsy) - creates it if necessary
PID	getPID()	Returns PID (Patient identification) - creates it if necessary
ADT_A03_PROCEDURE	getPROCEDURE()	Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
ADT_A03_PROCEDURE	getPROCEDURE(int rep)	Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
List<ADT_A03_PROCEDURE>	getPROCEDUREAll()	Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
int	getPROCEDUREReps()	Returns the number of existing repetitions of PROCEDURE
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"
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)
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)
ADT_A03_PROCEDURE	insertPROCEDURE(int rep)	Inserts a specific repetition of PROCEDURE (a Group object)
void	insertPROCEDURE(ADT_A03_PROCEDURE structure, int rep)	Inserts a specific repetition of PROCEDURE (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)
DB1	removeDB1(int rep)	Removes a specific repetition of DB1 (Disability)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation/Result)
ADT_A03_PROCEDURE	removePROCEDURE(int rep)	Removes a specific repetition of PROCEDURE (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

ADT_A03

public ADT_A03()

Creates a new ADT_A03 message with DefaultModelClassFactory.

ADT_A03

public ADT_A03(ModelClassFactory factory)

Creates a new ADT_A03 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)

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

getPROCEDURE

public ADT_A03_PROCEDURE getPROCEDURE()

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

getPROCEDURE

public ADT_A03_PROCEDURE getPROCEDURE(int rep)

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

getPROCEDUREReps

public int getPROCEDUREReps()

Returns the number of existing repetitions of PROCEDURE

getPROCEDUREAll

public List<ADT_A03_PROCEDURE> getPROCEDUREAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertPROCEDURE

public void insertPROCEDURE(ADT_A03_PROCEDURE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROCEDURE

public ADT_A03_PROCEDURE insertPROCEDURE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROCEDURE

public ADT_A03_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception

Removes a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

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)

getPDA

public PDA getPDA()

Returns PDA (Patient death and autopsy) - creates it if necessary