org.hl7.fhir.r4.terminologies

Interface ITerminologyServices

public interface ITerminologyServices

The value set system has a collection of value sets that define code systems, and construct value sets from them Large external terminologies - LOINC, Snomed, etc - are too big, and trying to represent their definition as a native value set is too large. (e.g. LOINC + properties ~ 500MB). So we don't try. Instead. we assume that there's some external server that provides these services, using this interface The FHIR build tool uses http://fhir.healthintersections.com.au for these services

Author:

Grahame

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ITerminologyServices.ValidationResult

Method Summary

Modifier and Type	Method and Description
boolean	checkVS(ValueSet.ConceptSetComponent vsi, String system, String code) Test the value set fragment (system | codes | filters).
ValueSetExpander.ValueSetExpansionOutcome	expand(ValueSet vs)
ValueSet.ValueSetExpansionComponent	expandVS(ValueSet.ConceptSetComponent inc) Expand the value set fragment (system | codes | filters).
CodeSystem.ConceptDefinitionComponent	getCodeDefinition(String system, String code) given a system|code, return a definition for it.
boolean	supportsSystem(String system) return true if the service handles code or value set resolution on the system
ITerminologyServices.ValidationResult	validateCode(String system, String code, String display) for this system|code and display, validate the triple against the rules of the underlying code system
boolean	verifiesSystem(String system)

Method Detail

supportsSystem

boolean supportsSystem(String system)

return true if the service handles code or value set resolution on the system

getCodeDefinition

CodeSystem.ConceptDefinitionComponent getCodeDefinition(String system,
                                                        String code)

given a system|code, return a definition for it. Nil means not valid

validateCode

ITerminologyServices.ValidationResult validateCode(String system,
                                                   String code,
                                                   String display)

for this system|code and display, validate the triple against the rules of the underlying code system

expandVS

ValueSet.ValueSetExpansionComponent expandVS(ValueSet.ConceptSetComponent inc)
                                      throws Exception

Expand the value set fragment (system | codes | filters). Note that this might fail if the expansion is very large. If the expansion fails, then the checkVS will be called instead

Throws:

Exception

expand

ValueSetExpander.ValueSetExpansionOutcome expand(ValueSet vs)

checkVS

boolean checkVS(ValueSet.ConceptSetComponent vsi,
                String system,
                String code)

Test the value set fragment (system | codes | filters).

verifiesSystem

boolean verifiesSystem(String system)