ca.uhn.hl7v2.model.v281.message

Class DPR_O48

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v281.message.DPR_O48

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class DPR_O48
extends AbstractMessage

Represents a DPR_O48 message structure (see chapter 4.16.15). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: DPR_O48_DONOR (a Group object) optional
• 5: DPR_O48_OBRNTE (a Group object) repeating
• 6: DPR_O48_DONATION (a Group object) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DPR_O48_DONATION	getDONATION() Returns DONATION (a Group object) - creates it if necessary
DPR_O48_DONOR	getDONOR() Returns DONOR (a Group object) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
DPR_O48_OBRNTE	getOBRNTE() Returns the first repetition of OBRNTE (a Group object) - creates it if necessary
DPR_O48_OBRNTE	getOBRNTE(int rep) Returns a specific repetition of OBRNTE (a Group object) - creates it if necessary
List<DPR_O48_OBRNTE>	getOBRNTEAll() Returns a non-modifiable List containing all current existing repetitions of OBRNTE.
int	getOBRNTEReps() Returns the number of existing repetitions of OBRNTE
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.8.1"
void	insertOBRNTE(DPR_O48_OBRNTE structure, int rep) Inserts a specific repetition of OBRNTE (a Group object)
DPR_O48_OBRNTE	insertOBRNTE(int rep) Inserts a specific repetition of OBRNTE (a Group object)
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)
DPR_O48_OBRNTE	removeOBRNTE(int rep) Removes a specific repetition of OBRNTE (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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, 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

DPR_O48

public DPR_O48()

Creates a new DPR_O48 message with DefaultModelClassFactory.

DPR_O48

public DPR_O48(ModelClassFactory factory)

Creates a new DPR_O48 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.8.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)

getUAC

public UAC getUAC()

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

getDONOR

public DPR_O48_DONOR getDONOR()

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

getOBRNTE

public DPR_O48_OBRNTE getOBRNTE()

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

getOBRNTE

public DPR_O48_OBRNTE getOBRNTE(int rep)

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

getOBRNTEReps

public int getOBRNTEReps()

Returns the number of existing repetitions of OBRNTE

getOBRNTEAll

public List<DPR_O48_OBRNTE> getOBRNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertOBRNTE

public void insertOBRNTE(DPR_O48_OBRNTE structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of OBRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBRNTE

public DPR_O48_OBRNTE insertOBRNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBRNTE

public DPR_O48_OBRNTE removeOBRNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBRNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDONATION

public DPR_O48_DONATION getDONATION()

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