ca.uhn.hl7v2.model.v23.message

Class ADT_A26

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.ADT_A26

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class ADT_A26
extends AbstractMessage

Represents a ADT_A26 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)
• 6: PV2 (Patient visit - additional information) optional
• 7: DB1 (Disability Segment) optional repeating
• 8: OBX (Observation segment) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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
EVN	getEVN() Returns EVN (Event type) - creates it if necessary
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"
void	insertDB1(DB1 structure, int rep) Inserts a specific repetition of DB1 (Disability Segment)
DB1	insertDB1(int rep) Inserts a specific repetition of DB1 (Disability Segment)
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)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation segment)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, 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, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

Constructor Detail

ADT_A26

public ADT_A26()

Creates a new ADT_A26 message with DefaultModelClassFactory.

ADT_A26

public ADT_A26(ModelClassFactory factory)

Creates a new ADT_A26 message with custom ModelClassFactory.

Method Detail

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)