Skip to contents

Get CCSR Category Descriptions

Source: R/get_ccsr_description.R
get_ccsr_description.Rd

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.

Usage

get_ccsr_description(ccsr_codes, map_df = NULL, type = NULL)

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 code

  • description: The full clinical description

  • Additional 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")
#> Warning: Could not determine latest version from HCUP website. Using fallback version: v2026.1. This may not be the actual latest version.
#> Downloading from: https://hcup-us.ahrq.gov/toolssoftware/ccsr/DXCCSR-v2026-1.zip
#> Error in value[[3L]](cond): Failed to download file: Failed to perform HTTP request.
#> Caused by error in `curl::curl_fetch_memory()`:
#> ! Timeout was reached [hcup-us.ahrq.gov]:
#> Connection timed out after 60002 milliseconds
get_ccsr_description(c("ADM010", "NEP003", "CIR019"), map_df = dx_map)
#> Error: object 'dx_map' not found

# Get descriptions without pre-downloaded data (will download automatically)
get_ccsr_description(c("ADM010", "NEP003"), type = "diagnosis")
#> Downloading CCSR mapping file to extract descriptions...
#> Warning: Could not determine latest version from HCUP website. Using fallback version: v2026.1. This may not be the actual latest version.
#> Downloading from: https://hcup-us.ahrq.gov/toolssoftware/ccsr/DXCCSR-v2026-1.zip
#> Error in value[[3L]](cond): Failed to download file: Failed to perform HTTP request.
#> Caused by error in `curl::curl_fetch_memory()`:
#> ! Timeout was reached [hcup-us.ahrq.gov]:
#> Connection timed out after 60001 milliseconds
# }