getDescendants

getDescendants

Usage

getDescendants(
  cdm,
  conceptId,
  withAncestor = FALSE,
  ingredientRange = c(0, Inf),
  doseForm = NULL
)

Arguments

cdm

cdm_reference via CDMConnector

conceptId

concpet_id to search

withAncestor

If TRUE, return column with ancestor. In case of multiple ancestors, concepts will be separated by ";"

ingredientRange

Used to restrict descendant codes to those associated with a specific number of drug ingredients. Must be a vector of length two with the first element the minimum number of ingredients allowed and the second the maximum. A value of c(2, 2) would restrict to only concepts associated with two ingredients.

doseForm

Only descendants codes with the specified drug dose form will be returned. If NULL, descendant codes will be returned regardless of dose form.

Value

The descendants of a given concept id

Examples

# \donttest{
cdm <- mockVocabRef()
#> Warning: There are observation period end dates after the current date: 2025-02-19
#> ℹ The latest max observation period end date found is 2025-12-31
getDescendants(cdm = cdm, conceptId = 1)
#> # A tibble: 5 × 10
#>   concept_id concept_name             domain_id vocabulary_id standard_concept
#>        <int> <chr>                    <chr>     <chr>         <chr>           
#> 1          1 Musculoskeletal disorder Condition SNOMED        S               
#> 2          2 Osteoarthrosis           Condition SNOMED        S               
#> 3          3 Arthritis                Condition SNOMED        S               
#> 4          4 Osteoarthritis of knee   Condition SNOMED        S               
#> 5          5 Osteoarthritis of hip    Condition SNOMED        S               
#> # ℹ 5 more variables: concept_class_id <chr>, concept_code <chr>,
#> #   valid_start_date <date>, valid_end_date <date>, invalid_reason <chr>
# }