ca.uhn.hl7v2.model.v24.message
Class RAS_O17

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v24.message.RAS_O17

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RAS_O17
extends AbstractMessage

Represents a RAS_O17 message structure (see chapter 4). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: NTE (Notes and Comments) optional repeating
• 3: RAS_O17_PATIENT (a Group object) optional
• 4: RAS_O17_ORDER (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

RAS_O17()
Creates a new RAS_O17 message with DefaultModelClassFactory.

RAS_O17(ModelClassFactory factory)
Creates a new RAS_O17 message with custom ModelClassFactory.

Method Summary

MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
int	getNTEReps() Returns the number of existing repetitions of NTE
RAS_O17_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
RAS_O17_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
int	getORDERReps() Returns the number of existing repetitions of ORDER
RAS_O17_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
String	getVersion() Returns "2.4"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
RAS_O17_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(RAS_O17_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
RAS_O17_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

Constructor Detail

RAS_O17

public RAS_O17()

Creates a new RAS_O17 message with DefaultModelClassFactory.

RAS_O17

public RAS_O17(ModelClassFactory factory)

Creates a new RAS_O17 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getPATIENT

public RAS_O17_PATIENT getPATIENT()

Returns PATIENT (a Group object) - creates it if necessary

getORDER

public RAS_O17_ORDER getORDER()

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

getORDER

public RAS_O17_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

insertORDER

public void insertORDER(RAS_O17_ORDER structure,
                        int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertORDER

public RAS_O17_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeORDER

public RAS_O17_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)