List SI-PNI Variables

Returns a tibble with available variables in the SI-PNI data, including descriptions and value types.

Usage

sipni_variables(type = "DPNI", search = NULL)

Arguments

type

Character. File type to show variables for. "DPNI" (default) for doses applied (FTP, 1994-2019), "CPNI" for coverage (FTP, 1994-2019), or "API" for individual-level microdata (OpenDataSUS, 2020+).

search

Character. Optional search term to filter variables by name or description. Case-insensitive and accent-insensitive.

Value

A tibble with columns: variable, description, type, section.

See also

Other sipni: sipni_cache_status(), sipni_clear_cache(), sipni_data(), sipni_dictionary(), sipni_info(), sipni_years()

Examples

sipni_variables()
#> # A tibble: 12 × 4
#>    variable  description                       type      section    
#>    <chr>     <chr>                             <chr>     <chr>      
#>  1 ANO       Ano de referência                 character temporal   
#>  2 ANOMES    Ano e mês (AAAAMM)                character temporal   
#>  3 MES       Mês (01-12)                       character temporal   
#>  4 UF        Código UF (IBGE 2 dígitos)        character localizacao
#>  5 MUNIC     Código município (IBGE 6 dígitos) character localizacao
#>  6 FX_ETARIA Faixa etária (codificada)         character paciente   
#>  7 IMUNO     Código do imunobiológico          character vacinacao  
#>  8 DOSE      Tipo de dose                      character vacinacao  
#>  9 QT_DOSE   Quantidade de doses aplicadas     integer   vacinacao  
#> 10 DOSE1     (Reservado)                       character vacinacao  
#> 11 DOSEN     (Reservado)                       character vacinacao  
#> 12 DIFER     (Reservado)                       character vacinacao  
sipni_variables(type = "CPNI")
#> # A tibble: 7 × 4
#>   variable description                       type      section    
#>   <chr>    <chr>                             <chr>     <chr>      
#> 1 ANO      Ano de referência                 character temporal   
#> 2 UF       Código UF (IBGE 2 dígitos)        character localizacao
#> 3 MUNIC    Código município (IBGE 6 dígitos) character localizacao
#> 4 IMUNO    Código do imunobiológico          character vacinacao  
#> 5 QT_DOSE  Quantidade de doses aplicadas     integer   vacinacao  
#> 6 POP      População alvo                    integer   vacinacao  
#> 7 COBERT   Cobertura vacinal (%)             double    vacinacao  
sipni_variables(type = "API")
#> # A tibble: 47 × 4
#>    variable                          description                   type  section
#>    <chr>                             <chr>                         <chr> <chr>  
#>  1 sigla_uf_estabelecimento          Sigla UF do estabelecimento   char… estabe…
#>  2 nome_uf_estabelecimento           Nome UF do estabelecimento    char… estabe…
#>  3 codigo_municipio_estabelecimento  Código município do estabele… char… estabe…
#>  4 nome_municipio_estabelecimento    Nome município do estabeleci… char… estabe…
#>  5 codigo_cnes_estabelecimento       Código CNES do estabelecimen… char… estabe…
#>  6 nome_razao_social_estabelecimento Razão social do estabelecime… char… estabe…
#>  7 nome_fantasia_estalecimento       Nome fantasia do estabelecim… char… estabe…
#>  8 codigo_tipo_estabelecimento       Código tipo do estabelecimen… char… estabe…
#>  9 descricao_tipo_estabelecimento    Descrição tipo do estabeleci… char… estabe…
#> 10 codigo_natureza_estabelecimento   Código natureza jurídica do … char… estabe…
#> # ℹ 37 more rows
sipni_variables(search = "dose")
#> # A tibble: 4 × 4
#>   variable description                   type      section  
#>   <chr>    <chr>                         <chr>     <chr>    
#> 1 DOSE     Tipo de dose                  character vacinacao
#> 2 QT_DOSE  Quantidade de doses aplicadas integer   vacinacao
#> 3 DOSE1    (Reservado)                   character vacinacao
#> 4 DOSEN    (Reservado)                   character vacinacao