oracle.hsgbu.ets.base

Interface CodingScheme

All Superinterfaces:

ETSComponent

public interface CodingScheme
extends ETSComponent

Represents a healthcare terminology, such as ICD-9, LOINC, or SNOMED. The CodingScheme objects act as parent for CodingSchemeVersion, which represents actual released versions of a CodingScheme. There can be zero or more CodingSchemeVersion objects within a CodingScheme.

See Also:

CodingSchemeVersion

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODINGSCHEME_MODEL_GENERIC Constant to represent a GENERIC CodingScheme model.
static String	CODINGSCHEME_MODEL_SNOMED Constant to represent a SNOMED CodingScheme model.

Method Summary

Modifier and Type	Method and Description
Concept[]	bulkFindConcepts(String[] etsIds) Deprecated. This method has been replaced by findConcepts(String[], boolean).
Concept[]	bulkFindConcepts(String[] etsIds, boolean prefetchDescriptions) Deprecated. This method has been replaced by findConcepts(String[], boolean).
Concept[]	findConcepts(String[] etsIds, boolean prefetchDescriptions) Finds the set of concepts within a coding scheme.
CodingSchemeVersion[]	getAllVersions() Gets all the CodingSchemeVersion objects in this CodingScheme object.
CodingSchemeVersion	getDefaultVersion() Gets the default CodingSchemeVersion in this CodingScheme object.
String	getDescription() Gets the description of this CodingScheme object.
CodingSchemeVersion	getLastActiveVersion() Gets the last (chronological) active version of this CodingScheme object.
String	getName() Gets the name of this CodingScheme object.
String	getOID() Gets the object identifier (OID).
CodingSchemeVersion	getVersion(String name) Gets the CodingSchemeVersion object that belongs to this CodingScheme object and has the specified name.
boolean	isEditable() Indicates if this CodingScheme is editable.

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

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Field Detail

CODINGSCHEME_MODEL_GENERIC

static final String CODINGSCHEME_MODEL_GENERIC

Constant to represent a GENERIC CodingScheme model.

See Also:

Constant Field Values

CODINGSCHEME_MODEL_SNOMED

static final String CODINGSCHEME_MODEL_SNOMED

Constant to represent a SNOMED CodingScheme model.

See Also:

Constant Field Values

Method Detail

getDescription

String getDescription()

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

Returns:

Description of this CodingScheme object.

getName

String getName()

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

Returns:

Name of this CodingScheme object.

getOID

String getOID()

Gets the object identifier (OID). The maximum length of this attribute is 240.

Returns:

OID.

getLastActiveVersion

CodingSchemeVersion getLastActiveVersion()
                                  throws ETSNotFoundException,
                                         ETSDataException

Gets the last (chronological) active version of this CodingScheme object.

Returns:

Last (chronological) active version of this CodingScheme object.

Throws:

ETSNotFoundException - If there are no active versions of this CodingScheme object.

ETSDataException - If a data transport error occurs.

getVersion

CodingSchemeVersion getVersion(String name)
                        throws ETSNotFoundException,
                               ETSDataException,
                               ETSBadParameterException

Gets the CodingSchemeVersion object that belongs to this CodingScheme object and has the specified name. This method uses server-side caching.

Parameters:

name - Name of the CodingSchemeVersion object.

Returns:

CodingSchemeVersion object in this CodingScheme object with the specified name.

Throws:

ETSNotFoundException - If there are no versions with the requested name.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the parameter passed is an invalid name.

findConcepts

Concept[] findConcepts(String[] etsIds,
                       boolean prefetchDescriptions)
                throws ETSBadParameterException,
                       ETSDataException

Finds the set of concepts within a coding scheme.

Parameters:

etsIds - Array of ETS identifiers to validate.

prefetchDescriptions - If true, the method attempts a bulk prefetch of the terminology preferred descriptions for the retrieved concepts.

Returns:

Array of Concept objects corresponding to the array of etsIDs that was passed in. If an etsID does not match a concept in this CodingScheme, the corresponding index of the return array is null.

Throws:

ETSBadParameterException - If the etsIds array contains a null value.

ETSDataException - If a data transport error occurs.

bulkFindConcepts

Concept[] bulkFindConcepts(String[] etsIds,
                           boolean prefetchDescriptions)
                    throws ETSBadParameterException,
                           ETSDataException

Deprecated. This method has been replaced by findConcepts(String[], boolean).

This method has been renamed. This signature for the method is deprecated and redirects to the new method.

Throws:

ETSBadParameterException

ETSDataException

bulkFindConcepts

Concept[] bulkFindConcepts(String[] etsIds)
                    throws ETSBadParameterException,
                           ETSDataException

Deprecated. This method has been replaced by findConcepts(String[], boolean).

This method has been renamed. This signature for the method is deprecated and redirects to the new method.

Throws:

ETSBadParameterException

ETSDataException

getAllVersions

CodingSchemeVersion[] getAllVersions()
                              throws ETSDataException

Gets all the CodingSchemeVersion objects in this CodingScheme object.

Returns:

Array of all active and retired CodingSchemeVersion objects in this CodingScheme object, or a zero-length array if no such version of CodingScheme exists.

Throws:

ETSDataException - If a data transport error occurs.

getDefaultVersion

CodingSchemeVersion getDefaultVersion()
                               throws ETSNotFoundException,
                                      ETSDataException

Gets the default CodingSchemeVersion in this CodingScheme object. This method uses server-side caching.

Returns:

Default version of the CodingScheme object.

Throws:

ETSNotFoundException - If the CodingScheme object does not have any loaded versions, or if no version is marked as default.

ETSDataException - If a data transport error occurs.

isEditable

boolean isEditable()
            throws ETSDataException

Indicates if this CodingScheme is editable.

Returns:

true if this CodingScheme is editable.

Throws:

ETSDataException - If a data transport error occurrs.