cdac.medinfo.sdk.dcm30_04.baselibs

Class ScheduledProcedureStepSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ScheduledProcedureStepSequenceItem

All Implemented Interfaces:

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

public class ScheduledProcedureStepSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Scheduled Procedure Step Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnatomicalOrientationType() Retrieves Scheduled Procedure Step Start Date.
java.lang.String	getCommentsontheScheduledProcedureStep() Retrieves Comments on the Scheduled Procedure Step.
java.lang.String	getModality() Retrieves modality.
java.lang.String	getPreMedication() Retrieves Pre Medication.
java.lang.String	getRequestedContrastAgent() Retrieves Requested Contrast Agent.
ScheduledPerformingPhysicianIdentificationSequence	getScheduledPerformingPhysicianIdentificationSequence() Identification of the physician scheduled to administer the Scheduled Procedure Step.
java.lang.String	getScheduledPerformingPhysicianName() Retrieves Scheduled Performing Physician Name.
java.lang.String	getScheduledProcedureStepDescription() Retrieves Scheduled Procedure Step Description.
java.lang.String	getScheduledProcedureStepEndDate() Retrieves Scheduled Procedure Step End Date.
java.lang.String	getScheduledProcedureStepEndTime() Retrieves Scheduled Procedure Step End Time.
java.lang.String	getScheduledProcedureStepID() Retrieves Scheduled Procedure Step ID.
java.lang.String	getScheduledProcedureStepLocation() Retrieves Scheduled Procedure Step Location.
java.lang.String	getScheduledProcedureStepStartDate() Retrieves Scheduled Procedure Step Start Date.
java.lang.String	getScheduledProcedureStepStartTime() Retrieves Scheduled Procedure Step Start Time.
java.lang.String	getScheduledProcedureStepStatus() Retrieves Scheduled Procedure Step Status.
ScheduledProtocolCodeSequence	getScheduledProtocolCodeSequence() Sequence describing the Scheduled Protocol following a specified coding scheme.
java.lang.String[]	getScheduledStationAETitle() Retrieves Scheduled Station AE Title.
java.lang.String[]	getScheduledStationName() Retrieves Scheduled Station Name.
void	setAnatomicalOrientationType(java.lang.String strAnatomicalOrientationType) Sets AnatomicalOrientationType on which the Scheduled Procedure Step is scheduled to start.
void	setCommentsontheScheduledProcedureStep(java.lang.String strCommentsontheScheduledProcedureStep) Sets User-defined comments on the Scheduled Procedure Step.
void	setModality(java.lang.String strModality) Sets source equipment for the image.
void	setPreMedication(java.lang.String strPreMedication) Sets Medication to be administered at the beginning of the Scheduled Procedure Step, e.g.
void	setRequestedContrastAgent(java.lang.String strRequestedContrastAgent) Sets Contrast agent requested for use in the Scheduled Procedure Step.
void	setScheduledPerformingPhysicianName(java.lang.String strScheduledPerformingPhysicianName) Sets Name of the physician scheduled to administer the Scheduled Procedure Step.
void	setScheduledProcedureStepDescription(java.lang.String strScheduledProcedureStepDescription) Sets Institution-generated description or classification of the Scheduled Procedure Step to be performed.
void	setScheduledProcedureStepEndDate(java.lang.String strScheduledProcedureStepEndDate) Sets Date on which the Scheduled Procedure Step is scheduled to end.
void	setScheduledProcedureStepEndTime(java.lang.String strScheduledProcedureStepEndTime) Sets Time at which the Scheduled Procedure Step is scheduled to end.
void	setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID) Sets Identifier that identifies the Scheduled Procedure Step.
void	setScheduledProcedureStepLocation(java.lang.String strScheduledProcedureStepLocation) Sets the location at which the Procedure Step is scheduled to be performed.
void	setScheduledProcedureStepStartDate(java.lang.String strScheduledProcedureStepStartDate) Sets Date on which the Scheduled Procedure Step is scheduled to start.
void	setScheduledProcedureStepStartTime(java.lang.String strScheduledProcedureStepStartTime) Sets Time at which the Scheduled Procedure Step is scheduled to start.
void	setScheduledProcedureStepStatus(EnumScheduledProcedureStepStatus enumScheduledProcedureStepStatus) Sets Defines the state of the Scheduled Procedure Step.
void	setScheduledStationAETitle(java.lang.String[] strScheduledStationAETitle) Sets the AE title of the modality on which the Scheduled Procedure Step is scheduled to be performed.
void	setScheduledStationName(java.lang.String[] strScheduledStationName) Sets an institution defined name for the modality on which the Scheduled Procedure Step is scheduled to be performed.
boolean	validateForModule() Validates all the attributes in ActualHumanPerformersSequenceItem 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 InvalidItemException

Validates all the attributes in ActualHumanPerformersSequenceItem that are present in the DataSet.

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false.

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setScheduledStationAETitle

public void setScheduledStationAETitle(java.lang.String[] strScheduledStationAETitle)

Sets the AE title of the modality on which the Scheduled Procedure Step is scheduled to be performed.

Parameters:

StrScheduledStationAETitle - String array of Scheduled Procedure Step.

getScheduledStationAETitle

public java.lang.String[] getScheduledStationAETitle()

Retrieves Scheduled Station AE Title.

Returns:

String - Scheduled Station AE Title.

setScheduledStationName

public void setScheduledStationName(java.lang.String[] strScheduledStationName)

Sets an institution defined name for the modality on which the Scheduled Procedure Step is scheduled to be performed.

Parameters:

strScheduledStationName - String array of Scheduled Procedure Step.

getScheduledStationName

public java.lang.String[] getScheduledStationName()

Retrieves Scheduled Station Name.

Returns:

String - Scheduled Station Name.

setScheduledProcedureStepLocation

public void setScheduledProcedureStepLocation(java.lang.String strScheduledProcedureStepLocation)

Sets the location at which the Procedure Step is scheduled to be performed.

Parameters:

strScheduledProcedureStepLocation - String Procedure Step is scheduled to be performed

getScheduledProcedureStepLocation

public java.lang.String getScheduledProcedureStepLocation()

Retrieves Scheduled Procedure Step Location.

Returns:

SDtring - Scheduled Procedure Step Location.

setScheduledProcedureStepStartDate

public void setScheduledProcedureStepStartDate(java.lang.String strScheduledProcedureStepStartDate)

Sets Date on which the Scheduled Procedure Step is scheduled to start.

Parameters:

strScheduledProcedureStepStartDate - string Scheduled Procedure Step is scheduled to start.

getScheduledProcedureStepStartDate

public java.lang.String getScheduledProcedureStepStartDate()

Retrieves Scheduled Procedure Step Start Date.

Returns:

String - Scheduled Procedure Step Start Date.

setScheduledProcedureStepStartTime

public void setScheduledProcedureStepStartTime(java.lang.String strScheduledProcedureStepStartTime)

Sets Time at which the Scheduled Procedure Step is scheduled to start.

Parameters:

strScheduledProcedureStepStartTime - String time Procedure Step is scheduled to start.

getScheduledProcedureStepStartTime

public java.lang.String getScheduledProcedureStepStartTime()

Retrieves Scheduled Procedure Step Start Time.

Returns:

String - Scheduled Procedure Step Start Time.

setScheduledProcedureStepEndDate

public void setScheduledProcedureStepEndDate(java.lang.String strScheduledProcedureStepEndDate)

Sets Date on which the Scheduled Procedure Step is scheduled to end.

Parameters:

strScheduledProcedureStepEndDate - string date Procedure Step is scheduled to end.

getScheduledProcedureStepEndDate

public java.lang.String getScheduledProcedureStepEndDate()

Retrieves Scheduled Procedure Step End Date.

Returns:

String - Scheduled Procedure Step End Date.

setScheduledProcedureStepEndTime

public void setScheduledProcedureStepEndTime(java.lang.String strScheduledProcedureStepEndTime)

Sets Time at which the Scheduled Procedure Step is scheduled to end.

Parameters:

strScheduledProcedureStepEndTime - string time Procedure Step is scheduled to end.

getScheduledProcedureStepEndTime

public java.lang.String getScheduledProcedureStepEndTime()

Retrieves Scheduled Procedure Step End Time.

Returns:

String - Scheduled Procedure Step End Time.

setScheduledPerformingPhysicianName

public void setScheduledPerformingPhysicianName(java.lang.String strScheduledPerformingPhysicianName)

Sets Name of the physician scheduled to administer the Scheduled Procedure Step.

Parameters:

strScheduledPerformingPhysicianName - String Name of the physician

getScheduledPerformingPhysicianName

public java.lang.String getScheduledPerformingPhysicianName()

Retrieves Scheduled Performing Physician Name.

Returns:

String - Scheduled Performing Physician Name.

getScheduledPerformingPhysicianIdentificationSequence

public ScheduledPerformingPhysicianIdentificationSequence getScheduledPerformingPhysicianIdentificationSequence()

Identification of the physician scheduled to administer the Scheduled Procedure Step. Only a single item shall be permitted in this sequence.

Returns:

ScheduledPerformingPhysicianIdentificationSequence - instance of Scheduled Performing Physician Identification Sequence.

setScheduledProcedureStepDescription

public void setScheduledProcedureStepDescription(java.lang.String strScheduledProcedureStepDescription)

Sets Institution-generated description or classification of the Scheduled Procedure Step to be performed.

Parameters:

strScheduledProcedureStepDescription - string Institution-generated description.

getScheduledProcedureStepDescription

public java.lang.String getScheduledProcedureStepDescription()

Retrieves Scheduled Procedure Step Description.

Returns:

String - Scheduled Procedure Step Description.

getScheduledProtocolCodeSequence

public ScheduledProtocolCodeSequence getScheduledProtocolCodeSequence()

Sequence describing the Scheduled Protocol following a specified coding scheme. This sequence contains one or more Items.

Returns:

ScheduledProtocolCodeSequence - instance of Scheduled Protocol Code Sequence.

setScheduledProcedureStepID

public void setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID)

Sets Identifier that identifies the Scheduled Procedure Step.

Parameters:

strScheduledProcedureStepID - String identifies the Scheduled Procedure Step.

getScheduledProcedureStepID

public java.lang.String getScheduledProcedureStepID()

Retrieves Scheduled Procedure Step ID.

Returns:

String - Scheduled Procedure Step ID.

setScheduledProcedureStepStatus

public void setScheduledProcedureStepStatus(EnumScheduledProcedureStepStatus enumScheduledProcedureStepStatus)

Sets Defines the state of the Scheduled Procedure Step. Defined Terms:SCHEDULED.

Parameters:

enumScheduledProcedureStepStatus - string Defines the state of the Scheduled Procedure Step.

getScheduledProcedureStepStatus

public java.lang.String getScheduledProcedureStepStatus()

Retrieves Scheduled Procedure Step Status.

Returns:

String - Scheduled Procedure Step Status.

setCommentsontheScheduledProcedureStep

public void setCommentsontheScheduledProcedureStep(java.lang.String strCommentsontheScheduledProcedureStep)

Sets User-defined comments on the Scheduled Procedure Step.

Parameters:

strCommentsontheScheduledProcedureStep - String User-defined comments on the Scheduled Procedure Step.

getCommentsontheScheduledProcedureStep

public java.lang.String getCommentsontheScheduledProcedureStep()

Retrieves Comments on the Scheduled Procedure Step.

Returns:

String - Comments on the Scheduled Procedure Step.

setModality

public void setModality(java.lang.String strModality)

Sets source equipment for the image.

Parameters:

strModality - String source equipment for the image.

getModality

public java.lang.String getModality()

Retrieves modality.

Returns:

String - modality.

setRequestedContrastAgent

public void setRequestedContrastAgent(java.lang.String strRequestedContrastAgent)

Sets Contrast agent requested for use in the Scheduled Procedure Step.

Parameters:

strRequestedContrastAgent - String Contrast agent use in the Scheduled Procedure Step.

getRequestedContrastAgent

public java.lang.String getRequestedContrastAgent()

Retrieves Requested Contrast Agent.

Returns:

String - Requested Contrast Agent.

setPreMedication

public void setPreMedication(java.lang.String strPreMedication)

Sets Medication to be administered at the beginning of the Scheduled Procedure Step, e.g. Nuclear Medicine radiopharmaceutical.

Parameters:

strPreMedication -

getPreMedication

public java.lang.String getPreMedication()

Retrieves Pre Medication.

Returns:

String - Pre Medication.

setAnatomicalOrientationType

public void setAnatomicalOrientationType(java.lang.String strAnatomicalOrientationType)

Sets AnatomicalOrientationType on which the Scheduled Procedure Step is scheduled to start.

Parameters:

strAnatomicalOrientationType - string Scheduled Procedure Step.

getAnatomicalOrientationType

public java.lang.String getAnatomicalOrientationType()

Retrieves Scheduled Procedure Step Start Date.

Returns:

String - Scheduled Procedure Step Start Date.