ca.uhn.hl7v2.model.v231.message
Class CRM_C01

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.CRM_C01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class CRM_C01
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: CRM_C01_PIDPV1CSRCSP (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

CRM_C01()
Creates a new CRM_C01 message with DefaultModelClassFactory.

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

Method Summary

MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
CRM_C01_PIDPV1CSRCSP	getPIDPV1CSRCSP() Returns the first repetition of PIDPV1CSRCSP (a Group object) - creates it if necessary
CRM_C01_PIDPV1CSRCSP	getPIDPV1CSRCSP(int rep) Returns a specific repetition of PIDPV1CSRCSP (a Group object) - creates it if necessary
int	getPIDPV1CSRCSPReps() Returns the number of existing repetitions of PIDPV1CSRCSP
String	getVersion() Returns "2.3.1"
void	insertPIDPV1CSRCSP(CRM_C01_PIDPV1CSRCSP structure, int rep) Inserts a specific repetition of PIDPV1CSRCSP (a Group object)
CRM_C01_PIDPV1CSRCSP	insertPIDPV1CSRCSP(int rep) Inserts a specific repetition of PIDPV1CSRCSP (a Group object)
CRM_C01_PIDPV1CSRCSP	removePIDPV1CSRCSP(int rep) Removes a specific repetition of PIDPV1CSRCSP (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

CRM_C01

public CRM_C01()

Creates a new CRM_C01 message with DefaultModelClassFactory.

CRM_C01

public CRM_C01(ModelClassFactory factory)

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

getPIDPV1CSRCSP

public CRM_C01_PIDPV1CSRCSP getPIDPV1CSRCSP()

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

getPIDPV1CSRCSP

public CRM_C01_PIDPV1CSRCSP getPIDPV1CSRCSP(int rep)

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

getPIDPV1CSRCSPReps

public int getPIDPV1CSRCSPReps()

Returns the number of existing repetitions of PIDPV1CSRCSP

insertPIDPV1CSRCSP

public void insertPIDPV1CSRCSP(CRM_C01_PIDPV1CSRCSP structure,
                               int rep)
                        throws HL7Exception

Inserts a specific repetition of PIDPV1CSRCSP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertPIDPV1CSRCSP

public CRM_C01_PIDPV1CSRCSP insertPIDPV1CSRCSP(int rep)
                                        throws HL7Exception

Inserts a specific repetition of PIDPV1CSRCSP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removePIDPV1CSRCSP

public CRM_C01_PIDPV1CSRCSP removePIDPV1CSRCSP(int rep)
                                        throws HL7Exception

Removes a specific repetition of PIDPV1CSRCSP (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)