Retrieves the full clinical description for one or more CCSR category codes. This function helps users interpret CCSR codes by providing their meaningful clinical descriptions.
Arguments
- ccsr_codes
Character vector of CCSR category codes (e.g., "ADM010", "NEP003", "CIR019").
- map_df
Optional. A tibble containing CCSR mapping data with descriptions. If provided, descriptions are extracted from this data frame. If NULL (default), the function will attempt to download the latest mapping file to extract descriptions.
- type
Character string specifying the type of CCSR codes. Must be one of: "diagnosis" (or "dx") or "procedure" (or "pr"). If NULL (default), the function will attempt to infer the type from the codes or mapping data.
Value
A tibble with columns:
ccsr_code: The CCSR category codedescription: The full clinical descriptionAdditional metadata columns if available in the mapping data
Details
CCSR category codes follow specific naming conventions:
Diagnosis codes: Typically start with letters (e.g., "ADM010", "NEP003")
Procedure codes: Typically start with letters (e.g., "PRC001", "PRC002")
If a description is not found for a code, it will be marked as NA in the result.
Examples
# \donttest{
# Get descriptions using downloaded mapping data
dx_map <- download_ccsr("diagnosis")
#> Using cached file: /tmp/Rtmp6OONtw/HCUPtools_cache/DXCCSR-v2026-1.zip
#> Reading mapping file: DXCCSR_v2026-1.csv
get_ccsr_description(c("ADM010", "NEP003", "CIR019"), map_df = dx_map)
#> Warning: No description found for 3 code(s): ADM010, NEP003, CIR019
#> # A tibble: 3 × 2
#> ccsr_code description
#> <chr> <chr>
#> 1 ADM010 NA
#> 2 NEP003 NA
#> 3 CIR019 NA
# Get descriptions without pre-downloaded data (will download automatically)
get_ccsr_description(c("ADM010", "NEP003"), type = "diagnosis")
#> Downloading CCSR mapping file to extract descriptions...
#> Using cached file: /tmp/Rtmp6OONtw/HCUPtools_cache/DXCCSR-v2026-1.zip
#> Reading mapping file: DXCCSR_v2026-1.csv
#> Warning: No description found for 2 code(s): ADM010, NEP003
#> # A tibble: 2 × 2
#> ccsr_code description
#> <chr> <chr>
#> 1 ADM010 NA
#> 2 NEP003 NA
# }