Cadastro Nacional de Estabelecimentos de Saúde - CNES

Neste notebook, iremos demonstrar como acessar os dados do Cadastro Nacional de Estabelecimentos de Saúde (CNES) indexados pela Plataforma de Ciência de Dados aplicada à Saúde (PCDaS) através do R.

Os dados do CNES estão disponíveis em um índice do ElasticSearch (ES), que contém todos os registros individuais de estabelecimentos de saúde atualizados mensalmente.

Pacotes necessários

Primeiro, definimos uma função auxiliar para carregar os pacotes necessários à execução deste tutorial e instalar algum pacote caso este não esteja disponível.

In [ ]:
loadlibrary <- function(x){
  if (!require(x,character.only = TRUE)) {
    install.packages(x, dep=TRUE)
    if(!require(x,character.only = TRUE)) stop("Package not found")
  }
}

O acesso ao índice no ES é realizado através do pacote elastic.

In [ ]:
loadlibrary("elastic")
Loading required package: elastic

Vamos também utilizar outras bibliotecas do R para facilitar a manipulação dos dados obtidos e um último comando para ajustar os tamanhos dos gráficos gerados.

In [ ]:
packages <- c("dplyr", "curl", "jsonlite", "ggplot2", "getPass")
lapply(packages, loadlibrary)

options(repr.plot.width=15, repr.plot.height=10)
Loading required package: dplyr


Attaching package: ‘dplyr’


The following objects are masked from ‘package:elastic’:

    count, explain


The following objects are masked from ‘package:stats’:

    filter, lag


The following objects are masked from ‘package:base’:

    intersect, setdiff, setequal, union


Loading required package: curl

Using libcurl 7.58.0 with OpenSSL/1.1.1

Loading required package: jsonlite


Attaching package: ‘jsonlite’


The following object is masked from ‘package:elastic’:

    validate


Loading required package: ggplot2

Loading required package: getPass

  1. NULL
  2. NULL
  3. NULL
  4. NULL
  5. NULL

Acesso ao ElasticSearch

O primeiro passo é informar ao R os parâmetros de conexão com o índice no ES.

Nos parâmetros es_user e es_pwd, informe o mesmo usuário e senha que você usar para acessar a plataforma.

In [ ]:
es_host <- "dados-pcdas.icict.fiocruz.br"
es_port <- 443
es_transport_schema <- "https"
es_user <- readline("Digite seu usuário da PCDaS: ")
es_pwd <- getPass("Digite sua senha da PCDaS: ")
Digite seu usuário da PCDaS: loginteste

Em seguida, criamos um objeto (es_cnes) para acesso ao índice do ES contendo os dados do SIH.

In [ ]:
es_cnes <- elastic::connect(host = es_host,
                           port = es_port,
                           transport_schema = es_transport_schema,
                           user = es_user,
                           pwd = es_pwd)

Podemos testar a conexão pedindo algumas informações básicas sobre o Elasticsearch.

In [ ]:
print(es_cnes)
<Elasticsearch Connection> 
  transport:  https 
  host:       dados-pcdas.icict.fiocruz.br 
  port:       443 
  path:       NULL 
  username:   rgritz 
  password:   <secret> 
  errors:     simple 
  headers (names):   
  cainfo:  NULL 
  ignore ES version?:  FALSE 

Fazendo buscas nos dados

Podemos executar buscas nos dados e ver os documentos (registros) do índice (banco do CNES) com os comandos count e Search.

Para fins de deixar as buscas mais intuitivas agora no início desse tutorial serão criadas 2 funções, uma para pesquisas agregadas e outra para buscas generalizadas. Ambas as funções teram como retorno um objeto no formato data.frame.

Como exemplo do comando count pegaremos a contagem total de registros no índice do SIH. Em seguida faremos queries com as funções criadas.

In [ ]:
elastic::count(es_cnes, "datasus-cnes")
47575113
In [ ]:
getColnames <- function(colunas){
    colunas <- lapply(X = colunas, FUN = function(t) gsub(pattern = "_source.", replacement = "", x = t, fixed = TRUE))
    return(colunas)
}
convertSearchToDF <- function(size=100, index, connection, elastic_query){
    search_result <- elastic::Search(conn=connection, index=index, body=elastic_query, asdf=TRUE,size=size)
    df <- search_result$hits$hits
    df[c("_index", "_type", "_id", "_score")] <- NULL
    rownames(df) <- NULL
    colnames(df) <- getColnames(colnames(df))
    return(df)
}       
convertAggsToDF <- function(index, connection, size=100, elastic_query){
    search_result <- elastic::Search(conn=connection, index=index, size=size, body=elastic_query,  asdf = TRUE)$aggregations
    outputList <- list()
    outputList <- c(outputList, search_result)
    records <- lapply(outputList, "[[", "buckets")
    df <- records$a1
    return(df)
}

Logo abaixo criaremos a query tudo para pegarmos todos os registros completos do índice, de acordo com o parâmetro size pré definido na função ele retornará um total de 100 registros podendo ser aumentado até 10.000. Vamos ver mais a frente que dificilmente iremos precisar mais do que isso, pois iremos trabalhar com agregações.

In [ ]:
tudo <- '{
  "query": {
    "match_all": {}
  }
}'
In [ ]:
df <- convertSearchToDF(size=100, index="datasus-cnes", connection=es_cnes, elastic_query = tudo)
head(df)
A data.frame: 6 × 237
ATENDHOSAP06CV03NATUREZAdef_turno_atCENTRNEOmun_CAPITALQTLEIT20def_atividadmun_AMAZONIAGESPRG6MQTINST13DT_PNASSQTINST15QTINST16QTINST17QTINST18QTINST19SERAP07Puf_SIGLA_UFSERAP07T
<int><int><int><chr><int><chr><int><chr><chr><int><int><lgl><int><int><int><int><int><int><chr><int>
110 7ATENDIMENTO CONTINUO DE 24 HORAS/DIA (PLANTAO: INCLUI SABADOS DOMINGOS E FERIADOS)1N0Unidade SEM atividade de EnsinoS01NA002000RO0
200 1ATENDIMENTOS NOS TURNOS DA MANHA E A TARDE 0N0Unidade SEM atividade de EnsinoS00NA000100RO0
300 7ATENDIMENTOS NOS TURNOS DA MANHA E A TARDE 0N0Unidade SEM atividade de EnsinoS00NA020000RO0
400 1ATENDIMENTOS NOS TURNOS DA MANHA E A TARDE 0N0Unidade SEM atividade de EnsinoS00NA000000RO0
510 7ATENDIMENTO CONTINUO DE 24 HORAS/DIA (PLANTAO: INCLUI SABADOS DOMINGOS E FERIADOS)1N0Unidade SEM atividade de EnsinoS01NA000000RO0
60011ATENDIMENTOS NOS TURNOS DA MANHA E A TARDE 0N0Unidade SEM atividade de EnsinoS00NA220900RO0

Agregando resultados

Se quisermos gerar tabelas mais complexas de contagens, podemos usar uma forma específica para pedir agregações de resultados.

Por exemplo, qual a quantidade de internações por estado? Podemos obter este resultado especificando uma agregação.

Uma agregação para o ES precisa ser escrita seguindo um padrão. Veja abaixo:

In [ ]:
agg_competen <- '{
  "aggs": {
    "a1": {
      "terms": {
        "field": "def_competen",
        "size": 200
      }
    }
  }
}'

Estamos criando um objeto chamado agg_competen no R, que será usado na consulta ao ES. O que significa cada linha desse objeto?

  • aggs: esse comando declara ao ES que você está requerindo uma agregação;
  • a1: nome da agregação, você pode modificar esse nome;
  • terms: isso declara ao ES que você quer fazer a agregação a partir de uma variável categórica, resultando na contagem de documentos. Não modifique essa linha;
  • field: esse será o campo que você deseja fazer a agregação, no nosso caso, por sigla de UF. Você pode modificar esta linha para outra variável categórica;
  • size: esse é o limite de resultados da agregação. O limite deste parâmetro é 10.000.

Para buscarmos essa agregação no ES faremos uso da função criada anteriormente para trazê-la em formado de data.frame:

In [ ]:
df_agg_competen <- convertAggsToDF(size = 200, index="datasus-cnes", connection=es_cnes, elastic_query=agg_competen)
head(df_agg_competen)
A data.frame: 6 × 2
keydoc_count
<chr><int>
12021/05348768
22021/04345513
32019/12345017
42019/10344093
52019/09342240
62021/03342050

Perceba que estamos realizando contagens em mais de 30 milhões registros. Fazer este tipo de contagem em um computador comum poderia durar horas ou dias. Utilizando a nossa infraestrutura, isso é feito em menos de 1 segundo.

O comando abaixo retorna um gráfico de barras gerado com base nos dados em df.

In [ ]:
#Basic barplot
ggplot(data = df_agg_competen, aes(x = reorder(key, doc_count), y = doc_count)) +
  geom_bar(stat = "identity") +
  labs(x = "Competência", y = "Estabelecimentos") +
  theme(axis.text.x = element_text(angle = 90)) +
  scale_x_discrete(breaks=c("2005/08","2019/01"))

Agregando com filtros

Na busca acima, temos o total de óbitos por estado para todos os anos e todas as doenças, sem filtros. Podemos tornar essa busca mais precisa incluindo um filtro.

filter_competen <- '{
    "query": {
        "bool": {
          "must": [
            {
              "range": {
                    "ano_competen": { "from" : 2010, "to" : 2012 }
              }
            }
          ]
        }
    }'

Com o código acima, estamos criando um objeto chamado filter_competen no R, que será usado na consulta ao ES. O que significa cada linha desse objeto?

  • query: como visto anteriormente, esse comando declara ao ES que você está requerindo uma busca;
  • bool: essa cláusula permite a construção de filtros que tenham múltiplos campos. Não modifique essa linha;
  • range: declara que o campo que trabalharemos será um range, nesse caso de anos delimitado inferiormente pela cláusula "from" e superiormente por "to";
  • ano_competen: Campo a ser filtrado.

Com o filtro definido podemos criar a combinação do filtro de anos e uma agregação por codigo da UF da seguinte forma:

In [ ]:
agg_uf_competen <- '{
    "query": {
        "bool": {
          "must": [
            {
              "range": {
                    "ano_competen": { "from" : 2010, "to" : 2012 }
              }
            }
          ]
        }
    },
    "aggs": {
        "a1": {
            "terms": {
                "field": "uf_CODIGO_UF",
                "size": 27
            }
        }
    }
}'
In [ ]:
df_agg_uf_competen <- convertAggsToDF(size=50, connection=es_cnes, index='datasus-cnes', elastic_query = agg_uf_competen)
head(df_agg_uf_competen)
A data.frame: 6 × 2
keydoc_count
<int><int>
1351990531
2311053326
341 677389
443 641358
533 521861
629 469355

Podemos agora fazer uma outra busca, dessa vez agregando por municípios e filtrando pelo campo uf_CODIGO_UF= "SP" AND VINC_SUS = 1. Vejamos o resultado.

In [ ]:
agg_mun_filtro_uf_sus <- '{
    "query": {
        "bool": {
          "must": [
            {
              "query_string": {
                "query": "uf_SIGLA_UF:SP AND VINC_SUS:1"
              }
            }
          ]
        }
    },
    "aggs": {
        "a1": {
            "terms": {
                "field": "CODUFMUN",
                "size": 6000
            }
        }
    }
}'
In [ ]:
df_agg_mun_uf_sus <- convertAggsToDF(size=50, connection=es_cnes, index='datasus-cnes', elastic_query=agg_mun_filtro_uf_sus)
head(df_agg_mun_uf_sus)
A data.frame: 6 × 2
keydoc_count
<chr><int>
1355030214970
2350950 30340
3354340 25235
4351880 25049
5354990 22868
6353870 22128

Fim do tutorial