public class OUL_R24 extends AbstractMessage
Represents a OUL_R24 message structure (see chapter 7.3.10). This structure contains the following elements:
log
Constructor and Description |
---|
OUL_R24()
Creates a new OUL_R24 message with DefaultModelClassFactory.
|
OUL_R24(ModelClassFactory factory)
Creates a new OUL_R24 message with custom ModelClassFactory.
|
Modifier and Type | Method and Description |
---|---|
DSC |
getDSC()
Returns
DSC (Continuation Pointer) - creates it if necessary
|
MSH |
getMSH()
Returns
MSH (Message Header) - creates it if necessary
|
NK1 |
getNK1()
Returns
the first repetition of
NK1 (Next of Kin / Associated Parties) - creates it if necessary
|
NK1 |
getNK1(int rep)
Returns a specific repetition of
NK1 (Next of Kin / Associated Parties) - creates it if necessary
|
List<NK1> |
getNK1All()
Returns a non-modifiable List containing all current existing repetitions of NK1.
|
int |
getNK1Reps()
Returns the number of existing repetitions of NK1
|
NTE |
getNTE()
Returns
NTE (Notes and Comments) - creates it if necessary
|
OUL_R24_ORDER |
getORDER()
Returns
the first repetition of
ORDER (a Group object) - creates it if necessary
|
OUL_R24_ORDER |
getORDER(int rep)
Returns a specific repetition of
ORDER (a Group object) - creates it if necessary
|
List<OUL_R24_ORDER> |
getORDERAll()
Returns a non-modifiable List containing all current existing repetitions of ORDER.
|
int |
getORDERReps()
Returns the number of existing repetitions of ORDER
|
OUL_R24_PATIENT |
getPATIENT()
Returns
PATIENT (a Group object) - 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.7"
|
NK1 |
insertNK1(int rep)
Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
|
void |
insertNK1(NK1 structure,
int rep)
Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
|
OUL_R24_ORDER |
insertORDER(int rep)
Inserts a specific repetition of ORDER (a Group object)
|
void |
insertORDER(OUL_R24_ORDER structure,
int rep)
Inserts a specific repetition of ORDER (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)
|
NK1 |
removeNK1(int rep)
Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
|
OUL_R24_ORDER |
removeORDER(int rep)
Removes a specific repetition of ORDER (a Group object)
|
SFT |
removeSFT(int rep)
Removes a specific repetition of SFT (Software Segment)
|
accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired
isEmpty, provideLocation
public OUL_R24()
public OUL_R24(ModelClassFactory factory)
public String getVersion()
getVersion
in interface Message
getVersion
in class AbstractMessage
public SFT getSFT()
Returns the first repetition of SFT (Software Segment) - creates it if necessary
public SFT getSFT(int rep)
Returns a specific repetition of SFT (Software Segment) - creates it if necessary
rep
- The repetition index (0-indexed, i.e. the first repetition is at index 0)HL7Exception
- if the repetition requested is more than one
greater than the number of existing repetitions.public int getSFTReps()
Returns the number of existing repetitions of SFT
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.
HL7Exception
public void insertSFT(SFT structure, int rep) throws HL7Exception
Inserts a specific repetition of SFT (Software Segment)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public SFT insertSFT(int rep) throws HL7Exception
Inserts a specific repetition of SFT (Software Segment)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public SFT removeSFT(int rep) throws HL7Exception
Removes a specific repetition of SFT (Software Segment)
HL7Exception
AbstractGroup.removeRepetition(String, int)
public UAC getUAC()
Returns UAC (User Authentication Credential Segment) - creates it if necessary
public OUL_R24_PATIENT getPATIENT()
Returns PATIENT (a Group object) - creates it if necessary
public NK1 getNK1()
Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
public NK1 getNK1(int rep)
Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
rep
- The repetition index (0-indexed, i.e. the first repetition is at index 0)HL7Exception
- if the repetition requested is more than one
greater than the number of existing repetitions.public int getNK1Reps()
Returns the number of existing repetitions of NK1
public List<NK1> getNK1All() throws HL7Exception
Returns a non-modifiable List containing all current existing repetitions of NK1.
Note that unlike getNK1()
, this method will not create any reps
if none are already present, so an empty list may be returned.
HL7Exception
public void insertNK1(NK1 structure, int rep) throws HL7Exception
Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public NK1 insertNK1(int rep) throws HL7Exception
Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public NK1 removeNK1(int rep) throws HL7Exception
Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
HL7Exception
AbstractGroup.removeRepetition(String, int)
public OUL_R24_ORDER getORDER()
Returns the first repetition of ORDER (a Group object) - creates it if necessary
public OUL_R24_ORDER getORDER(int rep)
Returns a specific repetition of ORDER (a Group object) - creates it if necessary
rep
- The repetition index (0-indexed, i.e. the first repetition is at index 0)HL7Exception
- if the repetition requested is more than one
greater than the number of existing repetitions.public int getORDERReps()
Returns the number of existing repetitions of ORDER
public List<OUL_R24_ORDER> getORDERAll() throws HL7Exception
Returns a non-modifiable List containing all current existing repetitions of ORDER.
Note that unlike getORDER()
, this method will not create any reps
if none are already present, so an empty list may be returned.
HL7Exception
public void insertORDER(OUL_R24_ORDER structure, int rep) throws HL7Exception
Inserts a specific repetition of ORDER (a Group object)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public OUL_R24_ORDER insertORDER(int rep) throws HL7Exception
Inserts a specific repetition of ORDER (a Group object)
HL7Exception
AbstractGroup#insertRepetition(Structure, int)
public OUL_R24_ORDER removeORDER(int rep) throws HL7Exception
Removes a specific repetition of ORDER (a Group object)
HL7Exception
AbstractGroup.removeRepetition(String, int)
Copyright © 2001–2017 University Health Network. All rights reserved.