cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RequestedProcedureModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RequestedProcedureModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RequestedProcedureModule
extends Module

\* This module describes the attributes in Requested Procedure Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RequestedProcedureModule(IDataSet objIDataSet) Creates Imaging Service Request Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConfidentialityCode() Retrieves Confidentiality Code.
IntendedRecipientsofResultsIdentificationSequence	getIntendedRecipientsofResultsIdentificationSequence() Retrieves Identification of the physicians who are intended recipients of results.
java.lang.String[]	getNamesofIntendedRecipientsofResults() Retrieves Names of Intended Recipients of Results.
java.lang.String	getPatientTransportArrangements() Retrieves Patient Transport Arrangements.
ReasonForRequestedProcedureCodeSequence	getReasonforRequestedProcedureCodeSequence() Retrieves Coded Reason for requesting this procedure.
java.lang.String	getReasonfortheRequestedProcedure() Sets Reason for requesting this imaging procedure.
ReferencedStudySequence	getReferencedStudySequence() Retrieves Uniquely identifies the Study SOP Instances associated with this SOP Instance.
java.lang.String	getReportingPriority() Retrieves Reporting Priority.
RequestedProcedureCodeSequence	getRequestedProcedureCodeSequence() Retrieves sequence that conveys the Requested Procedure of one Procedure Type.
java.lang.String	getRequestedProcedureDescription() Retrieves Institution-generated administrative description or classification of Requested Procedure
java.lang.String	getRequestedProcedureID() Retrieves Identifier that identifies the Requested Procedure in the Imaging Service Request.
java.lang.String	getRequestedProcedureLocation() Retrieves Requested Procedure Location.
java.lang.String	getRequestedProcedurePriority() Retrieves Requested Procedure Type Urgency.
java.lang.String	getStudyDate() Retrieves Study Date.
java.lang.String	getStudyInstanceUID() Retrieves Unique identifier to be used to identify the Study
java.lang.String	getStudyTime() Retrieves Study Time.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setConfidentialityCode(java.lang.String StrConfidentialityCode) Sets Confidentiality Constraints on the Requested Procedure by the party filling the order.
void	setNamesofIntendedRecipientsofResults(java.lang.String[] StrNamesofIntendedRecipientsofResults) Sets Names of the physicians, who are intended recipients of results.
void	setPatientTransportArrangements(java.lang.String StrPatientTransportArrangements) Sets Mode of transportation of the patient to the location of examination.
void	setReasonfortheRequestedProcedure(java.lang.String StrReasonfortheRequestedProcedure) Sets Reason for requesting this imaging procedure.
void	setReportingPriority(java.lang.String StrReportingPriority) Sets Requested Reporting Priority.
java.lang.String	setRequestedProcedureComments() Retrieves User-defined comments on the Requested Procedure.
void	setRequestedProcedureComments(java.lang.String StrRequestedProcedureComments) Sets User-defined comments on the Requested Procedure.
void	setRequestedProcedureDescription(java.lang.String StrRequestedProcedureDescription) Sets Institution-generated administrative description or classification of Requested Procedure
void	setRequestedProcedureID(java.lang.String StrRequestedProcedureID) Sets Identifier that identifies the Requested Procedure in the Imaging Service Request.
void	setRequestedProcedureLocation(java.lang.String StrRequestedProcedureLocation) Sets Physical location at which the Requested Procedure is to be performed.
void	setRequestedProcedurePriority(java.lang.String strRequestedProcedurePriority) Sets Requested Procedure Type Urgency.
void	setStudyDate(java.lang.String strStudyDate) Sets Date the Study started, if any previous procedure steps within the same study have already been performed.
void	setStudyInstanceUID(java.lang.String StrStudyInstanceUID) Sets Unique identifier to be used to identify the Study
void	setStudyTime(java.lang.String strStudyTime) Sets Time the Study started, if any previous procedure steps within the same study have already been performed.
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

RequestedProcedureModule

public RequestedProcedureModule(IDataSet objIDataSet)

Creates Imaging Service Request Module with default initialization.

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

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

setRequestedProcedureID

public void setRequestedProcedureID(java.lang.String StrRequestedProcedureID)

Sets Identifier that identifies the Requested Procedure in the Imaging Service Request.

Parameters:

StrRequestedProcedureID -

getRequestedProcedureID

public java.lang.String getRequestedProcedureID()

Retrieves Identifier that identifies the Requested Procedure in the Imaging Service Request.

Returns:

String - Identifier that identifies the Requested Procedure in the Imaging Service Request.

setReasonfortheRequestedProcedure

public void setReasonfortheRequestedProcedure(java.lang.String StrReasonfortheRequestedProcedure)

Sets Reason for requesting this imaging procedure.

Parameters:

StrReasonfortheRequestedProcedure - Reason for requesting this imaging procedure.

getReasonfortheRequestedProcedure

public java.lang.String getReasonfortheRequestedProcedure()

Sets Reason for requesting this imaging procedure.

Returns:

String - Reason for requesting this imaging procedure.

setRequestedProcedureComments

public void setRequestedProcedureComments(java.lang.String StrRequestedProcedureComments)

Sets User-defined comments on the Requested Procedure.

Parameters:

StrRequestedProcedureComments - User-defined comments on the Requested Procedure.

setRequestedProcedureComments

public java.lang.String setRequestedProcedureComments()

Retrieves User-defined comments on the Requested Procedure.

Returns:

String - User-defined comments on the Requested Procedure.

getReasonforRequestedProcedureCodeSequence

public ReasonForRequestedProcedureCodeSequence getReasonforRequestedProcedureCodeSequence()

Retrieves Coded Reason for requesting this procedure.

Returns:

ReasonForRequestedProcedureCodeSequence - instance of ReasonForRequestedProcedureCodeSequence.

getRequestedProcedureCodeSequence

public RequestedProcedureCodeSequence getRequestedProcedureCodeSequence()

Retrieves sequence that conveys the Requested Procedure of one Procedure Type.

Returns:

RequestedProcedureCodeSequence - sequence that conveys the Requested Procedure of one Procedure Type.

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String StrStudyInstanceUID)

Sets Unique identifier to be used to identify the Study

Parameters:

StrStudyInstanceUID - Unique identifier to be used to identify the Study

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Retrieves Unique identifier to be used to identify the Study

Returns:

String Unique identifier to be used to identify the Study

setStudyDate

public void setStudyDate(java.lang.String strStudyDate)

Sets Date the Study started, if any previous procedure steps within the same study have already been performed.

Parameters:

strStudyDate - String value of Study Date.

getStudyDate

public java.lang.String getStudyDate()

Retrieves Study Date.

Returns:

the Study Date

setStudyTime

public void setStudyTime(java.lang.String strStudyTime)

Sets Time the Study started, if any previous procedure steps within the same study have already been performed.

Parameters:

strStudyTime - String value of Study Time.

getStudyTime

public java.lang.String getStudyTime()

Retrieves Study Time.

Returns:

the Study Time

getReferencedStudySequence

public ReferencedStudySequence getReferencedStudySequence()

Retrieves Uniquely identifies the Study SOP Instances associated with this SOP Instance.

Returns:

String - Uniquely identifies the Study SOP Instances associated with this SOP Instance.

setRequestedProcedureDescription

public void setRequestedProcedureDescription(java.lang.String StrRequestedProcedureDescription)

Sets Institution-generated administrative description or classification of Requested Procedure

Parameters:

StrRequestedProcedureDescription - Institution-generated administrative description or classification of Requested Procedure

getRequestedProcedureDescription

public java.lang.String getRequestedProcedureDescription()

Retrieves Institution-generated administrative description or classification of Requested Procedure

Returns:

String - Institution-generated administrative description or classification of Requested Procedure

setRequestedProcedurePriority

public void setRequestedProcedurePriority(java.lang.String strRequestedProcedurePriority)

Sets Requested Procedure Type Urgency. Defined Terms: STAT, HIGH, ROUTINE, MEDIUM, LOW

Parameters:

strRequestedProcedurePriority - Requested Procedure Type Urgency

getRequestedProcedurePriority

public java.lang.String getRequestedProcedurePriority()

Retrieves Requested Procedure Type Urgency. Defined Terms: STAT, HIGH, ROUTINE, MEDIUM, LOW

Returns:

String - Requested Procedure Type Urgency.

setPatientTransportArrangements

public void setPatientTransportArrangements(java.lang.String StrPatientTransportArrangements)

Sets Mode of transportation of the patient to the location of examination.

Parameters:

StrPatientTransportArrangements - Mode of transportation of the patient to the location of examination.

getPatientTransportArrangements

public java.lang.String getPatientTransportArrangements()

Retrieves Patient Transport Arrangements.

Returns:

String - Patient Transport Arrangements.

setRequestedProcedureLocation

public void setRequestedProcedureLocation(java.lang.String StrRequestedProcedureLocation)

Sets Physical location at which the Requested Procedure is to be performed.

Parameters:

StrRequestedProcedureLocation - Physical location at which the Requested Procedure is to be performed.

getRequestedProcedureLocation

public java.lang.String getRequestedProcedureLocation()

Retrieves Requested Procedure Location.

Returns:

String - Requested Procedure Location.

setConfidentialityCode

public void setConfidentialityCode(java.lang.String StrConfidentialityCode)

Sets Confidentiality Constraints on the Requested Procedure by the party filling the order.

Parameters:

StrConfidentialityCode - Confidentiality Constraints on the Requested Procedure by the party filling the order.

getConfidentialityCode

public java.lang.String getConfidentialityCode()

Retrieves Confidentiality Code.

Returns:

String - Confidentiality Code.

setReportingPriority

public void setReportingPriority(java.lang.String StrReportingPriority)

Sets Requested Reporting Priority. Defined Terms: HIGH, ROUTINE, MEDIUM, LOW.

Parameters:

StrReportingPriority - Requested Reporting Priority

getReportingPriority

public java.lang.String getReportingPriority()

Retrieves Reporting Priority.

Returns:

String - Reporting Priority.

setNamesofIntendedRecipientsofResults

public void setNamesofIntendedRecipientsofResults(java.lang.String[] StrNamesofIntendedRecipientsofResults)

Sets Names of the physicians, who are intended recipients of results.

Parameters:

StrNamesofIntendedRecipientsofResults - - String array of Names of Intended Recipients of Results.

getNamesofIntendedRecipientsofResults

public java.lang.String[] getNamesofIntendedRecipientsofResults()

Retrieves Names of Intended Recipients of Results.

Returns:

String[] - String array of Names of Intended Recipients of Results.

getIntendedRecipientsofResultsIdentificationSequence

public IntendedRecipientsofResultsIdentificationSequence getIntendedRecipientsofResultsIdentificationSequence()

Retrieves Identification of the physicians who are intended recipients of results. One or more items shall be included in this sequence. If more than one Item, the number and order shall correspond to the value of Names of Intended Recipients of Results (0040,1010), if present.

Returns:

IntendedRecipientsofResultsIdentificationSequence - instance of Intended Recipients of Results Identification Sequence.