ca.uhn.hl7v2.model.v23.message

Class PPR_PC1

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.PPR_PC1

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class PPR_PC1
extends AbstractMessage

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

• 1: MSH (Message header segment)
• 2: PID (Patient Identification)
• 3: PPR_PC1_PATIENT_VISIT (a Group object) optional
• 4: PPR_PC1_PROBLEM (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
PPR_PC1() Creates a new PPR_PC1 message with DefaultModelClassFactory.
PPR_PC1(ModelClassFactory factory) Creates a new PPR_PC1 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message header segment) - creates it if necessary
PPR_PC1_PATIENT_VISIT	getPATIENT_VISIT() Returns PATIENT_VISIT (a Group object) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
PPR_PC1_PROBLEM	getPROBLEM() Returns the first repetition of PROBLEM (a Group object) - creates it if necessary
PPR_PC1_PROBLEM	getPROBLEM(int rep) Returns a specific repetition of PROBLEM (a Group object) - creates it if necessary
List<PPR_PC1_PROBLEM>	getPROBLEMAll() Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
int	getPROBLEMReps() Returns the number of existing repetitions of PROBLEM
String	getVersion() Returns "2.3"
PPR_PC1_PROBLEM	insertPROBLEM(int rep) Inserts a specific repetition of PROBLEM (a Group object)
void	insertPROBLEM(PPR_PC1_PROBLEM structure, int rep) Inserts a specific repetition of PROBLEM (a Group object)
PPR_PC1_PROBLEM	removePROBLEM(int rep) Removes a specific repetition of PROBLEM (a Group object)

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

accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, setValidationContext, toString

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

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Detail

PPR_PC1

public PPR_PC1()

Creates a new PPR_PC1 message with DefaultModelClassFactory.

PPR_PC1

public PPR_PC1(ModelClassFactory factory)

Creates a new PPR_PC1 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPATIENT_VISIT

public PPR_PC1_PATIENT_VISIT getPATIENT_VISIT()

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

getPROBLEM

public PPR_PC1_PROBLEM getPROBLEM()

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

getPROBLEM

public PPR_PC1_PROBLEM getPROBLEM(int rep)

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

getPROBLEMReps

public int getPROBLEMReps()

Returns the number of existing repetitions of PROBLEM

getPROBLEMAll

public List<PPR_PC1_PROBLEM> getPROBLEMAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPROBLEM

public void insertPROBLEM(PPR_PC1_PROBLEM structure,
                 int rep)
                   throws HL7Exception

Inserts a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPROBLEM

public PPR_PC1_PROBLEM insertPROBLEM(int rep)
                              throws HL7Exception

Inserts a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePROBLEM

public PPR_PC1_PROBLEM removePROBLEM(int rep)
                              throws HL7Exception

Removes a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)