ca.uhn.hl7v2.model.v23.message

Class MDM_T02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.MDM_T02

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class MDM_T02
extends AbstractMessage

Represents a MDM_T02 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (Message header segment)
• 2: EVN (Event type)
• 3: PID (Patient Identification)
• 4: PV1 (Patient visit)
• 5: TXA (Document notification segment)
• 6: OBX (Observation segment) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
PV1	getPV1() Returns PV1 (Patient visit) - creates it if necessary
TXA	getTXA() Returns TXA (Document notification segment) - creates it if necessary
String	getVersion() Returns "2.3"
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)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation segment)

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

accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, 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 Detail

MDM_T02

public MDM_T02()

Creates a new MDM_T02 message with DefaultModelClassFactory.

MDM_T02

public MDM_T02(ModelClassFactory factory)

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

getPV1

public PV1 getPV1()

Returns PV1 (Patient visit) - creates it if necessary

getTXA

public TXA getTXA()

Returns TXA (Document notification segment) - creates it if necessary

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)