ca.uhn.hl7v2.model.v231.message
Class ADT_A08

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.ADT_A08

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_A08
extends AbstractMessage

Represents a ADT_A08 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: NK1 (NK1 - next of kin / associated parties segment-) optional repeating
• 6: PV1 (PV1 - patient visit segment-)
• 7: PV2 (PV2 - patient visit - additional information segment) optional
• 8: DB1 (DB1 - Disability segment) optional repeating
• 9: OBX (OBX - observation/result segment) optional repeating
• 10: AL1 (AL1 - patient allergy information segment) optional repeating
• 11: DG1 (DG1 - diagnosis segment) optional repeating
• 12: DRG (DRG - diagnosis related group segment) optional
• 13: ADT_A08_PR1ROL (a Group object) optional repeating
• 14: GT1 (GT1 - guarantor segment) optional repeating
• 15: ADT_A08_IN1IN2IN3 (a Group object) optional repeating
• 16: ACC (ACC - accident segment) optional
• 17: UB1 (UB1 - UB82 data segment) optional
• 18: UB2 (UB2 - UB92 data segment) optional

See Also:

Serialized Form

Constructor Summary

ADT_A08()
Creates a new ADT_A08 message with DefaultModelClassFactory.

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

Method Summary

ACC	getACC() Returns ACC (ACC - accident segment) - creates it if necessary
AL1	getAL1() Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
int	getAL1Reps() Returns the number of existing repetitions of AL1
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
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
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
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
int	getGT1Reps() Returns the number of existing repetitions of GT1
ADT_A08_IN1IN2IN3	getIN1IN2IN3() Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
ADT_A08_IN1IN2IN3	getIN1IN2IN3(int rep) Returns a specific repetition of IN1IN2IN3 (a Group object) - creates it if necessary
int	getIN1IN2IN3Reps() Returns the number of existing repetitions of IN1IN2IN3
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
int	getNK1Reps() Returns the number of existing repetitions of NK1
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
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
ADT_A08_PR1ROL	getPR1ROL() Returns the first repetition of PR1ROL (a Group object) - creates it if necessary
ADT_A08_PR1ROL	getPR1ROL(int rep) Returns a specific repetition of PR1ROL (a Group object) - creates it if necessary
int	getPR1ROLReps() Returns the number of existing repetitions of PR1ROL
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
UB1	getUB1() Returns UB1 (UB1 - UB82 data segment) - creates it if necessary
UB2	getUB2() Returns UB2 (UB2 - UB92 data segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
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	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(ADT_A08_IN1IN2IN3 structure, int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
ADT_A08_IN1IN2IN3	insertIN1IN2IN3(int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
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)
void	insertPR1ROL(ADT_A08_PR1ROL structure, int rep) Inserts a specific repetition of PR1ROL (a Group object)
ADT_A08_PR1ROL	insertPR1ROL(int rep) Inserts a specific repetition of PR1ROL (a Group object)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (AL1 - patient allergy information 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)
GT1	removeGT1(int rep) Removes a specific repetition of GT1 (GT1 - guarantor segment)
ADT_A08_IN1IN2IN3	removeIN1IN2IN3(int rep) Removes a specific repetition of IN1IN2IN3 (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (OBX - observation/result segment)
ADT_A08_PR1ROL	removePR1ROL(int rep) Removes a specific repetition of PR1ROL (a Group object)

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_A08

public ADT_A08()

Creates a new ADT_A08 message with DefaultModelClassFactory.

ADT_A08

public ADT_A08(ModelClassFactory factory)

Creates a new ADT_A08 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

getNK1

public NK1 getNK1()

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

getNK1

public NK1 getNK1(int rep)

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

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 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

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

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

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)

getAL1

public AL1 getAL1()

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

getAL1

public AL1 getAL1(int rep)

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

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 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (AL1 - patient allergy information segment)

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

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

getPR1ROL

public ADT_A08_PR1ROL getPR1ROL()

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

getPR1ROL

public ADT_A08_PR1ROL getPR1ROL(int rep)

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

getPR1ROLReps

public int getPR1ROLReps()

Returns the number of existing repetitions of PR1ROL

insertPR1ROL

public void insertPR1ROL(ADT_A08_PR1ROL structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPR1ROL

public ADT_A08_PR1ROL insertPR1ROL(int rep)
                            throws HL7Exception

Inserts a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePR1ROL

public ADT_A08_PR1ROL removePR1ROL(int rep)
                            throws HL7Exception

Removes a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

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

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 ADT_A08_IN1IN2IN3 getIN1IN2IN3()

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

getIN1IN2IN3

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

insertIN1IN2IN3

public void insertIN1IN2IN3(ADT_A08_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 ADT_A08_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 ADT_A08_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

getUB1

public UB1 getUB1()

Returns UB1 (UB1 - UB82 data segment) - creates it if necessary

getUB2

public UB2 getUB2()

Returns UB2 (UB2 - UB92 data segment) - creates it if necessary