cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralStudyModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralStudyModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralStudyModule
extends Module

\* The class GeneralStudyModule.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeneralStudyModule(IDataSet objIDataSet) Instantiates a new general study module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessionNumber() Gets the accession number.
ConsultingPhysicianIdentificationSequence	getConsultingPhysicianIdentificationSequence() This method Returns provides the pre-initialized object of Consulting Physician Identification Sequence return - object of Consulting Physician Identification Sequence.
java.lang.String	getConsultingPhysiciansName() Gets the Consulting Physicians Name.
IssuerofAccessionNumberSequence	getIssuerofAccessionNumberSequence() This method provides the pre-initialized object of Issuer of Accession Number Sequence.
java.lang.String[]	getNameOfPhysicianReadingStudy() Gets the name of physician reading study.
java.lang.String[]	getPhysicianOfRecord() Gets the physician of record.
PhysiciansOfRecordIdentificationSequence	getPhysiciansOfRecordIdentificationSequence() This method Returns provides the pre-initialized object of Physicians Of Record Identification Sequence return - object of Physicians Of Record Identification Sequence.
PhysiciansReadingStudyIdentificationSequence	getPhysiciansReadingStudyIdentificationSequence() This method Returns provides the pre-initialized object of Physicians Reading Study Identification Sequence return - object of Physicians Reading Study Identification Sequence.
ProcedureCodeSequence	getProcedureCodeSequence() This method Returns provides the pre-initialized object of Procedure Code Sequence return - object of Procedure Code Sequence.
ReasonForPerformedProcedureCodeSequence	getReasonForPerformedProcedureCodeSequence() This method provides the pre-initialized object of Reason For Performed Procedure Code Sequence.
ReferencedStudySequence	getReferencedStudySequence() This method Returns provides the pre-initialized object of Referenced Study Sequence return - object of Referenced Study Sequence.
ReferringPhysicianIdentificationSequence	getReferringPhysicianIDSequence() This method Returns provides the pre-initialized object of Referring Physician Identification Sequence return - object of Referring Physician Identification Sequence.
java.lang.String	getReferringPhysicianName() Gets the referring physician name.
RequestingServiceCodeSequence	getRequestingServiceCodeSequence() This method provides the pre-initialized object of Requesting Service Code Sequence.
java.lang.String	getStudyDate() Gets the study date.
java.lang.String	getStudyDescription() Gets the study description.
java.lang.String	getStudyID() Gets the study id.
java.lang.String	getStudyInstanceUID() Gets the study instance uid.
java.lang.String	getStudyTime() Gets the study time.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setAccessionNumber(java.lang.String strAccessionNumber) The method is used to set A RIS generated number that identifies the order for the Study The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values.
void	setConsultingPhysiciansName(java.lang.String strConsultingPhysiciansName) The method is used to set Name of the patient's Consulting Physicians.
void	setNameOfPhysicianReadingStudy(java.lang.String[] arrStrNameOfPhysicianReadingStudy) This method is used to set Names of the physician(s) who are reading the Study.
void	setPhysicianOfRecord(java.lang.String[] arrStrPhysicianOfRecord) This method is used to set Names of the physician(s) who are responsible for overall patient care at time of Study The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setReferringPhysicianName(java.lang.String strReferringPhysicianName) The method is used to set Name of the patient's referring physician.
void	setStudyDate(java.lang.String strStudyDate) The method is used to set Date on which the Study started.
void	setStudyDescription(java.lang.String strStudyDescription) The method is used to set Institution-generated description or classification of the Study performed The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values.
void	setStudyID(java.lang.String strStudyID) The method is used to set User or equipment generated Study identifier.
void	setStudyInstanceUID(java.lang.String strStudyInstanceUID) The method is used to set Accept Unique identifier for the Study.
void	setStudyTime(java.lang.String strStudyTime) The method is used to set Time on which the Study started.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

GeneralStudyModule

public GeneralStudyModule(IDataSet objIDataSet)

Instantiates a new general study module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - - throws exception indicating exaxct cause of failed validation

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String strStudyInstanceUID)

The method is used to set Accept Unique identifier for the Study. The function accepts a String Value as the strStudyInstanceUID and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strStudyInstanceUID - :Unique identifier for the Study.

setStudyDate

public void setStudyDate(java.lang.String strStudyDate)

The method is used to set Date on which the Study started. The function accepts a String Value as the strStudyDate and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strStudyDate - :The Date on which the Study started.

setStudyTime

public void setStudyTime(java.lang.String strStudyTime)

The method is used to set Time on which the Study started. The function accepts a String Value as the strStudyTime and creates the DE based on the transfer syntax and populates the DE with right values.

Parameters:

strStudyTime - :The Time on which the Study started.

setReferringPhysicianName

public void setReferringPhysicianName(java.lang.String strReferringPhysicianName)

The method is used to set Name of the patient's referring physician. The function accepts a String Value as the strReferringPhysicianName and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strReferringPhysicianName - :TName of the patient's referring physician

setConsultingPhysiciansName

public void setConsultingPhysiciansName(java.lang.String strConsultingPhysiciansName)

The method is used to set Name of the patient's Consulting Physicians. The function accepts a String Value as the strConsultingPhysiciansName.

Parameters:

strConsultingPhysiciansName - :Name of the Consulting Physician

setStudyID

public void setStudyID(java.lang.String strStudyID)

The method is used to set User or equipment generated Study identifier. The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strStudyID - :TName of the patient's referring physician

setAccessionNumber

public void setAccessionNumber(java.lang.String strAccessionNumber)

The method is used to set A RIS generated number that identifies the order for the Study The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strAccessionNumber - : String variable

setStudyDescription

public void setStudyDescription(java.lang.String strStudyDescription)

The method is used to set Institution-generated description or classification of the Study performed The function accepts a String Value as User generated Study identifie the and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strStudyDescription - :Institution-generated description or classification of the Study performed

setPhysicianOfRecord

public void setPhysicianOfRecord(java.lang.String[] arrStrPhysicianOfRecord)

This method is used to set Names of the physician(s) who are responsible for overall patient care at time of Study The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrPhysicianOfRecord - :Names of the physician(s)

setNameOfPhysicianReadingStudy

public void setNameOfPhysicianReadingStudy(java.lang.String[] arrStrNameOfPhysicianReadingStudy)

This method is used to set Names of the physician(s) who are reading the Study. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrNameOfPhysicianReadingStudy - :Names of the physician(s)

getReferringPhysicianIDSequence

public ReferringPhysicianIdentificationSequence getReferringPhysicianIDSequence()

This method Returns provides the pre-initialized object of Referring Physician Identification Sequence return - object of Referring 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:

the referring physician id sequence

getPhysiciansOfRecordIdentificationSequence

public PhysiciansOfRecordIdentificationSequence getPhysiciansOfRecordIdentificationSequence()

This method Returns provides the pre-initialized object of Physicians Of Record Identification Sequence return - object of Physicians Of Record 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:

the physicians of record identification sequence

getPhysiciansReadingStudyIdentificationSequence

public PhysiciansReadingStudyIdentificationSequence getPhysiciansReadingStudyIdentificationSequence()

This method Returns provides the pre-initialized object of Physicians Reading Study Identification Sequence return - object of Physicians Reading Study 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:

the physicians reading study identification sequence

getReferencedStudySequence

public ReferencedStudySequence getReferencedStudySequence()

This method Returns provides the pre-initialized object of Referenced Study Sequence return - object of Referenced Study 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:

the referenced study sequence

getProcedureCodeSequence

public ProcedureCodeSequence getProcedureCodeSequence()

This method Returns provides the pre-initialized object of Procedure Code Sequence return - object of 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:

the procedure code sequence

getConsultingPhysicianIdentificationSequence

public ConsultingPhysicianIdentificationSequence getConsultingPhysicianIdentificationSequence()

This method Returns provides the pre-initialized object of Consulting Physician Identification Sequence return - object of Consulting 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:

the Consulting Physician Identification Sequence

getStudyID

public java.lang.String getStudyID()

Gets the study id.

Returns:

the study id

getAccessionNumber

public java.lang.String getAccessionNumber()

Gets the accession number.

Returns:

the accession number

getIssuerofAccessionNumberSequence

public IssuerofAccessionNumberSequence getIssuerofAccessionNumberSequence()

This method provides the pre-initialized object of Issuer of Accession Number Sequence.

Returns:

- object of Issuer of Accession Number 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

getRequestingServiceCodeSequence

public RequestingServiceCodeSequence getRequestingServiceCodeSequence()

This method provides the pre-initialized object of Requesting Service Code Sequence.

Returns:

- object of Requesting Service 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

getStudyDescription

public java.lang.String getStudyDescription()

Gets the study description.

Returns:

the study description

getPhysicianOfRecord

public java.lang.String[] getPhysicianOfRecord()

Gets the physician of record.

Returns:

the physician of record

getNameOfPhysicianReadingStudy

public java.lang.String[] getNameOfPhysicianReadingStudy()

Gets the name of physician reading study.

Returns:

the name of physician reading study

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Gets the study instance uid.

Returns:

the study instance uid

getStudyDate

public java.lang.String getStudyDate()

Gets the study date.

Returns:

the study date

getStudyTime

public java.lang.String getStudyTime()

Gets the study time.

Returns:

the study time

getReferringPhysicianName

public java.lang.String getReferringPhysicianName()

Gets the referring physician name.

Returns:

the referring physician name

getConsultingPhysiciansName

public java.lang.String getConsultingPhysiciansName()

Gets the Consulting Physicians Name.

Returns:

the Consulting Physicians Namee

getReasonForPerformedProcedureCodeSequence

public ReasonForPerformedProcedureCodeSequence getReasonForPerformedProcedureCodeSequence()

This method provides the pre-initialized object of Reason For Performed Procedure Code Sequence.

Returns:

- object of Reason For Performed 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

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module