ca.uhn.hl7v2.model.v231.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.v231.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). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: ERR (ERR - error segment) optional repeating
• 4: QRD (QRD - original-style query definition segment) optional
• 5: NMR_N01_NCKNTENSTNTENSCNTE (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
ERR	getERR() Returns the first repetition of ERR (ERR - error segment) - creates it if necessary
ERR	getERR(int rep) Returns a specific repetition of ERR (ERR - error segment) - 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 (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NMR_N01_NCKNTENSTNTENSCNTE	getNCKNTENSTNTENSCNTE() Returns the first repetition of NCKNTENSTNTENSCNTE (a Group object) - creates it if necessary
NMR_N01_NCKNTENSTNTENSCNTE	getNCKNTENSTNTENSCNTE(int rep) Returns a specific repetition of NCKNTENSTNTENSCNTE (a Group object) - creates it if necessary
List<NMR_N01_NCKNTENSTNTENSCNTE>	getNCKNTENSTNTENSCNTEAll() Returns a non-modifiable List containing all current existing repetitions of NCKNTENSTNTENSCNTE.
int	getNCKNTENSTNTENSCNTEReps() Returns the number of existing repetitions of NCKNTENSTNTENSCNTE
QRD	getQRD() Returns QRD (QRD - original-style query definition segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertERR(ERR structure, int rep) Inserts a specific repetition of ERR (ERR - error segment)
ERR	insertERR(int rep) Inserts a specific repetition of ERR (ERR - error segment)
NMR_N01_NCKNTENSTNTENSCNTE	insertNCKNTENSTNTENSCNTE(int rep) Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)
void	insertNCKNTENSTNTENSCNTE(NMR_N01_NCKNTENSTNTENSCNTE structure, int rep) Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)
ERR	removeERR(int rep) Removes a specific repetition of ERR (ERR - error segment)
NMR_N01_NCKNTENSTNTENSCNTE	removeNCKNTENSTNTENSCNTE(int rep) Removes a specific repetition of NCKNTENSTNTENSCNTE (a Group object)

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.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

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getERR

public ERR getERR()

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

getERR

public ERR getERR(int rep)

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

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 (ERR - error segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertERR

public ERR insertERR(int rep)
              throws HL7Exception

Inserts a specific repetition of ERR (ERR - error segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeERR

public ERR removeERR(int rep)
              throws HL7Exception

Removes a specific repetition of ERR (ERR - error segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getQRD

public QRD getQRD()

Returns QRD (QRD - original-style query definition segment) - creates it if necessary

getNCKNTENSTNTENSCNTE

public NMR_N01_NCKNTENSTNTENSCNTE getNCKNTENSTNTENSCNTE()

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

getNCKNTENSTNTENSCNTE

public NMR_N01_NCKNTENSTNTENSCNTE getNCKNTENSTNTENSCNTE(int rep)

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

getNCKNTENSTNTENSCNTEReps

public int getNCKNTENSTNTENSCNTEReps()

Returns the number of existing repetitions of NCKNTENSTNTENSCNTE

getNCKNTENSTNTENSCNTEAll

public List<NMR_N01_NCKNTENSTNTENSCNTE> getNCKNTENSTNTENSCNTEAll()
                                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertNCKNTENSTNTENSCNTE

public void insertNCKNTENSTNTENSCNTE(NMR_N01_NCKNTENSTNTENSCNTE structure,
                            int rep)
                              throws HL7Exception

Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNCKNTENSTNTENSCNTE

public NMR_N01_NCKNTENSTNTENSCNTE insertNCKNTENSTNTENSCNTE(int rep)
                                                    throws HL7Exception

Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNCKNTENSTNTENSCNTE

public NMR_N01_NCKNTENSTNTENSCNTE removeNCKNTENSTNTENSCNTE(int rep)
                                                    throws HL7Exception

Removes a specific repetition of NCKNTENSTNTENSCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)