cdac.medinfo.sdk.dcm30_04.baselibs

Class HL7v2HierarchicDesignatorMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.HL7v2HierarchicDesignatorMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class HL7v2HierarchicDesignatorMacro
extends Macro

This class contains Macro that describes the attributes for identifying an entity (system, organization, agency, or department) that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers,etc.).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HL7v2HierarchicDesignatorMacro(IDataSet objDataSet) This constructor constructs a Macro with specified Data Set.
HL7v2HierarchicDesignatorMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified Data Set and Dictionary Reader
HL7v2HierarchicDesignatorMacro(IItem objItem) This constructor constructs a Macro with the specified Item
HL7v2HierarchicDesignatorMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLocalNamespaceEntityID() Retrieves Local Namespace Entity ID.
java.lang.String	getUniversalEntityID() Retrieves Universal Entity ID.
java.lang.String	getUniversalEntityIDType() Return type of Universal Entity ID.
void	setLocalNamespaceEntityID(java.lang.String strLocalNamespaceEntityID) Sets Local Namespace Entity ID.
void	setUniversalEntityID(java.lang.String strUniversalEntityID) Sets Universal Entity ID.
void	setUniversalEntityIDType(EnumUniversalEntityIDType enumUniversalEntityIDType) Sets type Universal Entity ID.
boolean	validate() Validates all the attributes in HL7v2HierarchicDesignatorMacro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in HL7v2HierarchicDesignatorMacro that are present in the DataSet

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

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

HL7v2HierarchicDesignatorMacro

public HL7v2HierarchicDesignatorMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified Data Set.

Parameters:

objDataSet - Collection of Data Elements

HL7v2HierarchicDesignatorMacro

public HL7v2HierarchicDesignatorMacro(IDataSet objDataSet,
                              IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified Data Set and Dictionary Reader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

HL7v2HierarchicDesignatorMacro

public HL7v2HierarchicDesignatorMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

HL7v2HierarchicDesignatorMacro

public HL7v2HierarchicDesignatorMacro(IItem objItem,
                              IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in HL7v2HierarchicDesignatorMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in HL7v2HierarchicDesignatorMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setLocalNamespaceEntityID

public void setLocalNamespaceEntityID(java.lang.String strLocalNamespaceEntityID)

Sets Local Namespace Entity ID. Identifies an entity within the local namespace or domain.

Parameters:

strLocalNamespaceEntityID - String Value component of a Local Namespace Entity ID

getLocalNamespaceEntityID

public java.lang.String getLocalNamespaceEntityID()

Retrieves Local Namespace Entity ID. Identifies an entity within the local namespace or domain.

Returns:

String - Value component of a Local Namespace Entity ID

setUniversalEntityID

public void setUniversalEntityID(java.lang.String strUniversalEntityID)

Sets Universal Entity ID. Universal or unique identifier for an entity.

Parameters:

strUniversalEntityID - String Value component of a Universal Entity ID

getUniversalEntityID

public java.lang.String getUniversalEntityID()

Retrieves Universal Entity ID. Universal or unique identifier for an entity.

Returns:

String - Value component of a Universal Entity ID

setUniversalEntityIDType

public void setUniversalEntityIDType(EnumUniversalEntityIDType enumUniversalEntityIDType)

Sets type Universal Entity ID. Standard defining the format of the Universal Entity ID. Defined Terms: 1) DNS. 2) EUI64. 3) ISO. 4) URI. 5) UUID. 5) X400. 5) X500.

Parameters:

enumUniversalEntityIDType - enum value of Universal Entity ID Type.

getUniversalEntityIDType

public java.lang.String getUniversalEntityIDType()

Return type of Universal Entity ID. Standard defining the format of the Universal Entity ID.

Returns:

String - value of Universal Entity ID Type.