Interface ITermReadSvc

  • All Superinterfaces:
    ca.uhn.fhir.context.support.IValidationSupport
    All Known Subinterfaces:
    ITermReadSvcDstu3, ITermReadSvcR4, ITermReadSvcR5
    All Known Implementing Classes:
    BaseTermReadSvcImpl, TermReadSvcDstu2, TermReadSvcDstu3, TermReadSvcR4, TermReadSvcR5

    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

        URL_PREFIX_VALUE_SET
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ca.uhn.fhir.context.support.IValidationSupport.CodeValidationResult codeSystemValidateCode​(org.hl7.fhir.instance.model.api.IIdType theCodeSystemId, String theValueSetUrl, String theVersion, String theCode, String theDisplay, org.hl7.fhir.instance.model.api.IBaseDatatype theCoding, org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)
      Version independent
      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<ca.uhn.fhir.util.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)  
      Set<TermConcept> findCodesAbove​(Long theCodeSystemResourcePid, Long theCodeSystemResourceVersionPid, String theCode)  
      List<ca.uhn.fhir.util.FhirVersionIndependentConcept> findCodesAbove​(String theSystem, String theCode)  
      List<ca.uhn.fhir.util.FhirVersionIndependentConcept> findCodesAboveUsingBuiltInSystems​(String theSystem, String theCode)  
      Set<TermConcept> findCodesBelow​(Long theCodeSystemResourcePid, Long theCodeSystemResourceVersionPid, String theCode)  
      List<ca.uhn.fhir.util.FhirVersionIndependentConcept> findCodesBelow​(String theSystem, String theCode)  
      List<ca.uhn.fhir.util.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
      void storeTermValueSet​(ResourceTable theResourceTable, org.hl7.fhir.r4.model.ValueSet theValueSet)  
      ca.uhn.fhir.jpa.api.dao.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 validateCode​(ca.uhn.fhir.context.support.ConceptValidationOptions theOptions, org.hl7.fhir.instance.model.api.IIdType theValueSetId, String theValueSetUrl, String theSystem, String theCode, String theDisplay, org.hl7.fhir.instance.model.api.IBaseDatatype theCoding, org.hl7.fhir.instance.model.api.IBaseDatatype theCodeableConcept)
      Version independent
      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, fetchAllConformanceResources, fetchAllNonBaseStructureDefinitions, fetchAllStructureDefinitions, fetchCodeSystem, fetchResource, fetchStructureDefinition, fetchValueSet, generateSnapshot, getFhirContext, invalidateCaches, isCodeSystemSupported, isValueSetSupported, lookupCode, lookupCode, translateConcept, validateCode, validateCodeInValueSet