cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StudyRelationshipModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyRelationshipModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StudyRelationshipModule
extends Module

\* This module defines the Attributes that reference SOP Instances Subordinate or Superior to this SOP Class in the Naming Hierarchy.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StudyRelationshipModule(IDataSet objIDataSet) Instantiates a new study relationship module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessionNumber() Returns the Accession Number.
ReferencedPatientSequence	getReferencedPatientSequence() Return instance of Referenced Patien tSequence Uniquely identifies the Patient SOP Instance that relates to the Study SOP Instance.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Uniquely identifies the Performed Procedure Step SOP Instances to which the Study SOP Instance is related (e.g.
ReferencedResultsSequence	getReferencedResultsSequence() Return instance of Referenced Results Sequence Uniquely identifies the results SOP Instance for which the interpretation SOP Instance applies.
ReferencedVisitSequence	getReferencedVisitSequence() Retrieves pre-initialized object of Referenced Visit 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	getStudyInstanceUID() Returns the study instance UID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAccessionNumber(java.lang.String strAccessionNumber) A RIS generated number that identifies the order for the Study.
void	setStudyInstanceUID(java.lang.String strStudyInstanceUID) Unique identifier for the Study.
boolean	validateModule() validates the module according to the rules specified by the 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

StudyRelationshipModule

public StudyRelationshipModule(IDataSet objIDataSet)

Instantiates a new study relationship module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

validates the module according to the rules specified by the DICOM Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns the validation status as success or failure

Throws:

InvalidModuleException - the invalid module exception

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String strStudyInstanceUID)

Unique identifier for the Study.

Parameters:

strStudyInstanceUID - the str study instance uid

setAccessionNumber

public void setAccessionNumber(java.lang.String strAccessionNumber)

A RIS generated number that identifies the order for the Study.

Parameters:

strAccessionNumber - the str accession number

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Returns the study instance UID.

Returns:

String - returns the study instance UID

getAccessionNumber

public java.lang.String getAccessionNumber()

Returns the Accession Number.

Returns:

String - returns the Accession Number

getReferencedVisitSequence

public ReferencedVisitSequence getReferencedVisitSequence()

Retrieves pre-initialized object of Referenced Visit 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:

ReferencedVisitSequence - instance of Referenced Visit Sequence.

getReferencedPatientSequence

public ReferencedPatientSequence getReferencedPatientSequence()

Return instance of Referenced Patien tSequence Uniquely identifies the Patient SOP Instance that relates to the Study SOP Instance. Only a single Item shall be permitted in this Sequence.

Returns:

Referenced Patient Sequence - returns the object of Referenced Patient Sequence

getReferencedResultsSequence

public ReferencedResultsSequence getReferencedResultsSequence()

Return instance of Referenced Results Sequence Uniquely identifies the results SOP Instance for which the interpretation SOP Instance applies. Zero or more Items may be included in this Sequence.

Returns:

Referenced Results Sequence - returns the object of Referenced Results Sequence

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

Uniquely identifies the Performed Procedure Step SOP Instances to which the Study SOP Instance is related (e.g. a Modality or General-Purpose Performed Procedure Step SOP Instance or Study Component SOP Instance).

Returns:

ReferencedPerformedProcedureStepSequence - returns the object of Referenced Performed Procedure Step 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:

collection of Tags - returns the customized collection of data element tags belonging to this module