ca.uhn.hl7v2.model.v24.message
Class ADT_A05

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.ADT_A05

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_A05
extends AbstractMessage

Represents a ADT_A05 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: NK1 (Next of kin / associated parties) optional repeating
• 7: PV1 (Patient visit)
• 8: PV2 (Patient visit - additional information) optional
• 9: ROL (Role) optional repeating
• 10: DB1 (Disability) optional repeating
• 11: OBX (Observation/Result) optional repeating
• 12: AL1 (Patient allergy information) optional repeating
• 13: DG1 (Diagnosis) optional repeating
• 14: DRG (Diagnosis Related Group) optional
• 15: ADT_A05_PROCEDURE (a Group object) optional repeating
• 16: GT1 (Guarantor) optional repeating
• 17: ADT_A05_INSURANCE (a Group object) optional repeating
• 18: ACC (Accident) optional
• 19: UB1 (UB82) optional
• 20: UB2 (UB92 Data) optional

See Also:

Serialized Form

Constructor Summary

ADT_A05()
Creates a new ADT_A05 message with DefaultModelClassFactory.

ADT_A05(ModelClassFactory factory)
Creates a new ADT_A05 message with custom ModelClassFactory.

Method Summary

ACC	getACC() Returns ACC (Accident) - creates it if necessary
AL1	getAL1() Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (Patient allergy information) - creates it if necessary
int	getAL1Reps() Returns the number of existing repetitions of AL1
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
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
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
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
int	getGT1Reps() Returns the number of existing repetitions of GT1
ADT_A05_INSURANCE	getINSURANCE() Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
ADT_A05_INSURANCE	getINSURANCE(int rep) Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
int	getINSURANCEReps() Returns the number of existing repetitions of INSURANCE
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (Next of kin / associated parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of kin / associated parties) - creates it if necessary
int	getNK1Reps() Returns the number of existing repetitions of NK1
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
int	getOBXReps() Returns the number of existing repetitions of OBX
PD1	getPD1() Returns PD1 (patient additional demographic) - creates it if necessary
PID	getPID() Returns PID (Patient identification) - creates it if necessary
ADT_A05_PROCEDURE	getPROCEDURE() Returns the first repetition of PROCEDURE (a Group object) - creates it if necessary
ADT_A05_PROCEDURE	getPROCEDURE(int rep) Returns a specific repetition of PROCEDURE (a Group object) - creates it if necessary
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
int	getROL2Reps() Returns the number of existing repetitions of ROL2
int	getROLReps() Returns the number of existing repetitions of ROL
UB1	getUB1() Returns UB1 (UB82) - creates it if necessary
UB2	getUB2() Returns UB2 (UB92 Data) - creates it if necessary
String	getVersion() Returns "2.4"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (Patient allergy information)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (Patient allergy information)
void	insertDB1(DB1 structure, int rep) Inserts a specific repetition of DB1 (Disability)
DB1	insertDB1(int rep) Inserts a specific repetition of DB1 (Disability)
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (Diagnosis)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (Diagnosis)
void	insertGT1(GT1 structure, int rep) Inserts a specific repetition of GT1 (Guarantor)
GT1	insertGT1(int rep) Inserts a specific repetition of GT1 (Guarantor)
void	insertINSURANCE(ADT_A05_INSURANCE structure, int rep) Inserts a specific repetition of INSURANCE (a Group object)
ADT_A05_INSURANCE	insertINSURANCE(int rep) Inserts a specific repetition of INSURANCE (a Group object)
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
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)
void	insertPROCEDURE(ADT_A05_PROCEDURE structure, int rep) Inserts a specific repetition of PROCEDURE (a Group object)
ADT_A05_PROCEDURE	insertPROCEDURE(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)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (Patient allergy information)
DB1	removeDB1(int rep) Removes a specific repetition of DB1 (Disability)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (Diagnosis)
GT1	removeGT1(int rep) Removes a specific repetition of GT1 (Guarantor)
ADT_A05_INSURANCE	removeINSURANCE(int rep) Removes a specific repetition of INSURANCE (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of kin / associated parties)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)
ADT_A05_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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, isGroup, isRepeating, isRequired

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

getName, getParent

Constructor Detail

ADT_A05

public ADT_A05()

Creates a new ADT_A05 message with DefaultModelClassFactory.

ADT_A05

public ADT_A05(ModelClassFactory factory)

Creates a new ADT_A05 message with custom ModelClassFactory.

Method Detail

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

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)

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of kin / associated parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of kin / associated parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

insertNK1

public void insertNK1(NK1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of kin / associated parties)

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

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

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)

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

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)

getAL1

public AL1 getAL1()

Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary

getAL1

public AL1 getAL1(int rep)

Returns a specific repetition of AL1 (Patient allergy information) - 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.

getAL1Reps

public int getAL1Reps()

Returns the number of existing repetitions of AL1

insertAL1

public void insertAL1(AL1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (Patient allergy information)

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

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_A05_PROCEDURE getPROCEDURE()

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

getPROCEDURE

public ADT_A05_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

insertPROCEDURE

public void insertPROCEDURE(ADT_A05_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_A05_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_A05_PROCEDURE removePROCEDURE(int rep)
                                  throws HL7Exception

Removes a specific repetition of PROCEDURE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

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

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 ADT_A05_INSURANCE getINSURANCE()

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

getINSURANCE

public ADT_A05_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

insertINSURANCE

public void insertINSURANCE(ADT_A05_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 ADT_A05_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 ADT_A05_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

getUB1

public UB1 getUB1()

Returns UB1 (UB82) - creates it if necessary

getUB2

public UB2 getUB2()

Returns UB2 (UB92 Data) - creates it if necessary