ca.uhn.hl7v2.model.v26.message

Class PEX_P07

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.PEX_P07

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class PEX_P07
extends AbstractMessage

Represents a PEX_P07 message structure (see chapter 7.11.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: EVN (Event Type)
• 5: PID (Patient Identification)
• 6: PD1 (Patient Additional Demographic) optional
• 7: NTE (Notes and Comments) optional repeating
• 8: PEX_P07_VISIT (a Group object) optional
• 9: PEX_P07_EXPERIENCE (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
PEX_P07() Creates a new PEX_P07 message with DefaultModelClassFactory.
PEX_P07(ModelClassFactory factory) Creates a new PEX_P07 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
EVN	getEVN() Returns EVN (Event Type) - creates it if necessary
PEX_P07_EXPERIENCE	getEXPERIENCE() Returns the first repetition of EXPERIENCE (a Group object) - creates it if necessary
PEX_P07_EXPERIENCE	getEXPERIENCE(int rep) Returns a specific repetition of EXPERIENCE (a Group object) - creates it if necessary
List<PEX_P07_EXPERIENCE>	getEXPERIENCEAll() Returns a non-modifiable List containing all current existing repetitions of EXPERIENCE.
int	getEXPERIENCEReps() Returns the number of existing repetitions of EXPERIENCE
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
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
PD1	getPD1() Returns PD1 (Patient Additional Demographic) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
PEX_P07_VISIT	getVISIT() Returns VISIT (a Group object) - creates it if necessary
PEX_P07_EXPERIENCE	insertEXPERIENCE(int rep) Inserts a specific repetition of EXPERIENCE (a Group object)
void	insertEXPERIENCE(PEX_P07_EXPERIENCE structure, int rep) Inserts a specific repetition of EXPERIENCE (a Group object)
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)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
PEX_P07_EXPERIENCE	removeEXPERIENCE(int rep) Removes a specific repetition of EXPERIENCE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

PEX_P07

public PEX_P07()

Creates a new PEX_P07 message with DefaultModelClassFactory.

PEX_P07

public PEX_P07(ModelClassFactory factory)

Creates a new PEX_P07 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getEVN

public EVN getEVN()

Returns EVN (Event Type) - creates it if necessary

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (Patient Additional Demographic) - 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

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 (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)

getVISIT

public PEX_P07_VISIT getVISIT()

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

getEXPERIENCE

public PEX_P07_EXPERIENCE getEXPERIENCE()

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

getEXPERIENCE

public PEX_P07_EXPERIENCE getEXPERIENCE(int rep)

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

getEXPERIENCEReps

public int getEXPERIENCEReps()

Returns the number of existing repetitions of EXPERIENCE

getEXPERIENCEAll

public List<PEX_P07_EXPERIENCE> getEXPERIENCEAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertEXPERIENCE

public void insertEXPERIENCE(PEX_P07_EXPERIENCE structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of EXPERIENCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertEXPERIENCE

public PEX_P07_EXPERIENCE insertEXPERIENCE(int rep)
                                    throws HL7Exception

Inserts a specific repetition of EXPERIENCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeEXPERIENCE

public PEX_P07_EXPERIENCE removeEXPERIENCE(int rep)
                                    throws HL7Exception

Removes a specific repetition of EXPERIENCE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)