cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class VisitIdentificationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.VisitIdentificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class VisitIdentificationModule
extends Module

\* This module Class defines the Attributes relevant to identifying a visit.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VisitIdentificationModule(IDataSet objIDataSet) Instantiates a new visit identification module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAdmissionID() Retrieves Identification number of the visit as assigned by the healthcare provider.
java.lang.String	getInstitutionAddress() Retrieves Mailing Address of the institution where the equipment is located.
InstitutionCodeSequence	getInstitutionCodeSequence() A sequence that conveys the healthcare facility identification.
java.lang.String	getInstitutionName() Retrieves Institution where the equipment is located.
IssuerOfAdmissionIDSequence	getIssuerOfAdmissionIDSequence() This method provides the pre-initialized object of Issuer Of Admission ID Sequence.
IssuerofServiceEpisodeIDSequence	getIssuerofServiceEpisodeIDSequence() This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.
java.lang.String	getServiceEpisodeDescription() Retrieves Service Episode Description.
java.lang.String	getServiceEpisodeID() Retrieves Service Episode ID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAdmissionID(java.lang.String strAdmissionID) Identification number of the visit as assigned by the healthcare provider.
void	setInstitutionAddress(java.lang.String strInstitutionAddress) The address of Institution.
void	setInstitutionName(java.lang.String strInstitutionName) Sets The name of Institution.
void	setServiceEpisodeDescription(java.lang.String strServiceEpisodeDescription) Sets Description of the type of service episode.
void	setServiceEpisodeID(java.lang.String strServiceEpisodeID) Sets Identifier of the Service Episode as assigned by the healthcare provider.
boolean	validateModule() Validates the Module's DataElement according to 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

VisitIdentificationModule

public VisitIdentificationModule(IDataSet objIDataSet)

Instantiates a new visit identification module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

setInstitutionName

public void setInstitutionName(java.lang.String strInstitutionName)

Sets The name of Institution.

Parameters:

strInstitutionName - String value of Institution Name

setInstitutionAddress

public void setInstitutionAddress(java.lang.String strInstitutionAddress)

The address of Institution.

Parameters:

strInstitutionAddress - String value of Institution Address

getInstitutionCodeSequence

public InstitutionCodeSequence getInstitutionCodeSequence()

A sequence that conveys the healthcare facility identification. Only a single Item shall be permitted in this Sequence.

Returns:

objInstitutionCodeSequence - Instance of Institution Code Sequence.

setAdmissionID

public void setAdmissionID(java.lang.String strAdmissionID)

Identification number of the visit as assigned by the healthcare provider.

Parameters:

strAdmissionID - String value of Admission ID.

setServiceEpisodeID

public void setServiceEpisodeID(java.lang.String strServiceEpisodeID)

Sets Identifier of the Service Episode as assigned by the healthcare provider.

Parameters:

strServiceEpisodeID - String value of Service Episode ID

setServiceEpisodeDescription

public void setServiceEpisodeDescription(java.lang.String strServiceEpisodeDescription)

Sets Description of the type of service episode.

Parameters:

strServiceEpisodeDescription - String value of Service Episode Description

getInstitutionName

public java.lang.String getInstitutionName()

Retrieves Institution where the equipment is located.

Returns:

String - String value of Institution Name

getInstitutionAddress

public java.lang.String getInstitutionAddress()

Retrieves Mailing Address of the institution where the equipment is located.

Returns:

String - String value of Institution Address

getAdmissionID

public java.lang.String getAdmissionID()

Retrieves Identification number of the visit as assigned by the healthcare provider.

Returns:

String - String value of Admission ID

getIssuerOfAdmissionIDSequence

public IssuerOfAdmissionIDSequence getIssuerOfAdmissionIDSequence()

This method provides the pre-initialized object of Issuer Of Admission ID Sequence.

Returns:

- object of Issuer Of Admission ID 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

getServiceEpisodeID

public java.lang.String getServiceEpisodeID()

Retrieves Service Episode ID.

Returns:

String - String value of Service Episode ID

getIssuerofServiceEpisodeIDSequence

public IssuerofServiceEpisodeIDSequence getIssuerofServiceEpisodeIDSequence()

This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.

Returns:

- object of Issuer of Service Episode ID 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

getServiceEpisodeDescription

public java.lang.String getServiceEpisodeDescription()

Retrieves Service Episode Description.

Returns:

String - String value of Service Episode Description

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