ca.uhn.hl7v2.model.v25.message

Class MDM_T01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v25.message.MDM_T01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class MDM_T01
extends AbstractMessage

Represents a MDM_T01 message structure (see chapter 9.5.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EVN (Event Type)
• 4: PID (Patient Identification)
• 5: PV1 (Patient Visit)
• 6: MDM_T01_COMMON_ORDER (a Group object) optional repeating
• 7: TXA (Transcription Document Header)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MDM_T01_COMMON_ORDER	getCOMMON_ORDER() Returns the first repetition of COMMON_ORDER (a Group object) - creates it if necessary
MDM_T01_COMMON_ORDER	getCOMMON_ORDER(int rep) Returns a specific repetition of COMMON_ORDER (a Group object) - creates it if necessary
List<MDM_T01_COMMON_ORDER>	getCOMMON_ORDERAll() Returns a non-modifiable List containing all current existing repetitions of COMMON_ORDER.
int	getCOMMON_ORDERReps() Returns the number of existing repetitions of COMMON_ORDER
EVN	getEVN() Returns EVN (Event Type) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
PV1	getPV1() Returns PV1 (Patient Visit) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
TXA	getTXA() Returns TXA (Transcription Document Header) - creates it if necessary
String	getVersion() Returns "2.5"
MDM_T01_COMMON_ORDER	insertCOMMON_ORDER(int rep) Inserts a specific repetition of COMMON_ORDER (a Group object)
void	insertCOMMON_ORDER(MDM_T01_COMMON_ORDER structure, int rep) Inserts a specific repetition of COMMON_ORDER (a Group object)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
MDM_T01_COMMON_ORDER	removeCOMMON_ORDER(int rep) Removes a specific repetition of COMMON_ORDER (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software 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

MDM_T01

public MDM_T01()

Creates a new MDM_T01 message with DefaultModelClassFactory.

MDM_T01

public MDM_T01(ModelClassFactory factory)

Creates a new MDM_T01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.5"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

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

getCOMMON_ORDER

public MDM_T01_COMMON_ORDER getCOMMON_ORDER()

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

getCOMMON_ORDER

public MDM_T01_COMMON_ORDER getCOMMON_ORDER(int rep)

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

getCOMMON_ORDERReps

public int getCOMMON_ORDERReps()

Returns the number of existing repetitions of COMMON_ORDER

getCOMMON_ORDERAll

public List<MDM_T01_COMMON_ORDER> getCOMMON_ORDERAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertCOMMON_ORDER

public void insertCOMMON_ORDER(MDM_T01_COMMON_ORDER structure,
                      int rep)
                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCOMMON_ORDER

public MDM_T01_COMMON_ORDER insertCOMMON_ORDER(int rep)
                                        throws HL7Exception

Inserts a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCOMMON_ORDER

public MDM_T01_COMMON_ORDER removeCOMMON_ORDER(int rep)
                                        throws HL7Exception

Removes a specific repetition of COMMON_ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getTXA

public TXA getTXA()

Returns TXA (Transcription Document Header) - creates it if necessary