cdac.medinfo.sdk.dcm30_04.baselibs

Class ProposedStudySequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ProposedStudySequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class ProposedStudySequenceItem
extends Item

This item class provides methods to validate, set and get the attributes in ProposedStudySequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessionNumber() Returns a RIS generated number that identifies the order for the Study.
java.lang.String	getAdditionalPatientHistory() Return Patient's additional history.
java.lang.String[]	getAdmittingDiagnosesDescription() Return Description of the admitting diagnosis(diagnoses).
java.lang.String	getEthnicGroup() Return the String value of the attribute Ethnic Group
java.lang.String[]	getNameOfPhysicianReadingStudy() Returns Names of the physician(s) who are reading the Study.
java.lang.String	getOccupation() Return Patient's Occupation.
java.lang.String[]	getOtherPatientIDs() Return the Array of String values of the attribute Other Patient IDs.
java.lang.String[]	getOtherPatientNames() Return the Array of String values of the attribute Other Patient Names.
java.lang.String	getPatientAge() Returns the String value of the attribute Patient Age.
java.lang.String	getPatientBirthDate() Return the Patient's Birth Date.
java.lang.String	getPatientBirthTime() Return Patient's Birth Time.
java.lang.String	getPatientComments() Return the String value of the attribute Patient Comments
java.lang.String	getPatientID() Return Primary hospital identification number or code for the patient.
java.lang.String	getPatientName() Return the String value of the attribute Patient Name.
java.lang.String	getPatientSex() Return the Patient Sex in Patient Module.
java.lang.String	getPatientSize() Return the String value of the attribute Patient Size.
java.lang.String	getPatientWeight() Return the String value of the attribute Patient Weight.
java.lang.String	getReferringPhysicianName() Returns name of the patient's referring physician.
java.lang.String	getSeriesNumber() Retruns the Series Number in General Series Module.
java.lang.String	getStudyDate() Returns date on which the Study started.
java.lang.String	getStudyDescription() Returns Institution-generated description or classification of the Study performed.
java.lang.String	getStudyID() Returns User or equipment generated Study identifier.
java.lang.String	getStudyInstanceUID() Returns Unique identifier for the Study.
java.lang.String	getStudyTime() Returns time on which the Study started.
void	setAccessionNumber(java.lang.String strAccessionNumber) Sets a RIS generated number that identifies the order for the Study
void	setAdditionalPatientHistory(java.lang.String strAdditionalPatientHistory) Sets the Additional Patient History in Patient Study Module.
void	setAdmittingDiagnosesDescription(java.lang.String[] arrStrAdmittingDiagnosesDescription) Sets the Description of the admitting diagnosis (diagnoses).
void	setEthnicGroup(java.lang.String strEthnicGroup) This method is used to set the Ethnic Group in Patient Module.
void	setNameOfPhysicianReadingStudy(java.lang.String[] arrStrNameOfPhysicianReadingStudy) Sets Names of the physician(s) who are reading the Study.
void	setOccupation(java.lang.String strOccupation) Sets the Patient's Occupation.
void	setOtherPatientIDs(java.lang.String[] arrStrOtherPatientIDs) Sets the Other Patient IDs in Patient Module.
void	setOtherPatientNames(java.lang.String[] arrStrOtherPatientNames) Sets the Other Patient Names in Patient Module.
void	setPatientAge(java.lang.String strPatientAge) Sets the Age of the Patient.
void	setPatientBirthDate(java.lang.String strPatientBirthDate) Sets the Patient Birth Date in Patient Module.
void	setPatientBirthTime(java.lang.String strPatientBirthTime) Sets the Patient Birth Time in Patient Module.
void	setPatientComments(java.lang.String strPatientComments) Sets the Patient Comments in Patient Module.
void	setPatientID(java.lang.String strPatientID) Sets the Primary hospital identification number or code for the patient in Patient Module.
void	setPatientName(java.lang.String strPatientName) Sets the Patient Name in Patient Module.
void	setPatientSex(EnumPatientsSex enumPatientSex) Sets the Patient Sex in Patient Module.
void	setPatientSize(java.lang.String strPatientSize) Sets the Patient Size.
void	setPatientWeight(java.lang.String strPatientWeight) Sets the Patient Weight.
void	setReferringPhysicianName(java.lang.String strReferringPhysicianName) Sets Name of the patient's referring physician.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets the Series Number in General Series Module.
void	setStudyDate(java.lang.String strStudyDate) Sets date on which the Study started.
void	setStudyDescription(java.lang.String strStudyDescription) Sets Institution-generated description or classification of the Study performed.
void	setStudyID(java.lang.String strStudyID) Sets User or equipment generated Study identifier.
void	setStudyInstanceUID(java.lang.String strStudyInstanceUID) Sets Unique identifier for the Study.
void	setStudyTime(java.lang.String strStudyTime) Sets time on which the Study started.
boolean	validateForModule() Validates all the attributes in Proposed Study Sequence that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws ValidationException

Validates all the attributes in Proposed Study Sequence that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

ValidationException - throws ValidationException If Mandatory or Conditional element fails.

setPatientName

public void setPatientName(java.lang.String strPatientName)

Sets the Patient Name in Patient Module.

Parameters:

strPatientName - String value of Patient's full name.

getPatientName

public java.lang.String getPatientName()

Return the String value of the attribute Patient Name.

Returns:

String - value of Patient'n full name.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets the Primary hospital identification number or code for the patient in Patient Module.

Parameters:

strPatientID - String value of Patient ID.

getPatientID

public java.lang.String getPatientID()

Return Primary hospital identification number or code for the patient.

Returns:

String - value of Patient ID.

setPatientBirthDate

public void setPatientBirthDate(java.lang.String strPatientBirthDate)

Sets the Patient Birth Date in Patient Module.

Parameters:

strPatientBirthDate - String value of Birth date of the patient.

getPatientBirthDate

public java.lang.String getPatientBirthDate()

Return the Patient's Birth Date.

Returns:

String - value of the birth date of the patient.

setPatientSex

public void setPatientSex(EnumPatientsSex enumPatientSex)

Sets the Patient Sex in Patient Module.

Parameters:

enumPatientSex - Enum value of sex of the patient.

getPatientSex

public java.lang.String getPatientSex()

Return the Patient Sex in Patient Module.

Returns:

String value of sex of the patient.

setPatientBirthTime

public void setPatientBirthTime(java.lang.String strPatientBirthTime)

Sets the Patient Birth Time in Patient Module.

Parameters:

strPatientBirthTime - String value of Birth time of the Patient.

getPatientBirthTime

public java.lang.String getPatientBirthTime()

Return Patient's Birth Time.

Returns:

String - value of Birth time of the patient.

setOtherPatientIDs

public void setOtherPatientIDs(java.lang.String[] arrStrOtherPatientIDs)

Sets the Other Patient IDs in Patient Module.

Parameters:

arrStrOtherPatientIDs - Other identification numbers or codes used to identify the patient.

getOtherPatientIDs

public java.lang.String[] getOtherPatientIDs()

Return the Array of String values of the attribute Other Patient IDs.

Returns:

String[] - returns the collection of other patient IDs.

setOtherPatientNames

public void setOtherPatientNames(java.lang.String[] arrStrOtherPatientNames)

Sets the Other Patient Names in Patient Module.

Parameters:

arrStrOtherPatientNames - String array of Other names used to identify the patient.

getOtherPatientNames

public java.lang.String[] getOtherPatientNames()

Return the Array of String values of the attribute Other Patient Names.

Returns:

String[] - returns the collection of other patient names.

setEthnicGroup

public void setEthnicGroup(java.lang.String strEthnicGroup)

This method is used to set the Ethnic Group in Patient Module. The function accepts a String Value as the Ethnic Group 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:

strEthnicGroup - Ethnic group or race of the patient.

getEthnicGroup

public java.lang.String getEthnicGroup()

Return the String value of the attribute Ethnic Group

Returns:

String - returns the ethnic group of the patient

setPatientComments

public void setPatientComments(java.lang.String strPatientComments)

Sets the Patient Comments in Patient Module.

Parameters:

strPatientComments - User-defined additional information about the patient.

getPatientComments

public java.lang.String getPatientComments()

Return the String value of the attribute Patient Comments

Returns:

String - returns the patient comments

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String strStudyInstanceUID)

Sets Unique identifier for the Study.

Parameters:

strStudyInstanceUID - String value of Unique identifier for the Study.

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Returns Unique identifier for the Study.

Returns:

strStudyInstanceUID - String value of Unique identifier for the Study.

setStudyDate

public void setStudyDate(java.lang.String strStudyDate)

Sets date on which the Study started.

Parameters:

strStudyDate - String value of the Date on which the Study started.

getStudyDate

public java.lang.String getStudyDate()

Returns date on which the Study started.

Returns:

strStudyDate - String value of the Date on which the Study started.

setStudyTime

public void setStudyTime(java.lang.String strStudyTime)

Sets time on which the Study started.

Parameters:

strStudyTime - String value of time on which the Study started.

getStudyTime

public java.lang.String getStudyTime()

Returns time on which the Study started.

Returns:

strStudyTime - String value of time on which the Study started.

setReferringPhysicianName

public void setReferringPhysicianName(java.lang.String strReferringPhysicianName)

Sets Name of the patient's referring physician.

Parameters:

strReferringPhysicianName - String value of the patient's referring physician.

getReferringPhysicianName

public java.lang.String getReferringPhysicianName()

Returns name of the patient's referring physician.

Returns:

String - value of the patient's referring physician.

setStudyID

public void setStudyID(java.lang.String strStudyID)

Sets User or equipment generated Study identifier.

Parameters:

strStudyID - String value of the Study ID.

getStudyID

public java.lang.String getStudyID()

Returns User or equipment generated Study identifier.

Returns:

String - value of the Study ID.

setAccessionNumber

public void setAccessionNumber(java.lang.String strAccessionNumber)

Sets a RIS generated number that identifies the order for the Study

Parameters:

strAccessionNumber - String valueof Accession Number.

getAccessionNumber

public java.lang.String getAccessionNumber()

Returns a RIS generated number that identifies the order for the Study.

Returns:

strAccessionNumber String valueof Accession Number.

setStudyDescription

public void setStudyDescription(java.lang.String strStudyDescription)

Sets Institution-generated description or classification of the Study performed.

Parameters:

strStudyDescription - String value of Institution-generated description.

getStudyDescription

public java.lang.String getStudyDescription()

Returns Institution-generated description or classification of the Study performed.

Returns:

String - value of Institution-generated description.

setNameOfPhysicianReadingStudy

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

Sets Names of the physician(s) who are reading the Study.

Parameters:

arrStrNameOfPhysicianReadingStudy - Names of the physician(s)

getNameOfPhysicianReadingStudy

public java.lang.String[] getNameOfPhysicianReadingStudy()

Returns Names of the physician(s) who are reading the Study.

Returns:

String[] - String array of Name Of Physician Reading Study.

setAdmittingDiagnosesDescription

public void setAdmittingDiagnosesDescription(java.lang.String[] arrStrAdmittingDiagnosesDescription)

Sets the Description of the admitting diagnosis (diagnoses).

Parameters:

arrStrAdmittingDiagnosesDescription - Description of the admitting diagnosis (diagnoses)

getAdmittingDiagnosesDescription

public java.lang.String[] getAdmittingDiagnosesDescription()

Return Description of the admitting diagnosis(diagnoses).

Returns:

String[] - String values of Description of the admitting diagnosis(diagnoses).

setPatientAge

public void setPatientAge(java.lang.String strPatientAge)

Sets the Age of the Patient.

Parameters:

strPatientAge - String value of age of the Patient.

getPatientAge

public java.lang.String getPatientAge()

Returns the String value of the attribute Patient Age.

Returns:

String - value of Patient Age.

setPatientSize

public void setPatientSize(java.lang.String strPatientSize)

Sets the Patient Size.

Parameters:

strPatientSize - String value of Length or size of the Patient, in meters.

getPatientSize

public java.lang.String getPatientSize()

Return the String value of the attribute Patient Size.

Returns:

String - value of Patient Size.

setPatientWeight

public void setPatientWeight(java.lang.String strPatientWeight)

Sets the Patient Weight.

Parameters:

strPatientWeight - String value of Weight of the Patient, in kilograms.

getPatientWeight

public java.lang.String getPatientWeight()

Return the String value of the attribute Patient Weight.

Returns:

String - value of Patient Weight.

setOccupation

public void setOccupation(java.lang.String strOccupation)

Sets the Patient's Occupation.

Parameters:

strOccupation - String value of Occupation of the Patient's Occupation.

getOccupation

public java.lang.String getOccupation()

Return Patient's Occupation.

Returns:

String - value Patient Occupation.

setAdditionalPatientHistory

public void setAdditionalPatientHistory(java.lang.String strAdditionalPatientHistory)

Sets the Additional Patient History in Patient Study Module.

Parameters:

strAdditionalPatientHistory - Additional information about the Patient's medical history.

getAdditionalPatientHistory

public java.lang.String getAdditionalPatientHistory()

Return Patient's additional history.

Returns:

String - value of Patient's additional history.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets the Series Number in General Series Module.

Parameters:

strSeriesNumber - String value of Series Number.

getSeriesNumber

public java.lang.String getSeriesNumber()

Retruns the Series Number in General Series Module.

Returns:

String - value of Series Number.