concept_find: Find SNOMED CT concepts

View source: R/wrapper.R

concept_findR Documentation

Find SNOMED CT concepts

Description

A wrapper function for api_concepts searching for a term or a list of concepts

Usage

concept_find(
  term = NULL,
  conceptIds = NULL,
  ecl = NULL,
  activeFilter = TRUE,
  encoding = "UTF-8",
  silent = FALSE,
  limit = snomedizer_options_get("limit"),
  ...
)

Arguments

term

a string containing search terms

conceptIds

a character vector of one or more SNOMED CT codes to search

ecl

a character expression constraint query (with full inference). Consult the Expression Constraint Language guide for more detail.

activeFilter

whether to restrict results to active concepts. Default is 'TRUE'. Consult the SNOMED glossary for more detail.

encoding

HTTP charset parameter to use (default is "UTF-8")

silent

whether to hide progress bar. Default is FALSE

limit

a positive integer for the maximum number of results to return. See snomedizer_options. The maximum limit on public endpoints is 10,000.

...

other optional arguments listed in api_operations, such as endpoint, branch or limit

Value

a data frame

Disclaimer

In order to use SNOMED CT, a licence is required which depends both on the country you are based in, and the purpose of your work. See details on snomedizer.

See Also

Other wrapper: concept_ancestors(), concept_descriptions(), release_version()

Examples

# Free text search
str(concept_find("asthma"))

# Retrieve multiple concepts
concept_find(conceptIds =  c("233604007", "68566005"))

# Use the SNOMED CT Expression Constraint Language
concept_find(
  ecl = paste(
    "<! 68566005 | Urinary tract infectious disease (disorder) |",
    "AND",
    "< 87628006 | Bacterial infectious disease (disorder) |"
    )
  )

ramses-antibiotics/snomedizer documentation built on July 12, 2022, 12:42 a.m.