oracle.hsgbu.ets.base

Interface CodingSchemeVersion

All Superinterfaces:

AttributableETSComponent, ConceptContainer, ETSComponent

All Known Subinterfaces:

FDBCodingSchemeVersion, LOINCCodingSchemeVersion, SNOMEDCodingSchemeVersion

public interface CodingSchemeVersion
extends ConceptContainer, AttributableETSComponent

Represents a single version or release of a CodingScheme object, such as SNOMED-CT July 2004.

See Also:

CodingScheme, ConceptContainer

Method Summary

Modifier and Type	Method and Description
Concept[]	findConceptsByMatchingDescPatternAndConTypeCode(String pattern, String extendedTypeCode) Retrieves the Concept objects that have a defined TerminologyConceptDescription or LocalConceptDescription that contains the pattern within the description text, and the concept is of the specified extendedTypeCode.
Concept[]	findConceptsByMatchingDescPatternAndDescTypeCode(String pattern, String extendedTypeCode) Retrieves the Concept objects that have a defined TerminologyConceptDescription that contains the specified pattern within the description text, and the TerminologyConceptDescription is of the specified extendedTypeCode.
CodingSchemeVersion[]	getAllVersions() Gets all versions of the CodingScheme object to which this CodingSchemeVersion object belongs.
CodingScheme	getCodingScheme() Gets the CodingScheme object associated with this CodingSchemeVersion object.
Concept	getConceptByConceptCode(String conceptCode) Gets a concept in this CodingSchemeVersion object based on the specified vendor-defined unique concept code.
Concept[]	getConceptsByExtendedTypeCode(String extendedTypeCode) Retrieves the Concept objects of the specified extendedTypeCode.
CodingSchemeVersion	getDefaultVersion() Gets the default version of CodingScheme object to which this CodingSchemeVersion object belongs.
String	getDescription() Gets the description of this CodingSchemeVersion object.
CodingSchemeVersion	getLatestActiveVersion() Gets the latest active version of the CodingScheme object to which this CodingSchemeVersion object belongs.
Date	getLoadDate() Gets the date when this CodingSchemeVersion object was published to the active repository.
LocaleMap[]	getLocaleMaps() Gets an array of all the LocaleMap objects for this CodingSchemeVersion object, or a zero-length array if there are none.
String	getName() Gets the name of this CodingSchemeVersion object.
CodingSchemeVersion	getNextVersion() Gets the next chronological version of the CodingScheme object to which this CodingSchemeVersion object belongs.
CodingSchemeVersion	getPreviousVersion() Gets the previous chronological version of the CodingScheme object to which this CodingSchemeVersion object belongs.
Concept[]	getRelationshipTypes() Gets the set of all Concept objects that can act as relationships among this CodingSchemeVersion objects.
Date	getRetiredDate() Gets the date when the status of this CodingSchemeVersion object was set to retired.
boolean	isActive() Indicates if the CodingSchemeVersion object is active.
boolean	isDefaultVersion() Indicates if this CodingSchemeVersion object is the default version within its parent CodingScheme.
boolean	isQuarantined() Indicates if the CodingSchemeVersion object is quarantined.
boolean	isRetired() Indicates if this CodingSchemeVersion object is retired.
boolean	isValidConceptCode(String conceptCode) Checks the vendor-defined unique concept code against the CodingSchemeVersion and indicates if a matching Concept exists.

Methods inherited from interface oracle.hsgbu.ets.base.ConceptContainer

contains, getAllConcepts, getConceptsWithAttribute, getConceptsWithAttributeName, getMatchingConceptsByDescriptionTerm, getMatchingConceptsByDescriptionTerm, getNumberOfConcepts

Methods inherited from interface oracle.hsgbu.ets.base.AttributableETSComponent

getAttributeNames, getAttributes, getAttributes

Methods inherited from interface oracle.hsgbu.ets.base.ETSComponent

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Method Detail

getDescription

String getDescription()

Gets the description of this CodingSchemeVersion object. The maximum length of this attribute is 240.

Returns:

Description of this CodingSchemeVersion object.

getName

String getName()

Gets the name of this CodingSchemeVersion object. The maximum length of this attribute is 240.

Returns:

Name of this CodingSchemeVersion object.

getCodingScheme

CodingScheme getCodingScheme()
                      throws ETSDataException

Gets the CodingScheme object associated with this CodingSchemeVersion object. This method uses server-side caching.

Returns:

Parent CodingScheme of this CodingSchemeVersion object.

Throws:

ETSDataException - If a data transport error occurs.

getRelationshipTypes

Concept[] getRelationshipTypes()
                        throws ETSDataException

Gets the set of all Concept objects that can act as relationships among this CodingSchemeVersion objects. This method retrieves every concept with the relationship type flag set to true.

Returns:

Array of Concept objects that can act as relationships among this CodingSchemeVersion objects, or a zero-length array if Concept objects that cannot act as relationships within this CodingSchemeVersion objects.

Throws:

ETSDataException - If a data transport error occurs.

isValidConceptCode

boolean isValidConceptCode(String conceptCode)
                    throws ETSDataException,
                           ETSBadParameterException

Checks the vendor-defined unique concept code against the CodingSchemeVersion and indicates if a matching Concept exists.

Parameters:

conceptCode - Vendor-defined unique concept code.

Returns:

true if a matching Concept exists in this CodingSchemeVersion object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid concept code is passed.

getConceptByConceptCode

Concept getConceptByConceptCode(String conceptCode)
                         throws ETSNotFoundException,
                                ETSDataException,
                                ETSBadParameterException

Gets a concept in this CodingSchemeVersion object based on the specified vendor-defined unique concept code. This method uses server-side caching.

Parameters:

conceptCode - Vendor-defined unique concept code.

Returns:

Concept matching the specified vendor-defined unique concept code.

Throws:

ETSNotFoundException - If the code does not match any concepts in CodingSchemeVersion.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid concept code is passed.

getAllVersions

CodingSchemeVersion[] getAllVersions()
                              throws ETSDataException

Gets all versions of the CodingScheme object to which this CodingSchemeVersion object belongs.

Returns:

Array of all versions of the CodingScheme object in ascending order of load date.

Throws:

ETSDataException - If a data transport error occurs.

getDefaultVersion

CodingSchemeVersion getDefaultVersion()
                               throws ETSDataException

Gets the default version of CodingScheme object to which this CodingSchemeVersion object belongs. This method returns this CodingSchemeVersion object, if it is the default. This method uses server-side caching.

Returns:

Default version of the CodingScheme object.

Throws:

ETSDataException - If a data transport error occurs.

getLatestActiveVersion

CodingSchemeVersion getLatestActiveVersion()
                                    throws ETSDataException,
                                           ETSNotFoundException

Gets the latest active version of the CodingScheme object to which this CodingSchemeVersion object belongs.

Returns:

Latest version of the CodingScheme object.

Throws:

ETSNotFoundException - If there are no active versions of the coding scheme.

ETSDataException - If a data transport error occurs.

getLoadDate

Date getLoadDate()

Gets the date when this CodingSchemeVersion object was published to the active repository.

Returns:

Date when this CodingSchemeVersion object was published to the active repository.

getNextVersion

CodingSchemeVersion getNextVersion()
                            throws ETSNotFoundException,
                                   ETSDataException

Gets the next chronological version of the CodingScheme object to which this CodingSchemeVersion object belongs.

Returns:

Next version of the CodingScheme object.

Throws:

ETSNotFoundException - If there are no newer published versions than the current version.

ETSDataException - If a data transport error occurs.

getPreviousVersion

CodingSchemeVersion getPreviousVersion()
                                throws ETSDataException,
                                       ETSNotFoundException

Gets the previous chronological version of the CodingScheme object to which this CodingSchemeVersion object belongs.

Returns:

Previous version of the CodingScheme object.

Throws:

ETSNotFoundException - If there are no earlier published versions.

ETSDataException - If a data transport error occurs.

getRetiredDate

Date getRetiredDate()
             throws ETSNotFoundException

Gets the date when the status of this CodingSchemeVersion object was set to retired. This is the real system date when the object was retired, or a date that was specified when the object was retired.

Returns:

Date when this CodingSchemeVersion object was set to retired.

Throws:

ETSNotFoundException - If the CodingSchemeVersion object is still active.

isDefaultVersion

boolean isDefaultVersion()

Indicates if this CodingSchemeVersion object is the default version within its parent CodingScheme.

Returns:

true if this CodingSchemeVersion object is the default within its parent CodingScheme.

isRetired

boolean isRetired()

Indicates if this CodingSchemeVersion object is retired.

Returns:

true if this CodingSchemeVersion object is retired.

isActive

boolean isActive()

Indicates if the CodingSchemeVersion object is active.

Returns:

true if this CodingSchemeVersion object is active.

isQuarantined

boolean isQuarantined()

Indicates if the CodingSchemeVersion object is quarantined.

Returns:

true if this CodingSchemeVersion object is quarantined.

findConceptsByMatchingDescPatternAndDescTypeCode

Concept[] findConceptsByMatchingDescPatternAndDescTypeCode(String pattern,
                                                           String extendedTypeCode)
                                                    throws ETSBadParameterException,
                                                           ETSDataException

Retrieves the Concept objects that have a defined TerminologyConceptDescription that contains the specified pattern within the description text, and the TerminologyConceptDescription is of the specified extendedTypeCode.
NOTE: LocalConceptDescription objects do not have a defined extendedTypeCode.

Parameters:

pattern - Oracle Text string matching pattern. See ConceptContainer.getMatchingConceptsByDescriptionTerm(String).

extendedTypeCode - Extended type code of a concept to filter matching description.

Returns:

Array of concepts whose description match the specified criteria, or a zero-length array if no concept with the matching criteria exists.

Throws:

ETSBadParameterException -

• If the parameters are null or an empty String.
• If the length of pattern is less than three alphanumeric characters.
  NOTE: % is not an alphanumeric character.
• If the length of extendedTypeCode is more than six characters.

ETSDataException - If a data transport error occurs.

findConceptsByMatchingDescPatternAndConTypeCode

Concept[] findConceptsByMatchingDescPatternAndConTypeCode(String pattern,
                                                          String extendedTypeCode)
                                                   throws ETSBadParameterException,
                                                          ETSDataException

Retrieves the Concept objects that have a defined TerminologyConceptDescription or LocalConceptDescription that contains the pattern within the description text, and the concept is of the specified extendedTypeCode.

Parameters:

pattern - Oracle Text string matching pattern.

extendedTypeCode - Extended type code of a concept to filter matching description.

Returns:

Array of concepts whose description match the specified criteria, or a zero-length array if no concept with the matching criteria exists.

Throws:

ETSBadParameterException -

• If the parameters are null or an empty String.
• If the length of pattern is less than three alphanumeric characters.
  NOTE: % is not an alphanumeric character.
• If the length of extendedTypeCode is more than six characters.

ETSDataException - If a data transport error occurs.

See Also:

ConceptContainer.getMatchingConceptsByDescriptionTerm(String)

getConceptsByExtendedTypeCode

Concept[] getConceptsByExtendedTypeCode(String extendedTypeCode)
                                 throws ETSBadParameterException,
                                        ETSDataException

Retrieves the Concept objects of the specified extendedTypeCode.

Parameters:

extendedTypeCode - Extended type code for a concept.

Returns:

Array of Concept objects.

Throws:

ETSBadParameterException -

• If the parameters are null or an empty String.
• If the length of extendedTypeCode is more than six characters.

ETSDataException - If a data transport error occurs.

getLocaleMaps

LocaleMap[] getLocaleMaps()
                   throws ETSDataException

Gets an array of all the LocaleMap objects for this CodingSchemeVersion object, or a zero-length array if there are none.

Note that a zero-length array indicates that this CodingSchemeVersion is not usable. This can be rectified by:

• running the maintenance program in FULL mode to create default LocaleMaps; or
• using the ETSAdministrationService to create LocaleMaps.

Note: The country code of the Locale will be as per ISO 3166 specification(i.e 2-letter country codes defined in ISO 3166) and the language code of the Locale will be as per ISO 639 specification (i.e 2-letter language codes defined in ISO 639). ETS global wild cards for language code(i.e XX) and country code (i.e XX) are also allowed for Locale. System will consider these wild cards as a substitution for any.

Returns:

an array of all the LocaleMap objects for this CodingSchemeVersion object, or a zero-length array if there are none.

Throws:

ETSDataException - If a data transport error occurs.