java.lang.Object
- com.ibm.fhir.term.service.FHIRTermService

public class FHIRTermService
extends Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Set<CodeSystem.Concept>`	`closure(CodeSystem codeSystem, CodeSystem.Concept concept)`
`Set<CodeSystem.Concept>`	`closure(Coding coding)`	Generate the transitive closure for the code system concept represented by the given coding
`ValueSet`	`expand(ValueSet valueSet)`	Expand the given value set
`ValueSet`	`expand(ValueSet valueSet, ExpansionParameters parameters)`	Expand the given value set and expansion parameters
`CodeSystem.Concept`	`findConcept(CodeSystem codeSystem, CodeSystem.Concept concept, Code code)`	Find the concept in tree rooted by the provided concept that matches the specified code.
`CodeSystem.Concept`	`findConcept(CodeSystem codeSystem, Code code)`	Find the concept in the provided code system that matches the specified code.
`Set<CodeSystem.Concept>`	`getConcepts(CodeSystem codeSystem)`	Get a set containing `CodeSystem.Concept` instances where all structural hierarchies have been flattened.
`Set<CodeSystem.Concept>`	`getConcepts(CodeSystem codeSystem, CodeSystem.Concept concept)`	Get a set containing `CodeSystem.Concept` instances where all structural hierarchies have been flattened.
`static FHIRTermService`	`getInstance()`
`boolean`	`isExpandable(ValueSet valueSet)`	Indicates whether the given value set is expandable
`boolean`	`isSupported(CodeSystem codeSystem)`	Indicates whether the given code system is supported
`LookupOutcome`	`lookup(Coding coding)`	Lookup the code system concept for the given coding
`LookupOutcome`	`lookup(Coding coding, LookupParameters parameters)`	Lookup the code system concept for the given coding and lookup parameters
`LookupOutcome`	`lookup(Uri system, String version, Code code)`	Lookup the code system concept for the given system, version, and code
`LookupOutcome`	`lookup(Uri system, String version, Code code, LookupParameters parameters)`	Lookup the code system concept for the given system, version, code and lookup parameters
`void`	`register(FHIRTermServiceProvider provider)`	Register the given `FHIRTermServiceProvider`
`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)`	Translate the given coding using the provided concept map
`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)`	Translate the given coding using the provided concept map
`TranslationOutcome`	`translate(ConceptMap conceptMap, Coding coding, TranslationParameters parameters)`	Translate the given coding using the provided concept map and translation parameters
`TranslationOutcome`	`translate(ConceptMap conceptMap, Uri system, String version, Code code)`	Translate the given system, version and code using the provided concept map
`TranslationOutcome`	`translate(ConceptMap conceptMap, Uri system, String version, Code code, TranslationParameters parameters)`	Translate the given system, version and code using the provided concept map and translation parameters
`ValidationOutcome`	`validateCode(CodeSystem codeSystem, CodeableConcept codeableConcept)`	Validate a codeable concept using the provided code system
`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)`	Validate a coding using the provided code system
`ValidationOutcome`	`validateCode(CodeSystem codeSystem, Coding coding, ValidationParameters parameters)`	Validate a coding using the provided code system and validation parameters
`ValidationOutcome`	`validateCode(CodeSystem codeSystem, String version, Code code, String display)`	Validate a code and display using the provided code system and version
`ValidationOutcome`	`validateCode(CodeSystem codeSystem, String version, Code code, String display, ValidationParameters parameters)`	Validate a code and display using the provided code system, version and validation parameters
`ValidationOutcome`	`validateCode(ValueSet valueSet, Code code)`	Validate a code using the provided value set
`ValidationOutcome`	`validateCode(ValueSet valueSet, CodeableConcept codeableConcept)`	Validate a codeable concept using the provided value set
`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)`	Validate a coding using the provided value set using the provided validation parameters
`ValidationOutcome`	`validateCode(ValueSet valueSet, Coding coding, ValidationParameters parameters)`	Validate a coding using the provided value set using the provided validation parameters
`ValidationOutcome`	`validateCode(ValueSet valueSet, Uri system, String version, Code code, String display)`	Validate a code and display using the provided value set
`ValidationOutcome`	`validateCode(ValueSet valueSet, Uri system, String version, Code code, String display, ValidationParameters parameters)`	Validate a code and display using the provided value set and validation parameters

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

register
```
public void register(FHIRTermServiceProvider provider)
```
Register the given FHIRTermServiceProvider

Parameters:

provider - the term service provider

getInstance

public static FHIRTermService getInstance()

isSupported
```
public boolean isSupported(CodeSystem codeSystem)
```
Indicates whether the given code system is supported

Parameters:

codeSystem - the code system

Returns:

true if the given code system is supported, false otherwise

findConcept
```
public CodeSystem.Concept findConcept(CodeSystem codeSystem,
                                      Code code)
```
Find the concept in the provided code system that matches the specified code.

Parameters:

codeSystem - the code system to search

code - the code to match

Returns:

the code system concept that matches the specified code, or null if no such concept exists

findConcept
```
public CodeSystem.Concept findConcept(CodeSystem codeSystem,
                                      CodeSystem.Concept concept,
                                      Code code)
```
Find the concept in tree rooted by the provided concept that matches the specified code.

Parameters:

codeSystem - the code system

concept - the root of the hierarchy to search

code - the code to match

Returns:

the code system concept that matches the specified code, or null if not such concept exists

getConcepts
```
public Set<CodeSystem.Concept> getConcepts(CodeSystem codeSystem)
```
Get a set containing CodeSystem.Concept instances where all structural hierarchies have been flattened.

Parameters:

codeSystem - the code system

Returns:

flattened list of Concept instances for the given code system

getConcepts
```
public Set<CodeSystem.Concept> getConcepts(CodeSystem codeSystem,
                                           CodeSystem.Concept concept)
```
Get a set containing CodeSystem.Concept instances where all structural hierarchies have been flattened.

Parameters:

codeSystem - the code system

concept - the root of the hierarchy containing the Concept instances to be flattened

Returns:

flattened set of Concept instances for the given tree

isExpandable
```
public boolean isExpandable(ValueSet valueSet)
```
Indicates whether the given value set is expandable

Parameters:

valueSet - the value set

Returns:

true if the given value set is expandable, false otherwise

expand
```
public ValueSet expand(ValueSet valueSet,
                       ExpansionParameters parameters)
```
Expand the given value set and expansion parameters

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

expand
```
public ValueSet expand(ValueSet valueSet)
```
Expand the given value set

Parameters:

valueSet - the value set to expand

Returns:

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

lookup

public LookupOutcome lookup(Uri system,
                            String version,
                            Code code,
                            LookupParameters parameters)

Lookup the code system concept for the given system, version, code and lookup parameters

Parameters:: system - the system; version - the version; code - the code; parameters - the lookup parameters
Returns:: the outcome of the lookup

lookup

public LookupOutcome lookup(Uri system,
                            String version,
                            Code code)

Lookup the code system concept for the given system, version, and code

Parameters:: system - the system; version - the version; code - the code
Returns:: the outcome of the lookup

lookup
```
public LookupOutcome lookup(Coding coding,
                            LookupParameters parameters)
```
Lookup the code system concept for the given coding and lookup parameters

Parameters:

coding - the coding to lookup

parameters - the lookup parameters

Returns:

the outcome of the lookup

lookup
```
public LookupOutcome lookup(Coding coding)
```
Lookup the code system concept for the given coding

Parameters:

coding - the coding to lookup

Returns:

the outcome of the lookup

subsumes
```
public 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"

Parameters:

codingA - the coding "A"

codingB - the coding "B"

Returns:

the outcome of the subsumption test

closure

public Set<CodeSystem.Concept> closure(CodeSystem codeSystem,
                                       CodeSystem.Concept concept)

closure
```
public Set<CodeSystem.Concept> closure(Coding coding)
```
Generate the transitive closure for the code system concept represented by the given coding

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,
                                      String version,
                                      Code code,
                                      String display,
                                      ValidationParameters parameters)

Validate a code and display using the provided code system, version and validation parameters

Parameters:: codeSystem - the code system; version - the version; code - the code; display - the display; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(CodeSystem codeSystem,
                                      String version,
                                      Code code,
                                      String display)

Validate a code and display using the provided code system and version

Parameters:: code - system the code system; version - the version; code - the code; display - the display
Returns:: the outcome of validation

validateCode

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

Validate a coding using the provided code system and validation parameters

Parameters:: codeSystem - the code system; coding - the coding; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(CodeSystem codeSystem,
                                      Coding coding)

Validate a coding using the provided code system

Parameters:: codeSystem - the codeSystem; coding - the coding
Returns:: the outcome of validation

validateCode

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

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

Parameters:: codeSystem - the code system; codeableConcept - the codeable concept; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(CodeSystem codeSystem,
                                      CodeableConcept codeableConcept)

Validate a codeable concept using the provided code system

Parameters:: codeableConcept - the codeable concept
Returns:: the outcome of validation

validateCode

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

Validate a code using the provided value set and validation parameters

Parameters:: valueSet - the value set; code - the code; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      Code code)

Validate a code using the provided value set

Parameters:: valueSet - the value set; code - the code
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      Uri system,
                                      String version,
                                      Code code,
                                      String display,
                                      ValidationParameters parameters)

Validate a code and display using the provided value set and validation parameters

Parameters:: valueSet - the value set; system - the system; version - the version; code - the code; display - the display; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      Uri system,
                                      String version,
                                      Code code,
                                      String display)

Validate a code and display using the provided value set

Parameters:: valueSet - the value set; system - the system; version - the version; code - the code; display - the display
Returns:: the outcome of validation

validateCode

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

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

Parameters:: valueSet - the value set; coding - the coding; parameters - the validation parameters
Returns:: the outcome of validation

validateCode
```
public ValidationOutcome validateCode(ValueSet valueSet,
                                      Coding coding)
```
Validate a coding using the provided value set using the provided validation parameters

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)

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

Parameters:: valueSet - the value set; codeable - concept the codeable concept; parameters - the validation parameters
Returns:: the outcome of validation

validateCode

public ValidationOutcome validateCode(ValueSet valueSet,
                                      CodeableConcept codeableConcept)

Validate a codeable concept using the provided value set

Parameters:: valueSet - the value set; codeable - concept the codeable concept
Returns:: the outcome of validation

translate

public TranslationOutcome translate(ConceptMap conceptMap,
                                    Uri system,
                                    String version,
                                    Code code,
                                    TranslationParameters parameters)

Translate the given system, version and code using the provided concept map and translation parameters

Parameters:: conceptMap - the concept map; system - the system; version - the version; code - the code; parameters - the translation parameters
Returns:: the outcome of translation

translate

public TranslationOutcome translate(ConceptMap conceptMap,
                                    Uri system,
                                    String version,
                                    Code code)

Translate the given system, version and code using the provided concept map

Parameters:: conceptMap - the concept map; system - the system; version - the version; code - the code
Returns:: the outcome of translation

translate

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

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

Parameters:: conceptMap - the concept map; coding - the coding; parameters - the translation parameters
Returns:: the outcome of translation

translate

public TranslationOutcome translate(ConceptMap conceptMap,
                                    Coding coding)

Translate the given coding using the provided concept map

Parameters:: conceptMap - the concept map; coding - the coding
Returns:: the outcome of translation

translate

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

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

Parameters:: conceptMap - the concept map; codeableConcept - the codeable concept; parameters - the translation parameters
Returns:: the outcome of translation

translate
```
public TranslationOutcome translate(ConceptMap conceptMap,
                                    CodeableConcept codeableConcept)
```
Translate the given coding using the provided concept map

Parameters:

conceptMap - the concept map

codeable - concept the codeable concept

Returns:

the outcome of translation

Class FHIRTermService

Method Summary

Methods inherited from class java.lang.Object

Method Detail

register

getInstance

isSupported

findConcept

findConcept

getConcepts

getConcepts

isExpandable

expand

expand

lookup

lookup

lookup

lookup

subsumes

closure

closure

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

translate

translate

translate

translate

translate

translate