au.csiro.pathling.terminology.TerminologyService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of terminology Show documentation
Interact with a FHIR terminology server from Spark.
There is a newer version: 7.0.1
/*
 * Copyright 2022 Commonwealth Scientific and Industrial Research
 * Organisation (CSIRO) ABN 41 687 119 230.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package au.csiro.pathling.terminology;

import au.csiro.pathling.fhirpath.encoding.SimpleCoding;
import java.util.Collection;
import java.util.Set;
import javax.annotation.Nonnull;
import org.hl7.fhir.r4.model.Enumerations.ConceptMapEquivalence;

/**
 * Abstraction layer for the terminology related operations.
 *
 * @author Piotr Szul
 */
public interface TerminologyService {

  /**
   * Creates a translator for given set of codings according to the specified concept map. See also:
   * https://www.hl7.org/fhir/operation-conceptmap-translate.html.
   * 
   * Should be able to ignore codings including are undefined (i.e. the system or code is null).
   *
   * @param codings the collections of codings to find translations for.
   * @param conceptMapUrl the url of the concept map to use for translation.
   * @param reverse reverse true if true.
   * @param equivalences the equivalences to consider for translation.
   * @return the translator instance with requested translation.
   */
  @Nonnull
  ConceptTranslator translate(@Nonnull final Collection codings,
      @Nonnull final String conceptMapUrl,
      boolean reverse, @Nonnull final Collection equivalences);

  /**
   * Creates a transitive closure representation of subsumes relation for the given set of codings.
   * 

   * Should be able to ignore codings including are undefined (i.e. the system or code is null) or
   * where the system is unknown to the underlying terminology service.
   * 

   * Additional resources on closure table maintenance:
   * Maintaining
   * a Closure Table
   *
   * @param systemAndCodes the codings to construct the closure for.
   * @return the closure representation.
   */
  @Nonnull
  Relation getSubsumesRelation(@Nonnull final Collection systemAndCodes);


  /**
   * Intersects the given set of codings with the {@code ValueSet} defined by provided uri.
   * 
   * Should be able to ignore codings including are undefined (i.e. the system or code is null) or
   * where the system is unknown to the underlying terminology service.
   *
   * @param valueSetUri the URI of the {@code ValueSet}
   * @param systemAndCodes the collections of codings to intersect
   * @return the set of input codings that belong to the {@code ValueSet}
   */
  @Nonnull
  Set intersect(@Nonnull final String valueSetUri,
      @Nonnull final Collection systemAndCodes);

}