cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SubstanceAdministrationLogModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SubstanceAdministrationLogModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SubstanceAdministrationLogModule
extends Module

\* This module specifies the Attributes that describe Substance Administration Log Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
SubstanceAdministrationLogModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
AdministrationRouteCodeSequence	getAdministrationRouteCodeSequence() Retrieves pre-initialized object of AdministrationRouteCodeSequence.
java.lang.String	getAdmissionID() Return Admission ID
IssuerOfAdmissionIDSequence	getIssuerOfAdmissionIDSequence() Retrieves pre-initialized object of IssuerOfAdmissionIDSequence.
IssuerofPatientIDMacro	getIssuerofPatientIDMacro() Get the Instance of Issuer of Patient ID Macro.Calling this method multiple times will return the same Marco instance that was created at first.
OperatorIdentificationSequence	getOperatorIdentificationSequence() Retrieves pre-initialized object of OperatorIdentificationSequence.
java.lang.String	getPatientID() Return Patient ID
java.lang.String	getPatientName() Retrieves Patient Name
java.lang.String	getProductDescription() Retrieves text description of the contrast agent, drug, or device administered.
java.lang.String[]	getProductName() Return Product Name
java.lang.String	getProductPackageIdentifier() Retrieves Identifier of the contrast agent, drug, or device administered, typically from a package bar code, RFID, or other materials managementID.
java.lang.String	getSubstanceAdministrationDateTime() Retrieves Substance Administration Date Time
java.lang.String	getSubstanceAdministrationDeviceID() Retrieves Substance Administration Device ID
java.lang.String	getSubstanceAdministrationNotes() Retrieves Substance Administration Notes
SubstanceAdministrationParameterSequence	getSubstanceAdministrationParameterSequence() Retrieves pre-initialized object of SubstanceAdministrationParameterSequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setAdmissionID(java.lang.String strAdmissionID) Sets Admission ID
void	setPatientID(java.lang.String strPatientID) Sets Patient ID
void	setPatientName(java.lang.String strPatientName) Sets Patient Name.
void	setProductDescription(java.lang.String strProductDescription) Sets the Text description of the contrast agent, drug, or device administered.
void	setProductName(java.lang.String[] strArrProductName) Sets Product Name
void	setProductPackageIdentifier(java.lang.String strProductPackageIdentifier) Sets the Identifier of the contrast agent, drug, or device administered, typically from a package bar code, RFID, or other materials managementID.
void	setSubstanceAdministrationDateTime(java.lang.String strSubstanceAdministrationDateTime) Sets the Substance Administration Date Time
void	setSubstanceAdministrationDeviceID(java.lang.String strSubstanceAdministrationDeviceID) Sets the Substance Administration Device ID
void	setSubstanceAdministrationNotes(java.lang.String strSubstanceAdministrationNotes) Sets the Substance Administration Notes
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

SubstanceAdministrationLogModule

public SubstanceAdministrationLogModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

setPatientName

public void setPatientName(java.lang.String strPatientName)

Sets Patient Name.

Parameters:

strPatientName - String Patient Name.

getPatientName

public java.lang.String getPatientName()

Retrieves Patient Name

Returns:

String - PatientName.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets Patient ID

Parameters:

strPatientID - String value of Patient ID

getPatientID

public java.lang.String getPatientID()

Return Patient ID

Returns:

String - value of Patient ID

getIssuerofPatientIDMacro

public IssuerofPatientIDMacro getIssuerofPatientIDMacro()

Get the Instance of Issuer of Patient ID Macro.Calling this method multiple times will return the same Marco instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Issuer of Patient ID Macro which the user programmer can populate

setAdmissionID

public void setAdmissionID(java.lang.String strAdmissionID)

Sets Admission ID

Parameters:

strAdmissionID - String value of Admission ID

getAdmissionID

public java.lang.String getAdmissionID()

Return Admission ID

Returns:

String - value of Admission ID

setProductPackageIdentifier

public void setProductPackageIdentifier(java.lang.String strProductPackageIdentifier)

Sets the Identifier of the contrast agent, drug, or device administered, typically from a package bar code, RFID, or other materials managementID. This ID might not be globally unique and might conflict with otherIDs used within the scope of the institution.

Parameters:

strProductPackageIdentifier -

getProductPackageIdentifier

public java.lang.String getProductPackageIdentifier()

Retrieves Identifier of the contrast agent, drug, or device administered, typically from a package bar code, RFID, or other materials managementID. This ID might not be globally unique and might conflict with otherIDs used within the scope of the institution.

Returns:

String value of ProductPackageIdentifier

setProductName

public void setProductName(java.lang.String[] strArrProductName)

Sets Product Name

Parameters:

strArrProductName - String value of Product Name

getProductName

public java.lang.String[] getProductName()

Return Product Name

Returns:

String - value of Product Name

setProductDescription

public void setProductDescription(java.lang.String strProductDescription)

Sets the Text description of the contrast agent, drug, or device administered.

Parameters:

strProductDescription - String value of text description of the contrast agent, drug, or device administered.

getProductDescription

public java.lang.String getProductDescription()

Retrieves text description of the contrast agent, drug, or device administered.

Returns:

String - value of text description of the contrast agent, drug, or device administered.

setSubstanceAdministrationDateTime

public void setSubstanceAdministrationDateTime(java.lang.String strSubstanceAdministrationDateTime)

Sets the Substance Administration Date Time

Parameters:

strSubstanceAdministrationDateTime - String value of Substance Administration Date Time

getSubstanceAdministrationDateTime

public java.lang.String getSubstanceAdministrationDateTime()

Retrieves Substance Administration Date Time

Returns:

String - value of Substance Administration Date Time

setSubstanceAdministrationNotes

public void setSubstanceAdministrationNotes(java.lang.String strSubstanceAdministrationNotes)

Sets the Substance Administration Notes

Parameters:

strSubstanceAdministrationNotes - String value of Substance Administration Notes

getSubstanceAdministrationNotes

public java.lang.String getSubstanceAdministrationNotes()

Retrieves Substance Administration Notes

Returns:

String - value of Substance Administration Notes

setSubstanceAdministrationDeviceID

public void setSubstanceAdministrationDeviceID(java.lang.String strSubstanceAdministrationDeviceID)

Sets the Substance Administration Device ID

Parameters:

strSubstanceAdministrationDeviceID - String value of Substance Administration Device ID

getSubstanceAdministrationDeviceID

public java.lang.String getSubstanceAdministrationDeviceID()

Retrieves Substance Administration Device ID

Returns:

String - value of Substance Administration Device ID

getAdministrationRouteCodeSequence

public AdministrationRouteCodeSequence getAdministrationRouteCodeSequence()

Retrieves pre-initialized object of AdministrationRouteCodeSequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

AdministrationRouteCodeSequence

getSubstanceAdministrationParameterSequence

public SubstanceAdministrationParameterSequence getSubstanceAdministrationParameterSequence()

Retrieves pre-initialized object of SubstanceAdministrationParameterSequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

SubstanceAdministrationParameterSequence

getOperatorIdentificationSequence

public OperatorIdentificationSequence getOperatorIdentificationSequence()

Retrieves pre-initialized object of OperatorIdentificationSequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

OperatorIdentificationSequence

getIssuerOfAdmissionIDSequence

public IssuerOfAdmissionIDSequence getIssuerOfAdmissionIDSequence()

Retrieves pre-initialized object of IssuerOfAdmissionIDSequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

IssuerOfAdmissionIDSequence

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

ISingleCollection - the customized collection containing the dataelement tags that beling to this module