cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StudySchedulingModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudySchedulingModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StudySchedulingModule
extends Module

\* This module specifies the Attributes that describe Study Scheduling Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StudySchedulingModule(IDataSet objIDataSet) Instantiates a new study scheduling module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getReasonForStudy() Retrieves the reason for performing study.
java.lang.String	getRequestedContrastAgent() Retrieves Contrast agent requested for use in the procedure.
RequestedProcedureCodeSequence	getRequestedProcedureCodeSequence() Retrieves pre-initialized object of Requested Procedure Code Sequence.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
java.lang.String	getRequestedProcedureDescription() Retrieves Institution-generated description or classification of requested procedure.
java.lang.String	getRequestingPhysician() Retrieves Name of the physician who requested the study.
RequestingPhysicianIdentificationSequence	getRequestingPhysicianIdentificationSequence() Retrieves pre-initialized object of Requesting Physician Identification Sequence.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
java.lang.String	getRequestingService() Retrieves Institutional department where the request initiated.
java.lang.String	getScheduledStudyLocation() Retrieves User-defined location at which the study will be performed.
java.lang.String[]	getScheduledStudyLocationAETitles() Retrieves A list of Application Entity Title(s) of the location at which the study will be performed.
java.lang.String	getScheduledStudyStartDate() Retrieves Date on which the study is scheduled to start.
java.lang.String	getScheduledStudyStartTime() Retrieves Time at which the study is scheduled to start.
java.lang.String	getScheduledStudyStopDate() Retrieves Date on which the patient examination for the study is scheduled to end.
java.lang.String	getScheduledStudyStopTime() Retrieves Time at which the patient examination for the study is scheduled to end.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setReasonForStudy(java.lang.String strReasonForStudy) Sets Describes the reason for performing study.
void	setRequestedContrastAgent(java.lang.String strRequestedContrastAgent) Sets Contrast agent requested for use in the procedure.
void	setRequestedProcedureDescription(java.lang.String strRequestedProcedureDescription) Sets Institution-generated description or classification of requested procedure.
void	setRequestingPhysician(java.lang.String strRequestingPhysician) Sets Name of the physician who requested the study.
void	setRequestingService(java.lang.String strRequestingService) Sets Institutional department where the request initiated.
void	setScheduledStudyLocation(java.lang.String strScheduledStudyLocation) Sets User-defined location at which the study will be performed.
void	setScheduledStudyLocationAETitles(java.lang.String[] arrStrScheduledStudyLocationAETitles) Sets A list of Application Entity Title(s) of the location at which the study will be performed.
void	setScheduledStudyStartDate(java.lang.String strScheduledStudyStartDate) Sets Date on which the study is scheduled to start.
void	setScheduledStudyStartTime(java.lang.String strScheduledStudyStartTime) Sets Time at which the study is scheduled to start.
void	setScheduledStudyStopDate(java.lang.String strScheduledStudyStopDate) Sets Date on which the patient examination for the study is scheduled to end.
void	setScheduledStudyStopTime(java.lang.String strScheduledStudyStopTime) Sets Time at which the patient examination for the study is scheduled to end.
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

StudySchedulingModule

public StudySchedulingModule(IDataSet objIDataSet)

Instantiates a new study scheduling module.

Parameters:

objIDataSet - the obj i data set

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

setScheduledStudyStartDate

public void setScheduledStudyStartDate(java.lang.String strScheduledStudyStartDate)

Sets Date on which the study is scheduled to start.

Parameters:

strScheduledStudyStartDate - String value of Scheduled Study Start Date.

setScheduledStudyStartTime

public void setScheduledStudyStartTime(java.lang.String strScheduledStudyStartTime)

Sets Time at which the study is scheduled to start.

Parameters:

strScheduledStudyStartTime - String value of Scheduled Study Start Time.

setScheduledStudyStopDate

public void setScheduledStudyStopDate(java.lang.String strScheduledStudyStopDate)

Sets Date on which the patient examination for the study is scheduled to end.

Parameters:

strScheduledStudyStopDate - String value of Scheduled Study Stop Date.

setScheduledStudyStopTime

public void setScheduledStudyStopTime(java.lang.String strScheduledStudyStopTime)

Sets Time at which the patient examination for the study is scheduled to end.

Parameters:

strScheduledStudyStopTime - String value of Scheduled Study Stop Time.

setScheduledStudyLocation

public void setScheduledStudyLocation(java.lang.String strScheduledStudyLocation)

Sets User-defined location at which the study will be performed.

Parameters:

strScheduledStudyLocation - String value of Scheduled Study Location

setScheduledStudyLocationAETitles

public void setScheduledStudyLocationAETitles(java.lang.String[] arrStrScheduledStudyLocationAETitles)

Sets A list of Application Entity Title(s) of the location at which the study will be performed.

Parameters:

arrStrScheduledStudyLocationAETitles - String value of Scheduled Study Location AE Titles.

setReasonForStudy

public void setReasonForStudy(java.lang.String strReasonForStudy)

Sets Describes the reason for performing study.

Parameters:

strReasonForStudy - String value of Reason For Study.

setRequestingPhysician

public void setRequestingPhysician(java.lang.String strRequestingPhysician)

Sets Name of the physician who requested the study.

Parameters:

strRequestingPhysician - String value of Requesting Physician.

setRequestingService

public void setRequestingService(java.lang.String strRequestingService)

Sets Institutional department where the request initiated.

Parameters:

strRequestingService - String value of Requesting Service.

setRequestedProcedureDescription

public void setRequestedProcedureDescription(java.lang.String strRequestedProcedureDescription)

Sets Institution-generated description or classification of requested procedure.

Parameters:

strRequestedProcedureDescription - String value of Requested Procedure Description.

setRequestedContrastAgent

public void setRequestedContrastAgent(java.lang.String strRequestedContrastAgent)

Sets Contrast agent requested for use in the procedure.

Parameters:

strRequestedContrastAgent - String value of Requested Contrast Agent.

getScheduledStudyStartDate

public java.lang.String getScheduledStudyStartDate()

Retrieves Date on which the study is scheduled to start.

Returns:

String - String value of Scheduled Study Start Date.

getScheduledStudyStartTime

public java.lang.String getScheduledStudyStartTime()

Retrieves Time at which the study is scheduled to start.

Returns:

String - String value of Scheduled Study Start Time.

getScheduledStudyStopDate

public java.lang.String getScheduledStudyStopDate()

Retrieves Date on which the patient examination for the study is scheduled to end.

Returns:

String - String value of Scheduled Study Stop Date.

getScheduledStudyStopTime

public java.lang.String getScheduledStudyStopTime()

Retrieves Time at which the patient examination for the study is scheduled to end.

Returns:

String - String value of Scheduled Study Stop Time.

getScheduledStudyLocation

public java.lang.String getScheduledStudyLocation()

Retrieves User-defined location at which the study will be performed.

Returns:

String - String value of Scheduled Study Location.

getScheduledStudyLocationAETitles

public java.lang.String[] getScheduledStudyLocationAETitles()

Retrieves A list of Application Entity Title(s) of the location at which the study will be performed.

Returns:

String[] - String array of Scheduled Study Location AE Titles.

getReasonForStudy

public java.lang.String getReasonForStudy()

Retrieves the reason for performing study.

Returns:

String - String value of Reason For Study.

getRequestingPhysician

public java.lang.String getRequestingPhysician()

Retrieves Name of the physician who requested the study.

Returns:

String - String value of Requesting Physician.

getRequestingService

public java.lang.String getRequestingService()

Retrieves Institutional department where the request initiated.

Returns:

String - String value of Requested Procedure Description.

getRequestedProcedureDescription

public java.lang.String getRequestedProcedureDescription()

Retrieves Institution-generated description or classification of requested procedure.

Returns:

String - String value of Requested Procedure Description.

getRequestedContrastAgent

public java.lang.String getRequestedContrastAgent()

Retrieves Contrast agent requested for use in the procedure.

Returns:

String - String value of Requested Contrast Agent

getRequestedProcedureCodeSequence

public RequestedProcedureCodeSequence getRequestedProcedureCodeSequence()

Retrieves pre-initialized object of Requested Procedure Code Sequence.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:

RequestedProcedureCodeSequence - instance of Requested Procedure Code Sequence.

getRequestingPhysicianIdentificationSequence

public RequestingPhysicianIdentificationSequence getRequestingPhysicianIdentificationSequence()

Retrieves pre-initialized object of Requesting Physician Identification Sequence.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:

RequestingPhysicianIdentificationSequence - instance of Requesting Physician Identification Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags