Package ca.uhn.fhir.jpa.term.api

Interface ITermReadSvc

All Superinterfaces:

ca.uhn.fhir.context.support.IValidationSupport

All Known Implementing Classes:

TermReadSvcImpl

public interface ITermReadSvc
extends ca.uhn.fhir.context.support.IValidationSupport

This interface is the "read" interface for the terminology service. It handles things like lookups, code validations, expansions, concept mappings, etc.

It is intended to only handle read operations, leaving various write operations to other services within the terminology service APIs. (Note that at present, a few write operations remain here- they should be moved but haven't been moved yet)

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uhn.fhir.context.support.IValidationSupport

ca.uhn.fhir.context.support.IValidationSupport.BaseConceptProperty, ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult, ca.uhn.fhir.context.support.IValidationSupport.CodingConceptProperty, ca.uhn.fhir.context.support.IValidationSupport.ConceptDesignation, ca.uhn.fhir.context.support.IValidationSupport.IssueSeverity, ca.uhn.fhir.context.support.IValidationSupport.LookupCodeResult, ca.uhn.fhir.context.support.IValidationSupport.StringConceptProperty, ca.uhn.fhir.context.support.IValidationSupport.TranslateCodeRequest, ca.uhn.fhir.context.support.IValidationSupport.ValueSetExpansionOutcome

Field Summary

Fields inherited from interface ca.uhn.fhir.context.support.IValidationSupport

TYPE_CODING, TYPE_STRING, URL_PREFIX_VALUE_SET

Method Summary

Modifier and Type	Method	Description
void	deleteValueSetAndChildren(ResourceTable theResourceTable)
org.hl7.fhir.r4.model.ValueSet	expandValueSet(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, String theValueSetCanonicalUrl)
org.hl7.fhir.instance.model.api.IBaseResource	expandValueSet(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, org.hl7.fhir.instance.model.api.IBaseResource theValueSetToExpand)	Version independent
void	expandValueSet(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, org.hl7.fhir.instance.model.api.IBaseResource theValueSetToExpand, IValueSetConceptAccumulator theValueSetCodeAccumulator)
org.hl7.fhir.r4.model.ValueSet	expandValueSet(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, org.hl7.fhir.r4.model.ValueSet theValueSetToExpand)
void	expandValueSet(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, org.hl7.fhir.r4.model.ValueSet theValueSetToExpand, IValueSetConceptAccumulator theValueSetCodeAccumulator)
List<FhirVersionIndependentConcept>	expandValueSetIntoConceptList(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions, String theValueSetCanonicalUrl)
org.hl7.fhir.r4.model.CodeSystem	fetchCanonicalCodeSystemFromCompleteContext(String theSystem)
Optional<TermConcept>	findCode(String theCodeSystem, String theCode)
List<TermConcept>	findCodes(String theCodeSystem, List<String> theCodes)
Set<TermConcept>	findCodesAbove(Long theCodeSystemResourcePid, Long theCodeSystemResourceVersionPid, String theCode)
List<FhirVersionIndependentConcept>	findCodesAbove(String theSystem, String theCode)
List<FhirVersionIndependentConcept>	findCodesAboveUsingBuiltInSystems(String theSystem, String theCode)
Set<TermConcept>	findCodesBelow(Long theCodeSystemResourcePid, Long theCodeSystemResourceVersionPid, String theCode)
List<FhirVersionIndependentConcept>	findCodesBelow(String theSystem, String theCode)
List<FhirVersionIndependentConcept>	findCodesBelowUsingBuiltInSystems(String theSystem, String theCode)
Optional<TermValueSet>	findCurrentTermValueSet(String theUrl)	Version independent
String	invalidatePreCalculatedExpansion(org.hl7.fhir.instance.model.api.IIdType theValueSetId, ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)
boolean	isValueSetPreExpandedForCodeValidation(org.hl7.fhir.instance.model.api.IBaseResource theValueSet)	Version independent
boolean	isValueSetPreExpandedForCodeValidation(org.hl7.fhir.r4.model.ValueSet theValueSet)
void	preExpandDeferredValueSetsToTerminologyTables()
Optional<org.hl7.fhir.instance.model.api.IBaseResource>	readCodeSystemByForcedId(String theForcedId)	Version independent
ReindexTerminologyResult	reindexTerminology()	Version independent Recreates freetext indexes for TermConcept and nested TermConceptProperty
void	storeTermValueSet(ResourceTable theResourceTable, org.hl7.fhir.r4.model.ValueSet theValueSet)
IFhirResourceDaoCodeSystem.SubsumesResult	subsumes(org.hl7.fhir.instance.model.api.IPrimitiveType<String> theCodeA, org.hl7.fhir.instance.model.api.IPrimitiveType<String> theCodeB, org.hl7.fhir.instance.model.api.IPrimitiveType<String> theSystem, org.hl7.fhir.instance.model.api.IBaseCoding theCodingA, org.hl7.fhir.instance.model.api.IBaseCoding theCodingB)
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult	validateCodeIsInPreExpandedValueSet(ca.uhn.fhir.context.support.ConceptValidationOptions theOptions, org.hl7.fhir.instance.model.api.IBaseResource theValueSet, String theSystem, String theCode, String theDisplay, org.hl7.fhir.instance.model.api.IBaseDatatype theCoding, org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)	Version independent

Methods inherited from interface ca.uhn.fhir.context.support.IValidationSupport

expandValueSet, expandValueSet, fetchAllConformanceResources, fetchAllNonBaseStructureDefinitions, fetchAllSearchParameters, fetchAllStructureDefinitions, fetchBinary, fetchCodeSystem, fetchResource, fetchStructureDefinition, fetchValueSet, generateSnapshot, getFhirContext, getName, invalidateCaches, isCodeSystemSupported, isEnabledValidationForCodingsLogicalAnd, isRemoteTerminologyServiceConfigured, isValueSetSupported, lookupCode, lookupCode, lookupCode, translateConcept, validateCode, validateCodeInValueSet

Method Details

expandValueSet

org.hl7.fhir.r4.model.ValueSet expandValueSet(@Nullable
 ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 @Nonnull
 String theValueSetCanonicalUrl)

expandValueSet

org.hl7.fhir.r4.model.ValueSet expandValueSet(@Nullable
 ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 @Nonnull
 org.hl7.fhir.r4.model.ValueSet theValueSetToExpand)

expandValueSet

void expandValueSet(@Nullable
 ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 org.hl7.fhir.r4.model.ValueSet theValueSetToExpand,
 IValueSetConceptAccumulator theValueSetCodeAccumulator)

expandValueSet

org.hl7.fhir.instance.model.api.IBaseResource expandValueSet(@Nullable
 ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 org.hl7.fhir.instance.model.api.IBaseResource theValueSetToExpand)

Version independent

expandValueSet

void expandValueSet(@Nullable
 ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 org.hl7.fhir.instance.model.api.IBaseResource theValueSetToExpand,
 IValueSetConceptAccumulator theValueSetCodeAccumulator)

expandValueSetIntoConceptList

List<FhirVersionIndependentConcept> expandValueSetIntoConceptList(ca.uhn.fhir.context.support.ValueSetExpansionOptions theExpansionOptions,
 String theValueSetCanonicalUrl)

findCode

Optional<TermConcept> findCode(String theCodeSystem,
 String theCode)

findCodes

List<TermConcept> findCodes(String theCodeSystem,
 List<String> theCodes)

findCodesAbove

Set<TermConcept> findCodesAbove(Long theCodeSystemResourcePid,
 Long theCodeSystemResourceVersionPid,
 String theCode)

findCodesAbove

List<FhirVersionIndependentConcept> findCodesAbove(String theSystem,
 String theCode)

findCodesAboveUsingBuiltInSystems

List<FhirVersionIndependentConcept> findCodesAboveUsingBuiltInSystems(String theSystem,
 String theCode)

findCodesBelow

Set<TermConcept> findCodesBelow(Long theCodeSystemResourcePid,
 Long theCodeSystemResourceVersionPid,
 String theCode)

findCodesBelow

List<FhirVersionIndependentConcept> findCodesBelow(String theSystem,
 String theCode)

findCodesBelowUsingBuiltInSystems

List<FhirVersionIndependentConcept> findCodesBelowUsingBuiltInSystems(String theSystem,
 String theCode)

fetchCanonicalCodeSystemFromCompleteContext

org.hl7.fhir.r4.model.CodeSystem fetchCanonicalCodeSystemFromCompleteContext(String theSystem)

deleteValueSetAndChildren

void deleteValueSetAndChildren(ResourceTable theResourceTable)

storeTermValueSet

void storeTermValueSet(ResourceTable theResourceTable,
 org.hl7.fhir.r4.model.ValueSet theValueSet)

subsumes

IFhirResourceDaoCodeSystem.SubsumesResult subsumes(org.hl7.fhir.instance.model.api.IPrimitiveType<String> theCodeA,
 org.hl7.fhir.instance.model.api.IPrimitiveType<String> theCodeB,
 org.hl7.fhir.instance.model.api.IPrimitiveType<String> theSystem,
 org.hl7.fhir.instance.model.api.IBaseCoding theCodingA,
 org.hl7.fhir.instance.model.api.IBaseCoding theCodingB)

preExpandDeferredValueSetsToTerminologyTables

void preExpandDeferredValueSetsToTerminologyTables()

validateCodeIsInPreExpandedValueSet

@Transactional
ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult validateCodeIsInPreExpandedValueSet(ca.uhn.fhir.context.support.ConceptValidationOptions theOptions,
 org.hl7.fhir.instance.model.api.IBaseResource theValueSet,
 String theSystem,
 String theCode,
 String theDisplay,
 org.hl7.fhir.instance.model.api.IBaseDatatype theCoding,
 org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)

Version independent

isValueSetPreExpandedForCodeValidation

boolean isValueSetPreExpandedForCodeValidation(org.hl7.fhir.r4.model.ValueSet theValueSet)

isValueSetPreExpandedForCodeValidation

boolean isValueSetPreExpandedForCodeValidation(org.hl7.fhir.instance.model.api.IBaseResource theValueSet)

Version independent

invalidatePreCalculatedExpansion

String invalidatePreCalculatedExpansion(org.hl7.fhir.instance.model.api.IIdType theValueSetId,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

findCurrentTermValueSet

Optional<TermValueSet> findCurrentTermValueSet(String theUrl)

Version independent

readCodeSystemByForcedId

Optional<org.hl7.fhir.instance.model.api.IBaseResource> readCodeSystemByForcedId(String theForcedId)

Version independent

reindexTerminology

ReindexTerminologyResult reindexTerminology()
                                     throws InterruptedException

Version independent Recreates freetext indexes for TermConcept and nested TermConceptProperty

Throws:

InterruptedException