Package com.ibm.fhir.term.service.provider

Class DefaultTermServiceProvider

java.lang.Object

com.ibm.fhir.term.service.provider.DefaultTermServiceProvider

All Implemented Interfaces:

FHIRTermServiceProvider

public class DefaultTermServiceProvider
extends Object
implements FHIRTermServiceProvider

Default implementation of the FHIRTermServiceProvider interface using CodeSystemSupport, ConceptMapSupport, and ValueSetSupport

Constructor Summary

Constructors

Constructor	Description
DefaultTermServiceProvider()

Method Summary

Modifier and Type	Method	Description
Set<CodeSystem.Concept>	closure(Coding coding)	Generate the transitive closure for the code system concept represented by the given coding
ValueSet	expand(ValueSet valueSet, ExpansionParameters parameters)	Expand the given value set and expansion parameters
boolean	isExpandable(ValueSet valueSet)	Indicates whether the given value set is expandable
LookupOutcome	lookup(Coding coding, LookupParameters parameters)	Lookup the code system concept for the given coding and lookup parameters
ConceptSubsumptionOutcome	subsumes(Coding codingA, Coding codingB)	Perform a subsumption test to determine if the code system concept represented by the given coding "A" subsumes the code system concept represented by the given coding "B"
TranslationOutcome	translate(ConceptMap conceptMap, CodeableConcept codeableConcept, TranslationParameters parameters)	Translate the given codeable concept using the provided concept map and translation parameters
TranslationOutcome	translate(ConceptMap conceptMap, Coding coding, TranslationParameters parameters)	Translate the given coding using the provided concept map and translation parameters
ValidationOutcome	validateCode(CodeSystem codeSystem, CodeableConcept codeableConcept, ValidationParameters parameters)	Validate a codeable concept using the provided code system and validation parameters
ValidationOutcome	validateCode(CodeSystem codeSystem, Coding coding, ValidationParameters parameters)	Validate a coding using the provided code system and validation parameters
ValidationOutcome	validateCode(ValueSet valueSet, CodeableConcept codeableConcept, ValidationParameters parameters)	Validate a codeable concept using the provided value set using the provided validation parameters
ValidationOutcome	validateCode(ValueSet valueSet, Code code, ValidationParameters parameters)	Validate a code using the provided value set and validation parameters
ValidationOutcome	validateCode(ValueSet valueSet, Coding coding, ValidationParameters parameters)	Validate a coding using the provided value set using the provided validation parameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.fhir.term.spi.FHIRTermServiceProvider

expand, lookup, lookup, lookup, translate, translate, translate, translate, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode, validateCode

Constructor Detail

DefaultTermServiceProvider

public DefaultTermServiceProvider()

Method Detail

isExpandable

public boolean isExpandable(ValueSet valueSet)

Description copied from interface: FHIRTermServiceProvider

Indicates whether the given value set is expandable

Specified by:

isExpandable in interface FHIRTermServiceProvider

Parameters:

valueSet - the value set

Returns:

true if the given value set is expandable, false otherwise

expand

public ValueSet expand(ValueSet valueSet,
                       ExpansionParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Expand the given value set and expansion parameters

Specified by:

expand in interface FHIRTermServiceProvider

Parameters:

valueSet - the value set to expand

parameters - the expansion parameters

Returns:

the expanded value set, or the original value set if already expanded or unable to expand

lookup

public LookupOutcome lookup(Coding coding,
                            LookupParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Lookup the code system concept for the given coding and lookup parameters

Specified by:

lookup in interface FHIRTermServiceProvider

Parameters:

coding - the coding to lookup

parameters - the lookup parameters

Returns:

the outcome of the lookup

subsumes

public ConceptSubsumptionOutcome subsumes(Coding codingA,
                                          Coding codingB)

Description copied from interface: FHIRTermServiceProvider

Perform a subsumption test to determine if the code system concept represented by the given coding "A" subsumes the code system concept represented by the given coding "B"

Specified by:

subsumes in interface FHIRTermServiceProvider

Parameters:

codingA - the coding "A"

codingB - the coding "B"

Returns:

the outcome of the subsumption test

closure

public Set<CodeSystem.Concept> closure(Coding coding)

Description copied from interface: FHIRTermServiceProvider

Generate the transitive closure for the code system concept represented by the given coding

Specified by:

closure in interface FHIRTermServiceProvider

Parameters:

coding - the coding

Returns:

a set containing the transitive closure for the code system concept represented by the given coding

validateCode

public ValidationOutcome validateCode(CodeSystem codeSystem,
                                      Coding coding,
                                      ValidationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Validate a coding using the provided code system and validation parameters

Specified by:

validateCode in interface FHIRTermServiceProvider

Parameters:

codeSystem - the code system

coding - the coding

parameters - the validation parameters

Returns:

the outcome of validation

validateCode

public ValidationOutcome validateCode(CodeSystem codeSystem,
                                      CodeableConcept codeableConcept,
                                      ValidationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Validate a codeable concept using the provided code system and validation parameters

Specified by:

validateCode in interface FHIRTermServiceProvider

Parameters:

codeSystem - the code system

codeableConcept - the codeable concept

parameters - the validation parameters

Returns:

the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      Code code,
                                      ValidationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Validate a code using the provided value set and validation parameters

Specified by:

validateCode in interface FHIRTermServiceProvider

Parameters:

valueSet - the value set

code - the code

parameters - the validation parameters

Returns:

the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      Coding coding,
                                      ValidationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Validate a coding using the provided value set using the provided validation parameters

Specified by:

validateCode in interface FHIRTermServiceProvider

Parameters:

valueSet - the value set

coding - the coding

parameters - the validation parameters

Returns:

the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      CodeableConcept codeableConcept,
                                      ValidationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Validate a codeable concept using the provided value set using the provided validation parameters

Specified by:

validateCode in interface FHIRTermServiceProvider

Parameters:

valueSet - the value set

parameters - the validation parameters

Returns:

the outcome of validation

translate

public TranslationOutcome translate(ConceptMap conceptMap,
                                    Coding coding,
                                    TranslationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Translate the given coding using the provided concept map and translation parameters

Specified by:

translate in interface FHIRTermServiceProvider

Parameters:

conceptMap - the concept map

coding - the coding

parameters - the translation parameters

Returns:

the outcome of translation

translate

public TranslationOutcome translate(ConceptMap conceptMap,
                                    CodeableConcept codeableConcept,
                                    TranslationParameters parameters)

Description copied from interface: FHIRTermServiceProvider

Translate the given codeable concept using the provided concept map and translation parameters

Specified by:

translate in interface FHIRTermServiceProvider

Parameters:

conceptMap - the concept map

codeableConcept - the codeable concept

parameters - the translation parameters

Returns:

the outcome of translation