ca.uhn.hl7v2.model.v231.message

Class SRM_S01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.SRM_S01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SRM_S01
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: ARQ (ARQ - appointment request segment)
• 3: APR (APR - appointment preferences segment) optional
• 4: NTE (NTE - notes and comments segment) optional repeating
• 5: SRM_S01_PIDPV1PV2OBXDG1 (a Group object) optional repeating
• 6: SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (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
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

Methods

Modifier and Type	Method and Description
APR	getAPR() Returns APR (APR - appointment preferences segment) - creates it if necessary
ARQ	getARQ() Returns ARQ (ARQ - appointment request segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
SRM_S01_PIDPV1PV2OBXDG1	getPIDPV1PV2OBXDG1() Returns the first repetition of PIDPV1PV2OBXDG1 (a Group object) - creates it if necessary
SRM_S01_PIDPV1PV2OBXDG1	getPIDPV1PV2OBXDG1(int rep) Returns a specific repetition of PIDPV1PV2OBXDG1 (a Group object) - creates it if necessary
List<SRM_S01_PIDPV1PV2OBXDG1>	getPIDPV1PV2OBXDG1All() Returns a non-modifiable List containing all current existing repetitions of PIDPV1PV2OBXDG1.
int	getPIDPV1PV2OBXDG1Reps() Returns the number of existing repetitions of PIDPV1PV2OBXDG1
SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE	getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE() Returns the first repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object) - creates it if necessary
SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE	getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep) Returns a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object) - creates it if necessary
List<SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE>	getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEAll() Returns a non-modifiable List containing all current existing repetitions of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE.
int	getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEReps() Returns the number of existing repetitions of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
SRM_S01_PIDPV1PV2OBXDG1	insertPIDPV1PV2OBXDG1(int rep) Inserts a specific repetition of PIDPV1PV2OBXDG1 (a Group object)
void	insertPIDPV1PV2OBXDG1(SRM_S01_PIDPV1PV2OBXDG1 structure, int rep) Inserts a specific repetition of PIDPV1PV2OBXDG1 (a Group object)
SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE	insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep) Inserts a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object)
void	insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE structure, int rep) Inserts a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
SRM_S01_PIDPV1PV2OBXDG1	removePIDPV1PV2OBXDG1(int rep) Removes a specific repetition of PIDPV1PV2OBXDG1 (a Group object)
SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE	removeRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep) Removes a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (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

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

getARQ

public ARQ getARQ()

Returns ARQ (ARQ - appointment request segment) - creates it if necessary

getAPR

public APR getAPR()

Returns APR (APR - appointment preferences segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

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

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPIDPV1PV2OBXDG1

public SRM_S01_PIDPV1PV2OBXDG1 getPIDPV1PV2OBXDG1()

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

getPIDPV1PV2OBXDG1

public SRM_S01_PIDPV1PV2OBXDG1 getPIDPV1PV2OBXDG1(int rep)

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

getPIDPV1PV2OBXDG1Reps

public int getPIDPV1PV2OBXDG1Reps()

Returns the number of existing repetitions of PIDPV1PV2OBXDG1

getPIDPV1PV2OBXDG1All

public List<SRM_S01_PIDPV1PV2OBXDG1> getPIDPV1PV2OBXDG1All()
                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDPV1PV2OBXDG1

public void insertPIDPV1PV2OBXDG1(SRM_S01_PIDPV1PV2OBXDG1 structure,
                         int rep)
                           throws HL7Exception

Inserts a specific repetition of PIDPV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDPV1PV2OBXDG1

public SRM_S01_PIDPV1PV2OBXDG1 insertPIDPV1PV2OBXDG1(int rep)
                                              throws HL7Exception

Inserts a specific repetition of PIDPV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDPV1PV2OBXDG1

public SRM_S01_PIDPV1PV2OBXDG1 removePIDPV1PV2OBXDG1(int rep)
                                              throws HL7Exception

Removes a specific repetition of PIDPV1PV2OBXDG1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

public SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE()

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

getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

public SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep)

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

getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEReps

public int getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEReps()

Returns the number of existing repetitions of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEAll

public List<SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE> getRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTEAll()
                                                                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

public void insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE structure,
                                                 int rep)
                                                   throws HL7Exception

Inserts a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

public SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE insertRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep)
                                                                                              throws HL7Exception

Inserts a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE

public SRM_S01_RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE removeRGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE(int rep)
                                                                                              throws HL7Exception

Removes a specific repetition of RGSAISAPRNTEAIGAPRNTEAILAPRNTEAIPAPRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)