ca.uhn.hl7v2.model.v26.message

Class NMR_N01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.NMR_N01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class NMR_N01
extends AbstractMessage

Represents a NMR_N01 message structure (see chapter 14.3.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: MSA (Message Acknowledgment)
• 5: ERR (Error) optional repeating
• 6: QRD (Original-Style Query Definition) optional
• 7: NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT	getCLOCK_AND_STATS_WITH_NOTES_ALT() Returns the first repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object) - creates it if necessary
NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT	getCLOCK_AND_STATS_WITH_NOTES_ALT(int rep) Returns a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object) - creates it if necessary
List<NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT>	getCLOCK_AND_STATS_WITH_NOTES_ALTAll() Returns a non-modifiable List containing all current existing repetitions of CLOCK_AND_STATS_WITH_NOTES_ALT.
int	getCLOCK_AND_STATS_WITH_NOTES_ALTReps() Returns the number of existing repetitions of CLOCK_AND_STATS_WITH_NOTES_ALT
ERR	getERR() Returns the first repetition of ERR (Error) - creates it if necessary
ERR	getERR(int rep) Returns a specific repetition of ERR (Error) - creates it if necessary
List<ERR>	getERRAll() Returns a non-modifiable List containing all current existing repetitions of ERR.
int	getERRReps() Returns the number of existing repetitions of ERR
MSA	getMSA() Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
QRD	getQRD() Returns QRD (Original-Style Query Definition) - 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
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT	insertCLOCK_AND_STATS_WITH_NOTES_ALT(int rep) Inserts a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)
void	insertCLOCK_AND_STATS_WITH_NOTES_ALT(NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT structure, int rep) Inserts a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)
void	insertERR(ERR structure, int rep) Inserts a specific repetition of ERR (Error)
ERR	insertERR(int rep) Inserts a specific repetition of ERR (Error)
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)
NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT	removeCLOCK_AND_STATS_WITH_NOTES_ALT(int rep) Removes a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)
ERR	removeERR(int rep) Removes a specific repetition of ERR (Error)
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

NMR_N01

public NMR_N01()

Creates a new NMR_N01 message with DefaultModelClassFactory.

NMR_N01

public NMR_N01(ModelClassFactory factory)

Creates a new NMR_N01 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

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)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getERR

public ERR getERR()

Returns the first repetition of ERR (Error) - creates it if necessary

getERR

public ERR getERR(int rep)

Returns a specific repetition of ERR (Error) - 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.

getERRReps

public int getERRReps()

Returns the number of existing repetitions of ERR

getERRAll

public List<ERR> getERRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertERR

public void insertERR(ERR structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertERR

public ERR insertERR(int rep)
              throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeERR

public ERR removeERR(int rep)
              throws HL7Exception

Removes a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - creates it if necessary

getCLOCK_AND_STATS_WITH_NOTES_ALT

public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT getCLOCK_AND_STATS_WITH_NOTES_ALT()

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

getCLOCK_AND_STATS_WITH_NOTES_ALT

public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT getCLOCK_AND_STATS_WITH_NOTES_ALT(int rep)

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

getCLOCK_AND_STATS_WITH_NOTES_ALTReps

public int getCLOCK_AND_STATS_WITH_NOTES_ALTReps()

Returns the number of existing repetitions of CLOCK_AND_STATS_WITH_NOTES_ALT

getCLOCK_AND_STATS_WITH_NOTES_ALTAll

public List<NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT> getCLOCK_AND_STATS_WITH_NOTES_ALTAll()
                                                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertCLOCK_AND_STATS_WITH_NOTES_ALT

public void insertCLOCK_AND_STATS_WITH_NOTES_ALT(NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT structure,
                                        int rep)
                                          throws HL7Exception

Inserts a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCLOCK_AND_STATS_WITH_NOTES_ALT

public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT insertCLOCK_AND_STATS_WITH_NOTES_ALT(int rep)
                                                                            throws HL7Exception

Inserts a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCLOCK_AND_STATS_WITH_NOTES_ALT

public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT removeCLOCK_AND_STATS_WITH_NOTES_ALT(int rep)
                                                                            throws HL7Exception

Removes a specific repetition of CLOCK_AND_STATS_WITH_NOTES_ALT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)