oracle.hsgbu.ets.loinc

Interface LOINCCodingSchemeVersion

All Superinterfaces:

AttributableETSComponent, CodingSchemeVersion, ConceptContainer, ETSComponent

public interface LOINCCodingSchemeVersion
extends CodingSchemeVersion

Defines the additional operations that are supported by the LOINC terminology. These operations are not supported by the generic ETS model. This interface defines methods to get:

• Array of LOINCConcept objects that match the specified filter, fully qualified name pattern, or relationship pattern.
• Array of LOINCConcept objects that are within the specified class.
• The LOINCFilterArg object that is used for LOINC search.

See Also:

CodingSchemeVersion

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTACHMENT_CLASS The Attachment Class Identifier.
static int	CLINICAL_CLASS The Clinical Class Identifier.
static int	LABORATORY_CLASS The Laboratory Class Identifier.
static int	SURVEY_CLASS The Survey Class identifier.

Method Summary

Modifier and Type	Method and Description
LOINCConcept[]	getConcepts(int loincClass) Gets an array of LOINCConcept objects contained in the class that matches the specified class identifier.
LOINCConcept[]	getConcepts(int loincClass, String relPattern) Gets an array of LOINCConcept objects that match the relationship pattern specified in the parameter.
LOINCConcept[]	getConcepts(LOINCSearchFilter filter) Gets an array of LOINCConcept objects that match the specified LOINCSearchFilter.
LOINCConcept[]	getConcepts(String pattern) Gets an array of LOINCConcept objects that match the fully qualified LOINC name pattern specified in the parameter.
LOINCSearchFilter	getSearchFilter() Gets a LOINCSearchFilter object that is used by the calling program to perform a search for LOINCConcept objects based on the fully qualified LOINC name.
LOINCFilterArg	getSearchFilterArgument() Gets a LOINCFilterArg object that can be placed within a LOINCSearchFilter.

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

findConceptsByMatchingDescPatternAndConTypeCode, findConceptsByMatchingDescPatternAndDescTypeCode, getAllVersions, getCodingScheme, getConceptByConceptCode, getConceptsByExtendedTypeCode, getDefaultVersion, getDescription, getLatestActiveVersion, getLoadDate, getLocaleMaps, getName, getNextVersion, getPreviousVersion, getRelationshipTypes, getRetiredDate, isActive, isDefaultVersion, isQuarantined, isRetired, isValidConceptCode

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

Field Detail

ATTACHMENT_CLASS

static final int ATTACHMENT_CLASS

The Attachment Class Identifier.

See Also:

Constant Field Values

CLINICAL_CLASS

static final int CLINICAL_CLASS

The Clinical Class Identifier.

See Also:

Constant Field Values

LABORATORY_CLASS

static final int LABORATORY_CLASS

The Laboratory Class Identifier.

See Also:

Constant Field Values

SURVEY_CLASS

static final int SURVEY_CLASS

The Survey Class identifier.

See Also:

Constant Field Values

Method Detail

getConcepts

LOINCConcept[] getConcepts(LOINCSearchFilter filter)
                    throws ETSDataException,
                           ETSBadParameterException

Gets an array of LOINCConcept objects that match the specified LOINCSearchFilter. The filter is applied on the fully qualified LOINC names of the records. It returns an empty array if the required LOINCConcept objects are not available.

Parameters:

filter - LOINCSearchFilter object.

Returns:

Array of LOINCConcept objects, or an empty array if the required LOINCConcept objects are not available.

Throws:

ETSDataException - If data transport exception occurs.

ETSBadParameterException - If an invalid argument is passed.

getConcepts

LOINCConcept[] getConcepts(String pattern)
                    throws ETSDataException,
                           ETSBadParameterException

Gets an array of LOINCConcept objects that match the fully qualified LOINC name pattern specified in the parameter. It returns an empty array if the required LOINCConcept objects are not available.

Parameters:

pattern - Fully qualified LOINC name, in Oracle Text format.

Returns:

Array of LOINCConcept objects, or an empty array if the required LOINCConcept objects are not available.

Throws:

ETSDataException - If data transport exception occurs.

ETSBadParameterException - If an invalid argument is passed , or if the pattern is a wildcard search (%xxx%) that has less than 3 alphanumeric characters.

getConcepts

LOINCConcept[] getConcepts(int loincClass,
                           String relPattern)
                    throws ETSDataException,
                           ETSBadParameterException

Gets an array of LOINCConcept objects that match the relationship pattern specified in the parameter. The relationship pattern is applicable to the specified class identifier. For example, the method will get all matching concepts in the ATTACHMENT class with the relationship pattern ATTACH. This method returns all matching LOINCConcept objects including first level LOINCConcept objects. For example, ATTACH.REHAB and ATTACH.REHAB.ABUSE will be returned by this method. It returns an empty array if the required LOINCConcept objects are not available.

Parameters:

loincClass - LOINC class identifier.

relPattern - LOINC relationship abbreviation pattern.

Returns:

Array of LOINCConcept objects, or an empty array if the required LOINCConcept objects are not available.

Throws:

ETSDataException - If data transport error occurs.

ETSBadParameterException - If an invalid LOINC class identifier is passed.

getConcepts

LOINCConcept[] getConcepts(int loincClass)
                    throws ETSDataException,
                           ETSBadParameterException

Gets an array of LOINCConcept objects contained in the class that matches the specified class identifier. For example, this method returns all concepts in the Clinical class when the clinical call identifier is specified in the parameter. It returns an empty array if the particular class does not contain any LOINCConcept objects.

Parameters:

loincClass - LOINC class identifier.

Returns:

Array of LOINCConcept objects, or an empty array if the particular class does not contain any LOINCConcept objects.

Throws:

ETSDataException - If data transport error occurs.

ETSBadParameterException - If the class identifier is invalid.

getSearchFilter

LOINCSearchFilter getSearchFilter()

Gets a LOINCSearchFilter object that is used by the calling program to perform a search for LOINCConcept objects based on the fully qualified LOINC name.

Returns:

LOINCSearchFilter object.

getSearchFilterArgument

LOINCFilterArg getSearchFilterArgument()

Gets a LOINCFilterArg object that can be placed within a LOINCSearchFilter.

Returns:

LOINCFilterArg object.