All Known Implementing Classes:

DefaultTermServiceProvider, FHIRTermService
```
public interface FHIRTermServiceProvider
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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
`default ValueSet`	`expand(ValueSet valueSet)`	Expand the given value set
`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
`default 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
`default LookupOutcome`	`lookup(Uri system, String version, Code code)`	Lookup the code system concept for the given system, version, and code
`default LookupOutcome`	`lookup(Uri system, String version, Code code, LookupParameters parameters)`	Lookup the code system concept for the given system, version, code 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"
`default 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
`default 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
`default TranslationOutcome`	`translate(ConceptMap conceptMap, Uri system, String version, Code code)`	Translate the given system, version and code using the provided concept map
`default 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
`default 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
`default 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
`default ValidationOutcome`	`validateCode(CodeSystem codeSystem, String version, Code code, String display)`	Validate a code and display using the provided code system and version
`default 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
`default ValidationOutcome`	`validateCode(ValueSet valueSet, Code code)`	Validate a code using the provided value set
`default 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
`default 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
`default ValidationOutcome`	`validateCode(ValueSet valueSet, Uri system, String version, Code code, String display)`	Validate a code, system, version, and display using the provided value set
`default ValidationOutcome`	`validateCode(ValueSet valueSet, Uri system, String version, Code code, String display, ValidationParameters parameters)`	Validate a code, system, version, and display using the provided value set and validation parameters

Method Detail

isExpandable
```
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
```
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
```
default 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

default 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

default 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
```
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
```
default 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
```
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
```
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

default 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

default 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

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

default 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

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

default 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

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

default 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

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

Validate a code, system, version, 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
Throws:: IllegalStateException - if a coding cannot be constructed from the passed arguments

validateCode

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

Validate a code, system, version, 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

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
```
default 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

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

default 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

default 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

default 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

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

default 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

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

default 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

Interface FHIRTermServiceProvider

Method Summary

Method Detail

isExpandable

expand

expand

lookup

lookup

lookup

lookup

subsumes

closure

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

translate

translate

translate

translate

translate

translate