Package com.ibm.fhir.term.spi

Interface FHIRTermServiceProvider

    • Method Detail

      • closure

        java.util.Set<CodeSystem.Concept> closure​(CodeSystem codeSystem,
                                          Code code)
        Get a set containing CodeSystem.Concept instances where all structural hierarchies have been flattened.
        Parameters:
        codeSystem - the code system
        code - the root of the hierarchy containing the Concept instances to be flattened
        Returns:
        flattened set of Concept instances for the given tree

      • closure

        default java.util.Map<Code,​java.util.Set<CodeSystem.Concept>> closure​(CodeSystem codeSystem,
                                                                            java.util.Set<Code> codes)
        Get a map of sets containing CodeSystem.Concept instances where all structural hierarchies have been flattened
        Parameters:
        codeSystem - the code system
        codes - the set of roots of hierarchies containing the Concept instances to be flattened
        Returns:
        a map containing flattened sets of Concept instances for the given trees

      • getConcept

        CodeSystem.Concept getConcept​(CodeSystem codeSystem,
                              Code code)
        Get the concept in the provided code system with the specified code. Consumers should not expect the returned Concept to contain child concepts, even where such concepts exist in the underlying CodeSystem.
        Parameters:
        codeSystem - the code system
        code - the code
        Returns:
        the code system concept with the specified code, or null if no such concept exists

      • getConcepts

        java.util.Set<CodeSystem.Concept> getConcepts​(CodeSystem codeSystem)
        Get a set containing CodeSystem.Concept instances where all structural hierarchies have been flattened.
        Parameters:
        codeSystem - the code system containing the set of Concept instances to be flattened
        Returns:
        flattened set of Concept instances for the given code system

      • getConcepts

        default <R> java.util.Set<R> getConcepts​(CodeSystem codeSystem,
                                         java.util.function.Function<CodeSystem.Concept,​? extends R> function)
        Get a set containing FHIRTermServiceProvider instances mapped from concepts where all structural hierarchies have been flattened.
        Type Parameters:
        R - the element type of the result set
        Parameters:
        codeSystem - the code system containing the set of Concept instances to be flattened
        function - the function to apply to each element of the result set
        Returns:
        flattened set of FHIRTermServiceProvider instances mapped from concepts for the given code system

      • getConcepts

        java.util.Set<CodeSystem.Concept> getConcepts​(CodeSystem codeSystem,
                                              java.util.List<ValueSet.Compose.Include.Filter> filters)
        Get a set containing CodeSystem.Concept instances where all structural hierarchies have been flattened and filtered by the given set of value set include filters.
        Parameters:
        codeSystem - the code system containing the set of Concept instances to be flattened / filtered
        filters - the value set include filters
        Returns:
        flattened / filtered set of Concept instances for the given code system

      • getConcepts

        default <R> java.util.Set<R> getConcepts​(CodeSystem codeSystem,
                                         java.util.List<ValueSet.Compose.Include.Filter> filters,
                                         java.util.function.Function<CodeSystem.Concept,​? extends R> function)
        Get a set containing FHIRTermServiceProvider instances mapped from concepts where all structural hierarchies have been flattened and filtered by the given set of value set include filters.
        Type Parameters:
        R - the element type of the result set
        Parameters:
        codeSystem - the code system containing the set of Concept instances to be flattened / filtered
        filters - the value set include filters
        function - the function to apply to each element of the result set
        Returns:
        flattened / filtered set of FHIRTermServiceProvider instances mapped from concepts for the given code system

      • hasConcept

        boolean hasConcept​(CodeSystem codeSystem,
                   Code code)
        Indicates whether the given code system contains a concept with the specified code.
        Parameters:
        codeSystem - the code system
        code - the code
        Returns:
        true if the given code system contains a concept with the specified code, false otherwise

      • hasConcepts

        default boolean hasConcepts​(CodeSystem codeSystem,
                            java.util.Set<Code> codes)
        Indicates whether the given code system contains a concept for each of the specified codes.
        Parameters:
        codeSystem - the code system
        codes - the codes
        Returns:
        true if the given code system contains a concept for each of the specified codes, false otherwise

      • isSupported

        boolean isSupported​(CodeSystem codeSystem)
        Indicates whether the given code system is supported.
        Parameters:
        codeSystem - the code system
        Returns:
        true if the given code system is supported, false otherwise

      • subsumes

        boolean subsumes​(CodeSystem codeSystem,
                 Code codeA,
                 Code codeB)
        Indicates whether the concept for CodeA subsumes the concept for codeB in the passed CodeSystem.
        Parameters:
        codeSystem - the code system
        codeA - the root of the hierarchy to search
        codeB - the code to match
        Returns:
        true if the code system concept for codeB exists in the tree rooted by the concept for CodeA, false otherwise