Package org.ehrbase.api.service

Interface TerminologyServer<T,​ID,​U>

  • Type Parameters:
    T - concept type
    ID - generic id type to specify the data type used for the identifier of the concept in the terminology server of choice.
    ID - generic type for parameters that are custom to each operation implementation.
    public interface TerminologyServer<T,​ID,​U>

    • Method Detail

      • expand

        List<T> expand​(ID valueSetId)
        Expands the value set identified by the provided ID.
        Parameters:
        valueSetId -
        Returns:
        Returns the list of concepts of type T that conform the expansion of the value set.

      • expandWithParameters

        List<T> expandWithParameters​(ID valueSetId,
                             U... operationParams)
        Expands the value set identified by the provided ID.
        Parameters:
        valueSetId -
        Returns:
        Returns the list of concepts of type T that conform the expansion of the value set.

      • lookUp

        T lookUp​(ID conceptId)
        Searches all the attributes associated with the concept that corresponds to the provided ID.
        Parameters:
        conceptId -
        Returns:
        A complex Object of type T that contains all the attributes directly associated to the concept identified by the provided ID.

      • validate

        Boolean validate​(T concept,
                 ID valueSetId)
        Evaluates if the concept provided T belongs to the value set identified by the provided ID.
        Parameters:
        concept - to evaluate.
        valueSetId -
        Returns:
        true if the concept belongs to the specified value set.

      • validate

        Boolean validate​(U... operationParams)
        Evaluates if the concept provided as one operationParams belongs to the value set provided as another operationParam.
        Parameters:
        dynamic - list of parameters to perform the operation against an external terminology server.
        Returns:
        true if the concept belongs to the specified value set.

      • subsumes

        TerminologyServer.SubsumptionResult subsumes​(T conceptA,
                                             T conceptB)
        Evaluates if the concept B subsumes concept A.
        Parameters:
        concept - that is subsumed by the concept in the second param.
        concept - that subsumes the concept in the first param.
        Returns:
        org.ehrbase.aql.compiler.tsclient.TerminologyServer.SubsumptionResult indicating the result of the subsumption evaluation.