ca.uhn.hl7v2.model.v231.message

Class SUR_P09

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.SUR_P09

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SUR_P09
extends AbstractMessage

Represents a SUR_P09 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: SUR_P09_FACPSHPDCPSHFACPDCNTE (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
SUR_P09() Creates a new SUR_P09 message with DefaultModelClassFactory.
SUR_P09(ModelClassFactory factory) Creates a new SUR_P09 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
SUR_P09_FACPSHPDCPSHFACPDCNTE	getFACPSHPDCPSHFACPDCNTE() Returns the first repetition of FACPSHPDCPSHFACPDCNTE (a Group object) - creates it if necessary
SUR_P09_FACPSHPDCPSHFACPDCNTE	getFACPSHPDCPSHFACPDCNTE(int rep) Returns a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object) - creates it if necessary
List<SUR_P09_FACPSHPDCPSHFACPDCNTE>	getFACPSHPDCPSHFACPDCNTEAll() Returns a non-modifiable List containing all current existing repetitions of FACPSHPDCPSHFACPDCNTE.
int	getFACPSHPDCPSHFACPDCNTEReps() Returns the number of existing repetitions of FACPSHPDCPSHFACPDCNTE
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
SUR_P09_FACPSHPDCPSHFACPDCNTE	insertFACPSHPDCPSHFACPDCNTE(int rep) Inserts a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object)
void	insertFACPSHPDCPSHFACPDCNTE(SUR_P09_FACPSHPDCPSHFACPDCNTE structure, int rep) Inserts a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object)
SUR_P09_FACPSHPDCPSHFACPDCNTE	removeFACPSHPDCPSHFACPDCNTE(int rep) Removes a specific repetition of FACPSHPDCPSHFACPDCNTE (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

SUR_P09

public SUR_P09()

Creates a new SUR_P09 message with DefaultModelClassFactory.

SUR_P09

public SUR_P09(ModelClassFactory factory)

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

getFACPSHPDCPSHFACPDCNTE

public SUR_P09_FACPSHPDCPSHFACPDCNTE getFACPSHPDCPSHFACPDCNTE()

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

getFACPSHPDCPSHFACPDCNTE

public SUR_P09_FACPSHPDCPSHFACPDCNTE getFACPSHPDCPSHFACPDCNTE(int rep)

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

getFACPSHPDCPSHFACPDCNTEReps

public int getFACPSHPDCPSHFACPDCNTEReps()

Returns the number of existing repetitions of FACPSHPDCPSHFACPDCNTE

getFACPSHPDCPSHFACPDCNTEAll

public List<SUR_P09_FACPSHPDCPSHFACPDCNTE> getFACPSHPDCPSHFACPDCNTEAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertFACPSHPDCPSHFACPDCNTE

public void insertFACPSHPDCPSHFACPDCNTE(SUR_P09_FACPSHPDCPSHFACPDCNTE structure,
                               int rep)
                                 throws HL7Exception

Inserts a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFACPSHPDCPSHFACPDCNTE

public SUR_P09_FACPSHPDCPSHFACPDCNTE insertFACPSHPDCPSHFACPDCNTE(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFACPSHPDCPSHFACPDCNTE

public SUR_P09_FACPSHPDCPSHFACPDCNTE removeFACPSHPDCPSHFACPDCNTE(int rep)
                                                          throws HL7Exception

Removes a specific repetition of FACPSHPDCPSHFACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)