getATCCodes {CodelistGenerator}

Get descendant codes for ATC levels

Description

Get descendant codes for ATC levels

Usage

getATCCodes(
  cdm,
  level = c("ATC 1st"),
  name = NULL,
  doseForm = NULL,
  doseUnit = NULL,
  routeCategory = NULL,
  type = "codelist"
)

Arguments

cdm

cdm_reference via CDMConnector

level

ATC level. Can be one or more of "ATC 1st", "ATC 2nd", "ATC 3rd", "ATC 4th", and "ATC 5th"

name

ATC name of interest. For example, c("Dermatologicals", "Nervous System"), would result in a list of length two with the descendant concepts for these two particular ATC groups.

doseForm

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

doseUnit

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

routeCategory

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

type

Can be "codelist", "codelist_with_details", or "concept_set_expression"

Value

Concepts with their format based on the type argument.

Examples

## Not run: 
cdm <- mockVocabRef()
getATCCodes(cdm = cdm, level = "ATC 1st")
CDMConnector::cdmDisconnect(cdm)

## End(Not run)