oracle.hsgbu.ets.mapping

Interface MapSet

public interface MapSet

Defines a set of cross maps from source coding scheme version to target coding scheme version. For example, a map set may define set of cross maps to relate a single version or release of ICD9-April2000 (the source coding scheme version) to a single version or release of SNOMED (the target coding scheme version).

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPLICITY_ANY String constant that represents the multiplicity of a map set.
static String	MULTIPLICITY_CHOICE String constant that represents the multiplicity of a map set.
static String	MULTIPLICITY_MULTIPLE String constant that represents the multiplicity of a map set.
static String	MULTIPLICITY_MULTIPLE_XOR_CHOICE String constant that represents the multiplicity of a map set.
static String	MULTIPLICITY_SINGLE String constant that is used to represent the multiplicity of a map set.
static String	MULTIPLICITY_UNSPECIFIED String constant that represents the multiplicity of a map set.

Method Summary

Modifier and Type	Method and Description
String	getCode() Gets the code assigned to this MapTarget object by the MapTarget vendor.
CrossMap[]	getCrossMaps() Gets an array of all the cross maps available in this MapSet object.
CrossMap[]	getCrossMaps(Concept source) Gets an array of all cross maps available for the specified source concept.
CrossMap	getDefaultCrossMap(Concept source) Gets the default cross map for the specified source concept.
String	getDescription() Gets the optional description of this MapTarget object.
MapTarget	getMapTargetByTargetCode(String code) Gets the MapTarget object that matches the specified vendor-assigned target code.
MapTarget[]	getMapTargets() Gets an array of all possible cross map targets for this MapSet object.
String	getMultiplicity() Gets the code that represents multiplicity of this MapSet object.
String	getName() Gets the unique name of this MapSet object.
String	getRealmCode() Gets the realm code of this MapSet object.
String	getRuleType() Gets the type of machine-readable rule used in the TargetRule column of the MapTarget file or the MapRule column of the CrossMap file.
CodingSchemeVersion	getSourceVersion() Gets the source coding scheme version.
CodingSchemeVersion	getTargetVersion() Gets the target coding scheme version.
String	getVendor() Gets the name of the vendor of this MapTarget object.

Field Detail

MULTIPLICITY_UNSPECIFIED

static final String MULTIPLICITY_UNSPECIFIED

String constant that represents the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that the multiplicity of mappings is unspecified.

See Also:

Constant Field Values

MULTIPLICITY_SINGLE

static final String MULTIPLICITY_SINGLE

String constant that is used to represent the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that each source in the map set maps to exactly one target concept.

See Also:

Constant Field Values

MULTIPLICITY_MULTIPLE

static final String MULTIPLICITY_MULTIPLE

String constant that represents the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that some sources in the map set may map to a set of target concepts, but only one option is available for each source.

See Also:

Constant Field Values

MULTIPLICITY_MULTIPLE_XOR_CHOICE

static final String MULTIPLICITY_MULTIPLE_XOR_CHOICE

String constant that represents the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that some sources in the map set may provide one-to-many mappings, some may provide a choice between one-to-one mappings, but none will provide a choice of one-to-many mappings.

See Also:

Constant Field Values

MULTIPLICITY_CHOICE

static final String MULTIPLICITY_CHOICE

String constant that represents the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that some sources in the map set may provide several one-to-one mappings, but there are no one-to-many mappings.

See Also:

Constant Field Values

MULTIPLICITY_ANY

static final String MULTIPLICITY_ANY

String constant that represents the multiplicity of a map set. This constant is returned by getMultiplicity(). The value of this constant means that all combinations of mapping types are possible, including choices of one-to-many mappings.

See Also:

Constant Field Values

Method Detail

getCrossMaps

CrossMap[] getCrossMaps()
                 throws ETSDataException

Gets an array of all the cross maps available in this MapSet object. This method returns an empty array if this MapSet object does not contain any cross maps.

Returns:

Array of all the cross maps available in this MapSet object, or an empty array if this MapSet object does not contain any cross maps.

Throws:

ETSDataException - If a data transport error occurs.

getCrossMaps

CrossMap[] getCrossMaps(Concept source)
                 throws ETSDataException,
                        ETSBadParameterException

Gets an array of all cross maps available for the specified source concept. A maximum of one cross map is returned if the multiplicity of the map set is set to MULTIPLICITY_MULTIPLE or MULTIPLICITY_SINGLE. This method returns an empty array if cross maps does not exist for the specified source concept.

Parameters:

source - Source concept.

Returns:

Array of all cross maps available for the specified source concept, or an empty array if cross maps does not exist for the specified source concept..

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getSourceVersion

CodingSchemeVersion getSourceVersion()
                              throws ETSDataException

Gets the source coding scheme version.

Returns:

The source coding scheme version.

Throws:

ETSDataException - If a data transport error occurs.

getTargetVersion

CodingSchemeVersion getTargetVersion()
                              throws ETSDataException

Gets the target coding scheme version.

Returns:

The target coding scheme version.

Throws:

ETSDataException - If a data transport error occurs.

getDefaultCrossMap

CrossMap getDefaultCrossMap(Concept source)
                     throws ETSDataException,
                            ETSNotFoundException,
                            ETSBadParameterException

Gets the default cross map for the specified source concept.

Parameters:

source - Source concept.

Returns:

Default cross map of the specified source concept.

Throws:

ETSNotFoundException - If the required cross map does not exist.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getMapTargets

MapTarget[] getMapTargets()
                   throws ETSDataException

Gets an array of all possible cross map targets for this MapSet object.

Returns:

Array of all possible cross map targets for this MapSet object.

Throws:

ETSDataException - If a data transport error occurs.

getMultiplicity

String getMultiplicity()

Gets the code that represents multiplicity of this MapSet object. The cross map importer guarantees that cross maps do not violate their stated multiplicity. The importer guarantees that each cross map source is mapped to one target. The maximum length of this attribute is 12.

Returns:

Code that represents multiplicity of this MapSet object.

getRealmCode

String getRealmCode()

Gets the realm code of this MapSet object. The realm code specifies a context (Example, geographical, political, and organizational) in which a particular MapSet is applicable. At present, realm code is only relevant to SNOMED cross map sets. The maximum length of this attribute is 30.

Returns:

Realm code of this MapSet object.

getRuleType

String getRuleType()

Gets the type of machine-readable rule used in the TargetRule column of the MapTarget file or the MapRule column of the CrossMap file. The machine-readable rule is used as a guideline to a rule processor. It specifies how the rule processor should process the rules.

This method is included to support future functionality in SNOMED CT and other map set vendors who wish to implement rules. The map set vendor defines the rule type. This method will return null if the terminology does not define any rule type.

The maximum length of this attribute is 8.

Returns:

Terminology defined rule type, or null.

getName

String getName()

Gets the unique name of this MapSet object. The maximum length of this attribute is 255.

Returns:

The unique name of this MapSet object.

getMapTargetByTargetCode

MapTarget getMapTargetByTargetCode(String code)
                            throws ETSDataException,
                                   ETSNotFoundException,
                                   ETSBadParameterException

Gets the MapTarget object that matches the specified vendor-assigned target code. Example of a map set vendor is SNOMED-CT.

Parameters:

code - Vendor assigned target code.

Returns:

MapTarget that matches the specified vendor assigned target code.

Throws:

ETSNotFoundException - If the required MapTarget does not exist in this MapTarget object.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getCode

String getCode()

Gets the code assigned to this MapTarget object by the MapTarget vendor. The maximum length of this attribute is 30.

Returns:

Code assigned to this MapTarget object by the MapTarget vendor.

getVendor

String getVendor()

Gets the name of the vendor of this MapTarget object. The maximum length of this attribute is 50.

Returns:

Name of the vendor of this MapTarget object.

getDescription

String getDescription()

Gets the optional description of this MapTarget object. This method returns null if this MapTarget object does not have any optional description. The maximum length of this attribute is 255.

Returns:

Optional description of this MapTarget object, or null if this MapTarget object does not have any optional description.