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

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

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SRM_S01
extends AbstractMessage

Represents a SRM_S01 message structure (see chapter 10). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: ARQ (Appointment Request)
• 3: APR (Appointment Preferences) optional
• 4: NTE (Notes and Comments) optional repeating
• 5: SRM_S01_PATIENT (a Group object) optional repeating
• 6: SRM_S01_RESOURCES (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

SRM_S01()
Creates a new SRM_S01 message with DefaultModelClassFactory.

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

Method Summary

APR	getAPR() Returns APR (Appointment Preferences) - creates it if necessary
ARQ	getARQ() Returns ARQ (Appointment Request) - creates it if necessary
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
SRM_S01_PATIENT	getPATIENT() Returns the first repetition of PATIENT (a Group object) - creates it if necessary
SRM_S01_PATIENT	getPATIENT(int rep) Returns a specific repetition of PATIENT (a Group object) - creates it if necessary
int	getPATIENTReps() Returns the number of existing repetitions of PATIENT
SRM_S01_RESOURCES	getRESOURCES() Returns the first repetition of RESOURCES (a Group object) - creates it if necessary
SRM_S01_RESOURCES	getRESOURCES(int rep) Returns a specific repetition of RESOURCES (a Group object) - creates it if necessary
int	getRESOURCESReps() Returns the number of existing repetitions of RESOURCES
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)
SRM_S01_PATIENT	insertPATIENT(int rep) Inserts a specific repetition of PATIENT (a Group object)
void	insertPATIENT(SRM_S01_PATIENT structure, int rep) Inserts a specific repetition of PATIENT (a Group object)
SRM_S01_RESOURCES	insertRESOURCES(int rep) Inserts a specific repetition of RESOURCES (a Group object)
void	insertRESOURCES(SRM_S01_RESOURCES structure, int rep) Inserts a specific repetition of RESOURCES (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
SRM_S01_PATIENT	removePATIENT(int rep) Removes a specific repetition of PATIENT (a Group object)
SRM_S01_RESOURCES	removeRESOURCES(int rep) Removes a specific repetition of RESOURCES (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

SRM_S01

public SRM_S01()

Creates a new SRM_S01 message with DefaultModelClassFactory.

SRM_S01

public SRM_S01(ModelClassFactory factory)

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

getARQ

public ARQ getARQ()

Returns ARQ (Appointment Request) - creates it if necessary

getAPR

public APR getAPR()

Returns APR (Appointment Preferences) - 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 SRM_S01_PATIENT getPATIENT()

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

getPATIENT

public SRM_S01_PATIENT getPATIENT(int rep)

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

getPATIENTReps

public int getPATIENTReps()

Returns the number of existing repetitions of PATIENT

insertPATIENT

public void insertPATIENT(SRM_S01_PATIENT structure,
                          int rep)
                   throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPATIENT

public SRM_S01_PATIENT insertPATIENT(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePATIENT

public SRM_S01_PATIENT removePATIENT(int rep)
                              throws HL7Exception

Removes a specific repetition of PATIENT (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getRESOURCES

public SRM_S01_RESOURCES getRESOURCES()

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

getRESOURCES

public SRM_S01_RESOURCES getRESOURCES(int rep)

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

getRESOURCESReps

public int getRESOURCESReps()

Returns the number of existing repetitions of RESOURCES

insertRESOURCES

public void insertRESOURCES(SRM_S01_RESOURCES structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertRESOURCES

public SRM_S01_RESOURCES insertRESOURCES(int rep)
                                  throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeRESOURCES

public SRM_S01_RESOURCES removeRESOURCES(int rep)
                                  throws HL7Exception

Removes a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)