Package ca.uhn.hl7v2.model.v251.message

Class PMU_B01

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.PMU_B01

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class PMU_B01
extends AbstractMessage

Represents a PMU_B01 message structure (see chapter 15.3.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EVN (Event Type)
• 4: STF (Staff Identification)
• 5: PRA (Practitioner Detail) optional repeating
• 6: ORG (Practitioner Organization Unit) optional repeating
• 7: AFF (Professional Affiliation) optional repeating
• 8: LAN (Language Detail) optional repeating
• 9: EDU (Educational Detail) optional repeating
• 10: CER (Certificate Detail) optional repeating

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
PMU_B01()	Creates a new PMU_B01 message with DefaultModelClassFactory.
PMU_B01(ModelClassFactory factory)	Creates a new PMU_B01 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
AFF	getAFF()	Returns the first repetition of AFF (Professional Affiliation) - creates it if necessary
AFF	getAFF(int rep)	Returns a specific repetition of AFF (Professional Affiliation) - creates it if necessary
List<AFF>	getAFFAll()	Returns a non-modifiable List containing all current existing repetitions of AFF.
int	getAFFReps()	Returns the number of existing repetitions of AFF
CER	getCER()	Returns the first repetition of CER (Certificate Detail) - creates it if necessary
CER	getCER(int rep)	Returns a specific repetition of CER (Certificate Detail) - creates it if necessary
List<CER>	getCERAll()	Returns a non-modifiable List containing all current existing repetitions of CER.
int	getCERReps()	Returns the number of existing repetitions of CER
EDU	getEDU()	Returns the first repetition of EDU (Educational Detail) - creates it if necessary
EDU	getEDU(int rep)	Returns a specific repetition of EDU (Educational Detail) - creates it if necessary
List<EDU>	getEDUAll()	Returns a non-modifiable List containing all current existing repetitions of EDU.
int	getEDUReps()	Returns the number of existing repetitions of EDU
EVN	getEVN()	Returns EVN (Event Type) - creates it if necessary
LAN	getLAN()	Returns the first repetition of LAN (Language Detail) - creates it if necessary
LAN	getLAN(int rep)	Returns a specific repetition of LAN (Language Detail) - creates it if necessary
List<LAN>	getLANAll()	Returns a non-modifiable List containing all current existing repetitions of LAN.
int	getLANReps()	Returns the number of existing repetitions of LAN
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
ORG	getORG()	Returns the first repetition of ORG (Practitioner Organization Unit) - creates it if necessary
ORG	getORG(int rep)	Returns a specific repetition of ORG (Practitioner Organization Unit) - creates it if necessary
List<ORG>	getORGAll()	Returns a non-modifiable List containing all current existing repetitions of ORG.
int	getORGReps()	Returns the number of existing repetitions of ORG
PRA	getPRA()	Returns the first repetition of PRA (Practitioner Detail) - creates it if necessary
PRA	getPRA(int rep)	Returns a specific repetition of PRA (Practitioner Detail) - creates it if necessary
List<PRA>	getPRAAll()	Returns a non-modifiable List containing all current existing repetitions of PRA.
int	getPRAReps()	Returns the number of existing repetitions of PRA
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
STF	getSTF()	Returns STF (Staff Identification) - creates it if necessary
String	getVersion()	Returns "2.5.1"
AFF	insertAFF(int rep)	Inserts a specific repetition of AFF (Professional Affiliation)
void	insertAFF(AFF structure, int rep)	Inserts a specific repetition of AFF (Professional Affiliation)
CER	insertCER(int rep)	Inserts a specific repetition of CER (Certificate Detail)
void	insertCER(CER structure, int rep)	Inserts a specific repetition of CER (Certificate Detail)
EDU	insertEDU(int rep)	Inserts a specific repetition of EDU (Educational Detail)
void	insertEDU(EDU structure, int rep)	Inserts a specific repetition of EDU (Educational Detail)
LAN	insertLAN(int rep)	Inserts a specific repetition of LAN (Language Detail)
void	insertLAN(LAN structure, int rep)	Inserts a specific repetition of LAN (Language Detail)
ORG	insertORG(int rep)	Inserts a specific repetition of ORG (Practitioner Organization Unit)
void	insertORG(ORG structure, int rep)	Inserts a specific repetition of ORG (Practitioner Organization Unit)
PRA	insertPRA(int rep)	Inserts a specific repetition of PRA (Practitioner Detail)
void	insertPRA(PRA structure, int rep)	Inserts a specific repetition of PRA (Practitioner Detail)
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)
AFF	removeAFF(int rep)	Removes a specific repetition of AFF (Professional Affiliation)
CER	removeCER(int rep)	Removes a specific repetition of CER (Certificate Detail)
EDU	removeEDU(int rep)	Removes a specific repetition of EDU (Educational Detail)
LAN	removeLAN(int rep)	Removes a specific repetition of LAN (Language Detail)
ORG	removeORG(int rep)	Removes a specific repetition of ORG (Practitioner Organization Unit)
PRA	removePRA(int rep)	Removes a specific repetition of PRA (Practitioner Detail)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, 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 Details

PMU_B01

public PMU_B01()

Creates a new PMU_B01 message with DefaultModelClassFactory.

PMU_B01

public PMU_B01(ModelClassFactory factory)

Creates a new PMU_B01 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

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)

getEVN

public EVN getEVN()

Returns EVN (Event Type) - creates it if necessary

getSTF

public STF getSTF()

Returns STF (Staff Identification) - creates it if necessary

getPRA

public PRA getPRA()

Returns the first repetition of PRA (Practitioner Detail) - creates it if necessary

getPRA

public PRA getPRA(int rep)

Returns a specific repetition of PRA (Practitioner Detail) - 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.

getPRAReps

public int getPRAReps()

Returns the number of existing repetitions of PRA

getPRAAll

public List<PRA> getPRAAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPRA

public void insertPRA(PRA structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of PRA (Practitioner Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPRA

public PRA insertPRA(int rep)
              throws HL7Exception

Inserts a specific repetition of PRA (Practitioner Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePRA

public PRA removePRA(int rep)
              throws HL7Exception

Removes a specific repetition of PRA (Practitioner Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getORG

public ORG getORG()

Returns the first repetition of ORG (Practitioner Organization Unit) - creates it if necessary

getORG

public ORG getORG(int rep)

Returns a specific repetition of ORG (Practitioner Organization Unit) - 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.

getORGReps

public int getORGReps()

Returns the number of existing repetitions of ORG

getORGAll

public List<ORG> getORGAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertORG

public void insertORG(ORG structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORG

public ORG insertORG(int rep)
              throws HL7Exception

Inserts a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORG

public ORG removeORG(int rep)
              throws HL7Exception

Removes a specific repetition of ORG (Practitioner Organization Unit)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getAFF

public AFF getAFF()

Returns the first repetition of AFF (Professional Affiliation) - creates it if necessary

getAFF

public AFF getAFF(int rep)

Returns a specific repetition of AFF (Professional Affiliation) - 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.

getAFFReps

public int getAFFReps()

Returns the number of existing repetitions of AFF

getAFFAll

public List<AFF> getAFFAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAFF

public void insertAFF(AFF structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertAFF

public AFF insertAFF(int rep)
              throws HL7Exception

Inserts a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeAFF

public AFF removeAFF(int rep)
              throws HL7Exception

Removes a specific repetition of AFF (Professional Affiliation)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getLAN

public LAN getLAN()

Returns the first repetition of LAN (Language Detail) - creates it if necessary

getLAN

public LAN getLAN(int rep)

Returns a specific repetition of LAN (Language Detail) - 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.

getLANReps

public int getLANReps()

Returns the number of existing repetitions of LAN

getLANAll

public List<LAN> getLANAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertLAN

public void insertLAN(LAN structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertLAN

public LAN insertLAN(int rep)
              throws HL7Exception

Inserts a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeLAN

public LAN removeLAN(int rep)
              throws HL7Exception

Removes a specific repetition of LAN (Language Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getEDU

public EDU getEDU()

Returns the first repetition of EDU (Educational Detail) - creates it if necessary

getEDU

public EDU getEDU(int rep)

Returns a specific repetition of EDU (Educational Detail) - 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.

getEDUReps

public int getEDUReps()

Returns the number of existing repetitions of EDU

getEDUAll

public List<EDU> getEDUAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertEDU

public void insertEDU(EDU structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertEDU

public EDU insertEDU(int rep)
              throws HL7Exception

Inserts a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeEDU

public EDU removeEDU(int rep)
              throws HL7Exception

Removes a specific repetition of EDU (Educational Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getCER

public CER getCER()

Returns the first repetition of CER (Certificate Detail) - creates it if necessary

getCER

public CER getCER(int rep)

Returns a specific repetition of CER (Certificate Detail) - 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.

getCERReps

public int getCERReps()

Returns the number of existing repetitions of CER

getCERAll

public List<CER> getCERAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCER

public void insertCER(CER structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of CER (Certificate Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCER

public CER insertCER(int rep)
              throws HL7Exception

Inserts a specific repetition of CER (Certificate Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCER

public CER removeCER(int rep)
              throws HL7Exception

Removes a specific repetition of CER (Certificate Detail)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)