sih-br-mcp
sih-br-mcp is an MCP server for aggregate Brazilian SUS hospital admissions (SIH/DATASUS, 1992–2025) that answers questions inside AI assistants with auditable provenance.
Query hospitalizations by UF, year/month, CID chapter/group, sex, age, race, and CSAP status, grouped flexibly; returns hospitalizations, days, value paid, and deaths.
Get monthly or annual hospitalization time series and regional/UF rankings.
Analyze ICSAP/ambulatory care sensitive conditions: list the 19 Portaria 221/2008 groups, classify CID-10 codes, get counts/percentages, indicators, rankings, and comparative trends.
Calculate crude/specific hospitalization rates per 1k/10k/100k population by UF and year, using IBGE population denominators.
Reference tools: 22 ICD-10 chapters, available years with cube freshness, CID-9 era flags, race availability, currency, and population coverage.
Every response includes provenance, source URL, vintage, retrieval details, citation, license, and attribution; data comes from DATASUS via healthbr-data cubes/cache, not from individual records or SQL/FTP.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@sih-br-mcpCompare ICSAP hospitalization rates between São Paulo and Rio de Janeiro in 2023."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
DATASUS SIH/SUS — MCP Server de internações hospitalares (AIH) do Brasil, 1992–2025
Servidor MCP (Model Context Protocol) que responde perguntas sobre as internações
hospitalares do SUS — o SIH/SUS do DATASUS, AIH reduzida — dentro do assistente de
IA, sem TabNet, sem baixar .dbc do FTP e sem escrever SQL. Doze ferramentas sobre
34 anos (1992 a 2025, 420.103.883 internações): causas por capítulo e grupo da
CID-10 (CID-9 antes de 1998), séries mensais, ICSAP — internações por condições
sensíveis à atenção primária, lista brasileira — e taxas brutas, específicas ou
padronizadas por idade, por UF e por município. Cada estrato traz internações, dias de
permanência, valor pago pelo SUS e óbitos, com a proveniência da safra e a citação
da fonte em cada resposta.
In English. MCP server for Brazilian hospital admissions (DATASUS SIH/SUS, "AIH" records), 1992–2025: causes by ICD-10 chapter and group (ICD-9 before 1998), monthly series, ambulatory care sensitive conditions (ICSAP/ACSC, Brazilian list) and crude, age-specific or age-standardized rates by state and municipality — answered inside Claude, ChatGPT or any MCP client, with provenance and a citation in every answer. No FTP download, no DBC decoding, no SQL:
npx -y sih-br-mcp.
Perguntas que ele responde
Em linguagem comum, no cliente MCP: quem escolhe a ferramenta e os parâmetros é o assistente.
"Quantas internações por pneumonia houve no Espírito Santo em 2024, por faixa de idade?" (
get_hospitalizations)"A taxa de ICSAP de Roraima caiu entre 2010 e 2023?" (
get_icsap_indicators)"Compare a internação por 100 mil habitantes entre Norte e Sudeste em 2023, padronizada por idade." (
get_hospitalization_rates,compare_regions)"Quais condições sensíveis à atenção primária mais internam no meu município?" (
rank_csap_groups)"Série mensal de internações por dengue desde 1998." (
get_hospitalization_trends)"J18.9 é condição sensível à atenção primária?" (
classify_as_csap)
Related MCP server: mcp-cnes
Comparação com as alternativas
Quem trabalha com SIH/SUS em R ou Python já tem ferramentas consolidadas, e este
servidor não substitui nenhuma delas — ele ocupa um lugar diferente da cadeia:
responde a pergunta agregada no ponto onde ela é feita, dentro do assistente, sem
ETL e sem download de microdado. Detalhe, exemplos lado a lado e os números medidos
em docs/comparativo-alternativas.md.
Ferramenta | O que faz | Quando preferir |
sih-br-mcp (este) | Responde agregados de 34 anos direto no assistente de IA, com ICSAP, taxas padronizadas e proveniência por resposta | A pergunta é agregada (UF, município, ano, mês, CID, idade, sexo, raça, ICSAP) e a resposta tem de ser auditável |
microdatasus 3.0.0 (R, CRAN) | Baixa e processa microdados do DATASUS (SIH, SIM, SINASC, SIA, CNES, SINAN): trata o DBC e rotula as variáveis | Você precisa do registro individual da AIH, de variáveis fora dos cubos ou de outro sistema do DATASUS |
PySUS 2.11.2 (Python) | Ferramentas para os dados públicos de saúde brasileiros; lê DBC/DBF do FTP do DATASUS | Seu pipeline é Python e você quer ETL próprio sobre o microdado |
read.dbc 1.2.0 (R, CRAN) | Lê e descomprime o formato | Você já tem os arquivos e só precisa abri-los |
csapAIH (R, GitHub) | Classifica AIH em ICSAP pela lista brasileira (é a referência que este servidor confere) | A classificação é sobre o seu microdado, em R |
brpop 0.7.0 (R, CRAN) | Estimativas populacionais brasileiras por município, UF, sexo e faixa | Você calcula as próprias taxas e quer o denominador em R |
healthbR 0.4.0 (R, CRAN) | Irmão em R deste servidor: acessa dados públicos de saúde do Brasil pelo mesmo espelho Parquet | Você está em R e quer o dado numa |
Não use este servidor quando a pergunta exigir o registro individual da AIH,
variáveis que os cubos não carregam (procedimento realizado, CNES do estabelecimento,
caráter de atendimento, diagnóstico secundário) ou outro sistema do DATASUS (SIM,
SINASC, SIA, SINAN) — nesses casos o caminho é microdatasus, PySUS ou o espelho
Parquet do healthbr-data. O que os
cubos carregam por estrato está em
docs/tool-specifications.md: internações, dias de
permanência, valor pago (R$) e óbitos, por ano, mês, UF, município, capítulo e grupo
CID, sexo, idade, raça/cor e grupo ICSAP.
De onde vêm os dados
Este servidor é consumidor do canal público sih/cubos/ do projeto
healthbr-data:
Ministério da Saúde / DATASUS (RD<UF><AAMM>.dbc, FTP)
→ healthbr-data sih/rd/ (Parquet 1:1, manifesto com MD5 e data de download)
→ healthbr-data pipeline sih-cubos (scripts/pipeline/sih-cubos/build-aggregations.R)
→ https://data.sidneybissoli.com/sih/cubos/ (cubos + sidecar por ano + manifest.json + tables/)
→ este servidor (cache local sob demanda, SHA-256 conferido contra o manifesto)Até 08/09/2026 o builder dos cubos vivia aqui (scripts/build-aggregations.R,
rebuild-cubes.yml); desde então o produtor é o healthbr-data e este repositório
não gera nem publica cubo nenhum (CONTEXT.md, decisão 27). A receita completa está
em healthbr-data/scripts/pipeline/sih-cubos/README.md e no card
sih-cubos.
Cubos: baixados por ano, só os que a chamada pede, para
~/.cache/sih-br-mcp/cubos/(SIH_CACHE_DIR), com o sidecarsih_provenance_<ano>.jsonao lado.SIH_CUBES_BASE_URLaponta outro canal;SIH_CUBES_CACHE=offdesliga (smoke e golden usam).Rede: toda ida ao canal passa por
src/upstream.ts(fetch comum do portfólio,@sbissoli/mcp-upstream, desde a 1.1.0): User-Agent, 15 s por tentativa até os cabeçalhos, 2 retries em 429/5xx/rede com backoff, corpo em stream sob o prazo do arquivo; a política foi medida contra o canal (55 MB em 1,2 s) e está documentada no cabeçalho do módulo. O bloco de proveniência de cada resposta segue o contrato v1.3 (desde a 1.7.1): trazretrieval(quantas idas, tentativas e anomalias a chamada custou ao canal —nullquando a resposta veio do disco),revision(provisionalquando algum ano consultado ainda tem competências abertas,currentnos demais),derived+derivation_notenos blocos dos cubos enoticesquando há aviso (cubo atrás do espelho, frescor não verificado).Frescor:
src/freshness.tscompara o sidecar comsih/rd/manifest-summary.jsone avisa quando um cubo está atrás do espelho; quem reconstrói é o produtor (rebuild-sih-cubes.yml, toda terça e após cada manutenção do espelho).Pré-agregados (blocos
icsap_summary, desde a 0.14.0, ecausas_summary, desde a 0.15.0): atalhos DERIVADOS dos cubos publicados, no mesmo canal. O da ICSAP é um resumo de 276 KB mais os estratos por ano; o de causas é o grão A (sih_causas_resumo.parquet, 569 KB com os 34 anos:year × uf × cid_chapter × cid_revision × is_csap × exclusioncom internações, dias, valor e óbitos) mais o grão B por ano, que acrescenta sexo, faixa etária quinquenal e raça. Uma chamada que cabe no grão responde sem baixar cubo nenhum — "internações e gasto por ano desde 1992" custa 569 KB em vez de 1,25 GB. O roteamento é conservador: o que não cabe (mês, categoria CID de 3 dígitos, grupo CSAP, idade fora das faixas quinquenais) cai no cubo e sai exato. Cada ano só usa o pré-agregado se oderived_fromdo manifesto ainda bater com o SHA-256 do cubo publicado; rebuild sem nova derivação devolve aquele ano ao caminho lento, nunca ao número errado.Tabelas de classificação (
src/data/): cópias do contrato publicado emsih/cubos/tables/;npm run tables:checkconfere o SHA-256 contra o manifesto (roda no CI). Nunca edite aqui — a fonte é o produtor.População (
pop_uf.parquet,pop_uf_agregado.parquet,pop_municipios.parquet): desde a 0.12.0 vem do mesmo canal, assinada no blocopopulationdomanifest.json(produtor:build-population.R+build-sih-population.ymldo healthbr-data — IBGE, Projeção 2024 por UF; DATASUS POPBR/POPSVS por município). As ferramentas de taxa (get_hospitalization_rates,compare_icsap_trendscomrate_per_10k) eget_available_yearsbaixam os três arquivos para o cache na primeira chamada, com SHA-256 conferido; uma pasta de dados que já tenhapop_uf.parquettem precedência (fixture, build local). A proveniência da população responde com obuilt_atdo manifesto.
Uso
Pacote no npm: sih-br-mcp (Node 22+).
Ele não embarca dado nenhum — cubos, tabelas e população vêm do canal na primeira
chamada e ficam no cache local.
npx -y sih-br-mcp # stdioConfiguração num cliente MCP (Claude Desktop, Claude Code):
{ "mcpServers": { "sih": { "command": "npx", "args": ["-y", "sih-br-mcp"] } } }A partir do código-fonte:
npm install
npm run build
node dist/index.js # stdioVariáveis: SIH_DATA_DIR (pasta com cubos já prontos, em vez do cache),
SIH_CACHE_DIR, SIH_CUBES_BASE_URL, SIH_CUBES_CACHE=off,
SIH_FRESHNESS_CHECK=off.
Servidor remoto (Streamable HTTP)
As mesmas 12 ferramentas por HTTP, para conectores remotos (claude.ai):
npm run start:http # http://localhost:8080/mcp (GET /healthz para sondar)PORT e SIH_HTTP_HOST além das variáveis acima. Sem sessão: cada request
cria servidor e transporte novos, então qualquer instância atende qualquer
chamada. Em produção roda num Cloudflare Container (Dockerfile, população
pré-baixada na imagem) atrás do Worker de borda em worker/, que cuida de
domínio, rate limit, autenticação opcional e medição — desenho e custos em
docs/plan-004-servidor-remoto.md.
Verificação
npm ci && npm run build
npm test # vitest: decisão de rota (puro) + envelope e outputSchema das 12 (caso cheio e caso magro)
npm run smoke:stdio # superfície das ferramentas × baselines/surface-stdio.json
npm run smoke:http # mesma superfície e chamadas pelo transporte HTTP (dist/http.js)
npm run golden:tools # 12 ferramentas byte a byte × baselines/golden-tools.json (fixture 2023/RR)
npm run freshness:selftest # frescor offline sobre um trecho versionado do manifesto
npm run cache:selftest # cache local (download + SHA-256) contra um canal falso
npm run tables:check # tabelas de src/data × manifesto do canal
npm run equiv:summary # pré-agregados da ICSAP × caminho clássico, byte a byte
npm run equiv:series # roteamento para o cubo leve de séries
npm run equiv:causas # pré-agregados de causas (grão A e B) × cubo, byte a byteO CI (.github/workflows/ci.yml) roda tudo isso em Node 22 e 24. A fixture
tests/fixtures/sih/ é uma cópia real dos cubos de 2023/RR gerados pelo builder
(hoje no healthbr-data) — é o que torna medível qualquer bump.
A divisão de trabalho entre as duas famílias: os scripts em scripts/*.mjs
pinam VALORES (mudou um número, o baseline acusa); a suíte de tests/*.test.ts
afirma INVARIANTES (qual cubo responde a pergunta; toda resposta sai com
proveniência, com o texto igual à estrutura e obedecendo ao outputSchema que
o tools/list publica — validado com o mesmo validador do SDK), e por isso
republicar um cubo não a move. Cada ferramenta tem ali um caso CHEIO e um caso
MAGRO — a resposta com os campos opcionais ausentes, que o golden, sempre com
fixture cheia, não alcança — e o caminho de erro-mole ("ano sem dado") também
é validado. Os esquemas de saída estão em src/output-schemas.ts, escritos à
mão a partir das formas medidas, como os de entrada.
Impressão digital da superfície, conferível pelo registro
Cada release publica, na sua entrada do MCP Registry,
o sha256 da superfície que esta versão serve (initialize, ferramentas, resources, prompts) e
quais métodos respondem sem credencial. Mudar a superfície sem subir a versão reprova o build
(surface.lock.json); a impressão digital no registro deixa o cliente conferir o mesmo do lado
dele. Forma canônica e procedimento: SPEC.md do @sbissoli/mcp-surface
(em inglês). Para conferir por conta própria (Node 18+, sem dependência):
curl -sO https://raw.githubusercontent.com/SidneyBissoli/mcp-br-commons/main/packages/mcp-surface/exemplos/verify.mjs
node verify.mjs io.github.SidneyBissoli/sih-br-mcpQuem mantém: npm run surface:lock grava o bloco no server.json (mcp-surface registro),
o teste da trava reprova server.json defasado, e o publish.yml termina com
mcp-surface conferir-registro — a entrada desta versão no registro contra o endpoint no ar,
como um cliente, sem ler a trava. Ideia de dois leitores do artigo do replay no dev.to
(Mike Dabydeen e Valentina Koniukhova).
Documentação
CONTEXT.md— decisões arquiteturais numeradas (a 27 é a migração do produtor; a 29, o servidor remoto).docs/analise-001(janela de competências),analise-002(era CID-9, 1992–1997),analise-003(lista ICSAP em CID-9 derivada),plan-002(DuckDB Node Neo),plan-003(rebuild automático, hoje no healthbr-data),plan-004(servidor remoto HTTPS para o claude.ai),plan-005(série pré-agregada da ICSAP),plan-006(cubo de causas pré-agregado),tool-specifications.md.
Licença
MIT (LICENSE). Os dados são do Ministério da Saúde / DATASUS; a redistribuição em
Parquet e os cubos derivados são do healthbr-data (CC-BY-4.0).
Available Tools
12 toolsclassify_as_csapClassificar CID-10 como CSAPARead-onlyIdempotentInspect
Classifica um ou mais códigos CID-10 como CSAP ou não. Retorna o grupo CSAP correspondente se aplicável. Aceita as duas notações do mesmo código — J18.1 (OMS) e J181 (SIH) — com a mesma resposta. Código que NÃO é CID-10 não é classificado: volta com is_csap: null e error próprio, nunca false (que afirmaria que a condição existe e não é sensível). Só CID-10: os códigos CID-9 de 6 dígitos do SIH de 1992–1997 são classificados no build pela lista derivada (src/data/csap-groups-cid9.json), não por esta ferramenta.
| Name | Required | Description | Default |
|---|---|---|---|
| cid_codes | Yes | Códigos CID-10 para classificar (ex: ['J18', 'A09', 'K35']) |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | No | Só quando houver código não classificado: quantos foram e para onde olhar |
| summary | No | Contagem dos códigos informados: sensíveis, não sensíveis e não classificados |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| classifications | No | Uma entrada por código, na ordem informada |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the annotations: it discloses that both notations (J18.1 and J181) are accepted with identical results, and — critically — that a non-CID-10 code returns `is_csap: null` plus its own `error` rather than `false`, explaining why (`false` would assert the condition exists but is not sensitive). That null-vs-false semantics is exactly the kind of behavioral detail an agent cannot infer from readOnly/idempotent hints or the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action and result, then the notation rule, then the null-vs-false edge case — a sensible ordering with little waste. The trailing reference to the internal build path (src/data/csap-groups-cid9.json) is implementation detail an agent does not need and slightly dilutes the ending.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not enumerate return fields, and it still covers the ambiguous cases agents would get wrong: dual notation, non-CID-10 input yielding null plus error, and CID-9 exclusion. Nothing needed to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single parameter is already documented, so the baseline is 3. The description adds genuine value by clarifying that either `J18.1` or `J181` notation is valid and returns the same answer, which the schema's example values do not state.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb+resource: classifies one or more CID-10 codes as CSAP or not, and states the return (the corresponding CSAP group when applicable). It clearly distinguishes itself from siblings like list_csap_groups and get_icsap, which surface group definitions/metrics rather than per-code classification.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states the scope boundary: only CID-10 is handled here; 6-digit CID-9 SIH codes from 1992–1997 are classified at build time from a derived list and not by this tool. There is no explicit routing to a sibling tool for those cases, so it stops short of full when/when-not/alternatives guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
compare_icsap_trendsTendências comparativas de ICSAPARead-onlyIdempotentInspect
Análise temporal comparativa de ICSAP entre UFs ou grupos CSAP. Calcula tendências, variação anual e identifica melhores/piores desempenhos. Para percentage e count valem todos os anos do SIH (desde 1992); rate_per_10k exige população e aceita só os anos de get_available_years.population_years. Em 1992–1997 a ICSAP vem de lista CID-9 DERIVADA e não oficial (g03 e g05 não comparáveis com 1998+) e uf é a UF do arquivo — ver as notes. Percentual no universo do pacote R csapAIH por padrão (universe): fora do numerador e do denominador as internações por procedimento obstétrico, parto e longa permanência.
| Name | Required | Description | Default |
|---|---|---|---|
| end_year | Yes | Ano final | |
| universe | No | Universo do % ICSAP: 'csapaih' (padrão) tira do numerador e do denominador as internações por procedimento obstétrico, com diagnóstico de parto (O80-O84) e as AIH de longa permanência, como o pacote R csapAIH (Nedel); 'all' conta todas as internações. | |
| indicator | No | Indicador: percentage (% ICSAP), count (número), rate_per_10k (taxa) | |
| compare_by | No | Comparar por UF ou grupo CSAP | |
| start_year | Yes | Ano inicial | |
| compare_values | No | Valores específicos para comparar (UFs ou grupos CSAP) | |
| include_trend_line | No | Incluir análise de tendência linear (default: true) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Sempre vazio: só aparece no caminho de erro-mole do funil |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| period | No | Intervalo de anos pedido |
| series | No | Pontos em ordem cronológica |
| trends | No | Tendência por valor comparado; só com `include_trend_line` e ao menos dois anos — ausente quando desligada |
| summary | No | Melhor e pior evolução entre os valores comparados (pela variação entre as pontas) e como ler o indicador; vazio quando não há o que dizer |
| indicator | No | Indicador das séries |
| compare_by | No | Eixo comparado: uf, csap_group ou total (sem eixo) |
| provenance | Yes | Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| population_years | No | Cobertura populacional; só no erro-mole de `rate_per_10k` fora do intervalo |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnly/idempotent annotations, it discloses critical data-quality behavior the agent could not get from structured fields: CID-9 derived ICSAP for 1992-1997 is non-official and makes g03/g05 non-comparable with 1998+, and `uf` in those years is the file's UF. It also explains the csapAIH universe exclusions (obstetric procedures, O80-O84 deliveries, long-stay AIH).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose then qualifiers in a logical order, but the second half packs several dense clauses (year ranges, CID-9 caveat, universe definition) into long sentences. Acceptable for a tool with this many data caveats, but not maximally scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the description covers year-validity, historical comparability, and universe semantics. The only gap is that it does not point to which sibling retrieves population_years or how compare_values should be formatted, though the schema partially covers the latter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds cross-parameter semantics: which indicators are valid over which year ranges and that rate_per_10k needs population years from get_available_years.population_years. The `universe` default and its effect on numerator/denominator are also restated with rationale.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: comparative temporal analysis of ICSAP across UFs or CSAP groups, listing computed outputs (trends, annual variation, best/worst performers). It implicitly separates itself from compare_regions and get_hospitalization_trends by scoping to ICSAP and UF/CSAP-group comparison, but never names those siblings explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states concrete conditions for each indicator: percentage/count work for all SIH years, while rate_per_10k requires population data and is limited to population_years. That is clear usage context, though there are no explicit when-not-to-use rules or named alternative tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
compare_regionsComparação entre UFs e regiõesARead-onlyIdempotentInspect
Compara internações entre UFs ou regiões do Brasil. Gera rankings e identifica variações regionais. Em 1992–1997 uf é a UF do arquivo (estabelecimento), não de residência — ver get_available_years.uf_basis e as notes.
| Name | Required | Description | Default |
|---|---|---|---|
| year | No | Anos para consultar | |
| limit | No | Número de resultados (default: 10) | |
| metric | No | Métrica para ranking (default: n) | |
| is_csap | No | Filtrar apenas CSAP | |
| compare_by | No | Comparar por UF ou região (default: uf) | |
| cid_chapter | No | Capítulo CID-10 específico |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Sempre vazio: só aparece no caminho de erro-mole do funil |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| metric | No | Métrica que ordena o ranking |
| ranking | No | Ranking em ordem decrescente da métrica |
| compare_by | No | Eixo da comparação (hoje ambos agrupam por UF) |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| total_locations | No | Quantas localidades no ranking |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish that this is a safe, read-only, idempotent operation. The description adds important behavioral context about interpreting `uf` for 1992–1997, directing users to get_available_years.uf_basis and notes. It does not need to repeat the annotation-level safety properties.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core purpose, then output behavior, then a critical historical caveat. Every sentence adds value and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema and rich annotations, the description need not explain return values or safety. It covers purpose and a key data caveat, though it could be more complete by naming alternative tools or clarifying when to choose this over similar comparison tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds meaningful semantic interpretation beyond the schema by warning that `uf` in 1992–1997 refers to establishment UF rather than residence UF, which affects how compare_by results should be read.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: compares hospitalizations between Brazilian UFs or regions. It also mentions rankings and regional variation output. It does not explicitly distinguish itself from siblings such as compare_icsap_trends, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage for regional comparisons and rankings but gives no explicit when-to-use, when-not-to-use, or sibling alternative guidance. The reference to get_available_years.uf_basis is a useful caveat rather than general usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_available_yearsAnos disponíveis e frescor dos cubosARead-onlyIdempotentInspect
Retorna os anos disponíveis nos dados do SIH-SUS carregados e o frescor dos cubos em relação ao espelho healthbr-data (freshness.status: current, stale, unknown, pending ou disabled; quando stale, lista por ano as partições reeditadas pelo MS, regeneradas, retiradas ou novas na janela). Por ano, o que muda entre as eras do SIH: race_available (raça/cor só de 2008), cid_revision (9 = CID-9 de 6 dígitos em 1992–1997, 10 = CID-10; 1997 tem as duas), icsap_list_revision (cid9-derivada, não oficial, em 1992–1997), uf_basis (arquivo em 1992–1997, residencia de 1998), municipality_available, currency e records_date_imputed.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| note | No | Aviso sobre o que `years` significa |
| error | No | Falha ao listar os anos |
| years | No | Anos com cubos Parquet presentes localmente |
| currency | No | Moeda de `value` — chave é o ano (string) |
| uf_basis | No | Base do eixo `uf` — chave é o ano (string) |
| freshness | No | Frescor dos cubos locais frente ao espelho healthbr-data |
| data_range | No | Intervalo dos anos locais |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| years_cid9 | No | Anos em que o cubo usa CID-9 (1992–1997) |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| cid_revision | No | Internações por revisão da CID — chave é o ano (string) |
| csap_universe | No | Universo do % ICSAP — chave é o ano (string) |
| cubes_channel | No | Canal público dos cubos e cache local |
| race_available | No | Raça/cor disponível — chave é o ano (string) |
| icsap_available | No | ICSAP disponível — chave é o ano (string) |
| population_years | No | Cobertura dos arquivos de população por UF: o que as ferramentas de taxa aceitam |
| years_uf_arquivo | No | Anos em que `uf` é a do estabelecimento (1992–1997) |
| years_without_race | No | Anos sem raça/cor (1998–2007) |
| icsap_list_revision | No | Lista ICSAP por revisão da CID — chave é o ano (string) |
| records_date_imputed | No | Datas imputadas — chave é o ano (string) |
| municipality_available | No | Município disponível — chave é o ano (string) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover safety (readOnly, idempotent, non-destructive) and closed-world scope, so the bar is lower. The description still adds real behavioral context beyond them: the freshness.status enum meanings (current, stale, unknown, pending, disabled) and the fact that stale cubes enumerate re-edited, regenerated, withdrawn or new partitions per year.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in the opening clause, which is good. But the body is a single dense run-on that enumerates seven per-year fields (race_available, cid_revision, icsap_list_revision, uf_basis, municipality_available, currency, records_date_imputed) that an output schema would already carry, diluting the key freshness message.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be spelled out, yet the description supplies the freshness-state semantics the schema likely cannot. With no parameters and full schema coverage, the definition is essentially complete for a metadata tool; only the lack of when-to-use routing is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there are no argument semantics to explain; the baseline is 4. The description correctly offers no parameter discussion, nothing misleading.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: it returns the available years present in the loaded SIH-SUS data plus the freshness of cubes against the healthbr-data mirror. It is clearly distinguishable in effect from the data-querying siblings, but it never names or contrasts with an alternative tool, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this is a discovery/metadata step (learn which years exist and how fresh they are) but never states when to call it versus list_csap_groups or get_hospitalizations, nor flags that it takes no arguments. Usage must be inferred from the returned content.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_hospitalization_ratesTaxas de internação por populaçãoARead-onlyIdempotentInspect
Calcula taxas de internação por população. A taxa sai em rate, na base declarada em rate_per (1000, 10000 ou 100000; default 100000). Denominador lido de dois arquivos, informados em get_available_years.population_years: projeções do IBGE por idade simples de 2000 em diante (pop_uf.parquet) e, de 1991 a 1999, população por faixa etária quinquenal somada dos municípios (pop_uf_agregado.parquet) — antes de 2000 o recorte por idade só vale nos limites das faixas (age_min múltiplo de 5, age_max terminado em 4 ou 9, ou 80+). A resposta diz qual arquivo serviu a cada ano (population_source) e avisa quando mistura os dois.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UFs para filtrar | |
| sex | No | Filtrar por sexo | |
| year | No | Anos para calcular | |
| age_max | No | Idade máxima | |
| age_min | No | Idade mínima | |
| is_csap | No | Filtrar apenas CSAP | |
| group_by | No | Dimensões para agrupamento | |
| rate_per | No | Taxa por X habitantes (default: 100000) | |
| rate_type | No | Tipo de taxa: crude (bruta) ou specific (específica por filtro) | |
| cid_chapter | No | Capítulos CID-10 (1-22) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Um estrato por linha (vazio quando não há internação no recorte) |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| summary | No | Totais somados sobre as linhas de `data` e a taxa do conjunto |
| metadata | No | De onde veio o denominador (arquivo de população por ano, avisos) e os argumentos efetivamente atendidos |
| truncated | No | Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro |
| provenance | Yes | Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| population_years | No | Cobertura dos arquivos de população por UF: o que as ferramentas de taxa aceitam |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the read-only/idempotent profile, but the description adds substantial behaviour: the denominator comes from two different files depending on year (pop_uf.parquet from 2000, pop_uf_agregado.parquet for 1991-1999), and the response flags which source was used per year and warns when both are mixed. That is real operational context an agent could not get from the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One dense paragraph that front-loads the purpose and output field before the denominator caveats. Every clause carries information, though the long mid-sentence em-dash construction and repeated file names make it harder to scan than it needs to be.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 10 all-optional parameters, an output schema present, and full schema coverage, the description supplies exactly the missing piece: the dual denominator source, the pre-2000 age constraint, and the population_source/mixing warning in the response. Return-value structure is left to the output schema, which is appropriate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline would be 3, but the description adds genuine meaning beyond the schema for age_min/age_max: before 2000 the age cut only works on five-year band boundaries (age_min multiple of 5, age_max ending in 4 or 9, or 80+). It also restates the rate_per default and allowed bases, which is redundant with the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Calcula taxas de internação por população') and immediately names the output field ('rate'), so it is distinguishable from count-oriented siblings like get_hospitalizations. It never explicitly names a sibling alternative, so differentiation is inferred from the word 'taxas' rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied (use this when you need a rate rather than a count), and the pre-2000 age-band restriction functions as a partial 'when not to expect' caveat. There is no explicit statement of when to prefer this over get_hospitalization_trends or get_icsap_indicators.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_hospitalizationsInternações do SUS com filtrosARead-onlyIdempotentInspect
Consulta dados de internações hospitalares do SUS com filtros flexíveis. Permite agregar por múltiplas dimensões (UF, CID, sexo, idade, raça, ano/mês). Raça/cor só existe de 2008 em diante: em 1998–2007 race é nulo (ver get_available_years.race_available). Série desde 1992: em 1992–1997 o diagnóstico é CID-9 decodificado por tabela (cid_group = categoria de 3 dígitos, cid_chapter = capítulo CID-10 equivalente; agrupar por cid_revision separa 9 e 10 — 1997 tem os dois), uf é a UF do ARQUIVO (estabelecimento), não de residência, e value é nominal na moeda da época — ver get_available_years (uf_basis, currency) e as notes da resposta. exclusion (agrupável) marca as internações fora do universo do % ICSAP do csapAIH (procedimento_obstetrico, parto, longa_permanencia; nula = dentro).
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | Lista de UFs (ex: ['SP', 'RJ']). Se omitido, todas. | |
| sex | No | Filtrar por sexo | |
| race | No | Raça/cor (branca, preta, parda, amarela, indigena, ignorado). Só existe de 2008 em diante: em 1998–2007 race é nulo e o filtro não alcança esses anos. | |
| year | No | Anos para consultar (ex: [2023, 2024]); série de 1992 em diante | |
| limit | No | Limitar número de resultados | |
| month | No | Meses (1-12). Se omitido, todos. | |
| age_max | No | Idade máxima em anos | |
| age_min | No | Idade mínima em anos | |
| is_csap | No | Filtrar apenas CSAP (true) ou não-CSAP (false) | |
| group_by | No | Dimensões para agrupamento | |
| cid_chapter | No | Capítulos CID-10 (1-22). Se omitido, todos. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Linhas agrupadas (vazio no caminho de erro-mole) |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| summary | No | Totais do recorte inteiro (não do trecho devolvido, quando truncado) |
| truncated | No | Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| filters_applied | No | Os argumentos recebidos, ecoados |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish the safe read-only, idempotent profile, so the description's job is to add data-behavior context — and it does so substantially: race null before 2008, CID-9 vs CID-10 encoding in 1992–1997, `uf` being the establishment/file UF rather than residence, nominal historical currency, and the meaning of `exclusion`. It stops short of operational behavior such as result-size limits or pagination, so it is not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One dense paragraph, but it is front-loaded with the core purpose and every subsequent sentence carries a non-obvious caveat rather than filler. It is long by raw character count, which is defensible for an 11-parameter historical-data tool, though bullets or shorter clauses would improve scanability.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be described, and the description thoroughly covers the historical/encoding quirks an agent must know to interpret results correctly. The remaining gap is operational: no guidance on how this differs from overlapping siblings like get_hospitalization_trends.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, which sets a baseline of 3, but the description adds real semantic value beyond the schema: it explains `cid_group` as a 3-digit CID-9 category and `cid_chapter` as the equivalent CID-10 chapter, notes that `cid_revision` separates 9 from 10 (1997 having both), and clarifies the historical nullability and basis of `race`/`uf`. This meaningfully informs filter/group choices.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Consulta dados de internações hospitalares do SUS') and goes further to describe the aggregation capability across dimensions. However, it never distinguishes this tool from close siblings such as get_hospitalization_trends or get_icsap, so an agent cannot route between them from the text alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description says what the tool can do ('filtros flexíveis', aggregation by dimensions) but gives no explicit when-to-use, when-not-to-use, or alternative-tool guidance. The only cross-reference is to get_available_years, and that is for metadata lookup, not as a routing alternative to this query tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_hospitalization_trendsSéries temporais de internaçõesARead-onlyIdempotentInspect
Retorna séries temporais de internações (mensal ou anual). Útil para análise de tendências e sazonalidade. O ano e o mês são os da INTERNAÇÃO (DT_INTER), não a competência de faturamento; o ano mais recente cresce até a janela dele fechar (AIH faturada com atraso), e o DATASUS reedita arquivos de competências passadas — cada número é a versão do download do espelho. Série desde 1992; em 1992–1997 uf é a UF do arquivo (estabelecimento) e as internações sem data na fonte (1992-01..04 e 1993-01) entram no mês de faturamento — ver get_available_years e as notes.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UFs para filtrar | |
| year_end | Yes | Ano final | |
| year_start | Yes | Ano inicial | |
| cid_chapter | No | Capítulo CID-10 específico | |
| granularity | No | Granularidade temporal (default: yearly) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Sempre vazio: só aparece no caminho de erro-mole do funil |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| period | No | Intervalo pedido |
| series | No | Um ponto por ano ou por mês, em ordem cronológica |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| granularity | No | Grão da série |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive), yet the description adds substantial operational context: year/month are DT_INTER not billing competence, the latest year grows until its window closes due to late AIH billing, DATASUS reissues past files so each figure reflects the downloaded mirror, and series coverage back to 1992. This is exactly the kind of behavior no annotation can convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose and usage are front-loaded in the first two sentences, followed by denser caveats. It is a long single paragraph, but nearly every clause carries non-obvious data-integrity information, so little is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description needn't explain return shape, and it instead fills the gaps that matter: temporal semantics, late-reporting behavior, data revisions, and historical edge cases, plus pointers to get_available_years and the notes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, giving a baseline of 3, but the text adds genuine meaning: it clarifies that year/month refer to the admission date rather than billing competence, and that in 1992–1997 `uf` denotes the file/establishment UF with undated admissions bucketed by billing month. That is more than the terse schema labels provide.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource (returns hospitalization time series) with scope (monthly or yearly) and purpose (trend/seasonality analysis). It is distinguishable from raw-listing siblings like get_hospitalizations, though it never names an alternative tool to sharpen the contrast.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'Útil para análise de tendências e sazonalidade' implies when to reach for it, and it points to get_available_years and the `notes` for caveats. However there is no explicit when-not or named alternative (e.g. vs get_hospitalizations or compare_icsap_trends), so routing is left partly to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_icsapInternações por condições sensíveis (ICSAP)ARead-onlyIdempotentInspect
Consulta internações por Condições Sensíveis à Atenção Primária (ICSAP). Permite filtros por grupo CSAP, UF, município, sexo, idade e raça. Raça/cor só existe de 2008 em diante: em 1998–2007 race é nulo (ver get_available_years.race_available). Série desde 1992: em 1992–1997 a ICSAP vem de lista CID-9 DERIVADA e não oficial (g03 e g05 não comparáveis com 1998+), uf é a UF do arquivo e municipality_code é nulo — ver get_available_years (icsap_list_revision, uf_basis) e as notes. Percentual no universo do pacote R csapAIH por padrão (universe): fora do numerador e do denominador as internações por procedimento obstétrico, parto e longa permanência.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UFs para filtrar | |
| sex | No | Filtrar por sexo | |
| race | No | Raça/cor (branca, preta, parda, amarela, indigena, ignorado). Só existe de 2008 em diante: em 1998–2007 race é nulo e o filtro não alcança esses anos. | |
| year | No | Anos para consultar | |
| age_max | No | Idade máxima | |
| age_min | No | Idade mínima | |
| group_by | No | Dimensões para agrupamento | |
| universe | No | Universo do % ICSAP: 'csapaih' (padrão) tira do numerador e do denominador as internações por procedimento obstétrico, com diagnóstico de parto (O80-O84) e as AIH de longa permanência, como o pacote R csapAIH (Nedel); 'all' conta todas as internações. | |
| csap_group | No | Grupos CSAP (ex: ['g01', 'g05']) | |
| municipality_code | No | Código IBGE do município (6 dígitos) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Linhas agrupadas (vazio no caminho de erro-mole) |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| summary | No | Totais do recorte inteiro, calculados sem agrupamento |
| truncated | No | Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro |
| provenance | Yes | Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| filters_applied | No | Os argumentos recebidos, ecoados |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations (which only declare read-only/idempotent/non-destructive) by disclosing substantive data caveats: race is null in 1998–2007, the 1992–1997 CID-9 ICSAP list is derived/unofficial with non-comparable g03/g05, uf is the file's UF and municipality_code is null in that era, and the default universe excludes obstetric/parto/long-stay records. This is exactly the kind of behavioral context an agent needs to interpret results correctly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the purpose, then layers the temporal caveats efficiently in a compact paragraph with no redundant filler. It is dense and somewhat prose-heavy, but every clause carries a distinct data caveat, so little is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given a rich output schema, complete annotations, and full parameter coverage, the description supplies the remaining critical context: temporal validity windows for race/uf/municipality_code, list-revision discontinuity, and the default denominator universe. An agent has enough to call and interpret this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3, but the description meaningfully expands semantics: it explains the default 'csapaih' universe definition and the year-dependence of race, uf, and municipality_code (grouping columns 'uf' and 'municipality_code' behave differently pre-1998). This adds interpretive value the schema fields alone do not convey.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Consulta internações por Condições Sensíveis à Atenção Primária') and enumerates the available filters, so an agent knows this is a filtered query over ICSAP hospitalizations. It does not, however, distinguish itself from close siblings like get_icsap_indicators or get_hospitalizations, so the differentiation is left to inference.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied through the listed filters and the pointer to get_available_years for interpreting revisions/basis, which is useful complementary guidance. But there is no explicit statement of when to prefer this over get_icsap_indicators, compare_icsap_trends, or get_hospitalizations, and no when-not-to-use condition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_icsap_indicatorsIndicadores de ICSAPARead-onlyIdempotentInspect
Calcula indicadores de ICSAP: percentual (ICSAP/Total×100). Métricas-chave para avaliar a Atenção Primária. Agrupar por raça só faz sentido de 2008 em diante: em 1998–2007 race é nulo (ver get_available_years.race_available). Em 1992–1997 a ICSAP vem de lista CID-9 DERIVADA e não oficial (g03 e g05 não comparáveis com 1998+) e uf é a UF do arquivo — ver as notes. Percentual no universo do pacote R csapAIH por padrão (universe): fora do numerador e do denominador as internações por procedimento obstétrico, parto e longa permanência.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UFs para calcular | |
| sex | No | Filtrar por sexo | |
| year | No | Anos para calcular | |
| age_max | No | Idade máxima | |
| age_min | No | Idade mínima | |
| group_by | No | Dimensões para agrupamento | |
| universe | No | Universo do % ICSAP: 'csapaih' (padrão) tira do numerador e do denominador as internações por procedimento obstétrico, com diagnóstico de parto (O80-O84) e as AIH de longa permanência, como o pacote R csapAIH (Nedel); 'all' conta todas as internações. | |
| municipality_code | No | Código IBGE do município |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Um estrato por linha (vazio no caminho de erro-mole) |
| note | No | Fórmula do indicador — ou, no caminho de erro-mole, como obter o dado |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| truncated | No | Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro |
| provenance | Yes | Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
| indicators_calculated | No | Indicadores presentes nas linhas (icsap_percentage) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive, but the description adds substantive domain behavior: the default `universe` excludes obstetric, parto (O80-O84) and long-stay hospitalizations from both numerator and denominator, and it warns about non-comparable CID-9-derived data and null `race`. This discloses non-obvious data caveats beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose and formula are front-loaded in the first two sentences, followed by the caveats. It is dense with multi-clause sentences, but every sentence carries non-redundant information, so the size is largely justified by the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return format need not be explained, and the description covers the main data-validity caveats an agent needs (race availability, CID-9 derivation, universe default). For a 9-parameter, multi-year epidemiological tool this is close to complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all 8 params (baseline 3). The description goes further by explaining the practical meaning of `group_by=race` (only valid 2008+) and the quirk of `uf` in early years, adding interpretation the schema does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Calcula indicadores de ICSAP") and even gives the exact formula (ICSAP/Total×100), which is more than a restatement of the title. It clearly reads as an aggregate-indicator tool distinct from raw-count siblings like get_icsap, though it never names an alternative explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides concrete conditions for correct use: race grouping only makes sense from 2008 onward because `race` is null in 1998–2007, and 1992–1997 ICSAP comes from a derived CID-9 list with `uf` being the file's UF. These are real when-to-use constraints, but there is no explicit routing to sibling tools (e.g. vs get_icsap or compare_icsap_trends).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_cid_chaptersCapítulos da CID-10ARead-onlyIdempotentInspect
Lista os 22 capítulos da CID-10 com seus códigos e faixas de diagnóstico. Os cubos de 1992–1997 (diagnóstico em CID-9) trazem cid_chapter como o capítulo CID-10 equivalente (mapa por categoria em src/data/cid9-chapters.json).
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| chapters | No | Os capítulos, na ordem da CID |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| total_chapters | No | Número de capítulos (22) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive/closed-world, so safety is covered. The description adds behavioral context beyond that: the fixed size of the enumeration (22 chapters) and the crosswalk mechanism (per-category mapping for pre-1998 data).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, with the primary purpose front-loaded before the qualification. Both sentences carry information, though the internal file path (`src/data/cid9-chapters.json`) is implementation detail that adds little for tool selection.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be described. For a zero-parameter reference lookup, the description supplies everything needed: what is listed, its finite size, and the CID-9-to-CID-10 caveat that explains when the data matters.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the rubric the baseline is 4. There is no parameter surface for the description to explain or for the schema to omit.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Lista os 22 capítulos da CID-10') plus the content returned (codes and diagnosis ranges). The resource is clearly distinct from every sibling (CSAP groups, hospitalizations, trends), so an agent can identify it immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The second sentence supplies real usage context: it explains that 1992–1997 cubes encode CID-9 and that `cid_chapter` holds the equivalent CID-10 chapter, telling the agent when this lookup is relevant. It stops short of explicit when-not-to-use or naming an alternative sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_csap_groupsGrupos CSAP (Portaria 221/2008)ARead-onlyIdempotentInspect
Lista os 19 grupos de Condições Sensíveis à Atenção Primária (CSAP) conforme Portaria MS/SAS 221/2008. Retorna código, nome e códigos CID-10 de cada grupo.
| Name | Required | Description | Default |
|---|---|---|---|
| group_code | No | Código do grupo específico (ex: 'g01'). Se omitido, retorna todos. | |
| include_cid_codes | No | Se true, inclui lista de códigos CID-10 (default: false) |
Output Schema
| Name | Required | Description |
|---|---|---|
| error | No | Grupo CSAP não encontrado |
| group | No | O grupo pedido por `group_code` |
| groups | No | Os 19 grupos, na ordem da Portaria |
| source | No | Norma que define a lista (Portaria MS/SAS 221/2008) |
| provenance | Yes | Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| total_groups | No | Número de grupos na lista (19) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnly, idempotent, non-destructive, closed-world behavior. The description adds real value beyond them by specifying that the set is a fixed, authoritative list of exactly 19 groups from a named ordinance, and that entries carry code, name and CID-10 codes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, zero filler, and the identity of the resource is front-loaded before the return payload. Nothing is repeated or restated from the title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only two-optional-parameter listing tool with an output schema and full safety annotations, this is nearly sufficient; the output schema removes any need to explain return values. The only shortfall is the absence of guidance on filtering by group_code versus fetching all groups.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so both parameters (group_code filter, include_cid_codes toggle) are already fully documented in the schema; baseline 3 applies. The phrase 'Retorna código, nome e códigos CID-10' loosely gestures at the CID-10 flag but adds no syntax or default detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb ('Lista') plus a precisely scoped resource: the 19 CSAP groups defined by Portaria MS/SAS 221/2008. This clearly separates it from siblings like list_cid_chapters and rank_csap_groups, though no sibling is named explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: this is evidently a reference/lookup call (e.g. to resolve a group code before calling rank_csap_groups or classify_as_csap). The description never states when to use it versus the other listing tools, nor any prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
rank_csap_groupsRanking dos grupos CSAPARead-onlyIdempotentInspect
Gera ranking dos 19 grupos CSAP por número de internações, dias de internação ou valor. Identifica principais causas evitáveis. Em 1992–1997 a ICSAP vem de lista CID-9 DERIVADA e não oficial (g03 e g05 não comparáveis com 1998+) e value é nominal na moeda da época — ver as notes. Universo do pacote R csapAIH por padrão (universe): fora as internações por procedimento obstétrico, parto e longa permanência.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UFs para filtrar | |
| sex | No | Filtrar por sexo | |
| year | No | Anos para consultar | |
| limit | No | Número de grupos no ranking (default: 19) | |
| metric | No | Métrica para ranking (default: n) | |
| age_max | No | Idade máxima | |
| age_min | No | Idade mínima | |
| universe | No | Universo do % ICSAP: 'csapaih' (padrão) tira do numerador e do denominador as internações por procedimento obstétrico, com diagnóstico de parto (O80-O84) e as AIH de longa permanência, como o pacote R csapAIH (Nedel); 'all' conta todas as internações. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | Sempre vazio: só aparece no caminho de erro-mole do funil |
| note | No | Como obter o dado (por exemplo, consultar get_available_years) |
| error | No | Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta) |
| notes | No | Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento |
| metric | No | Métrica que ordena |
| ranking | No | Ranking em ordem decrescente da métrica |
| provenance | Yes | Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem |
| attribution | Yes | URLs canônicas das fontes desta resposta (lista de atribuição) |
| total_groups | No | Quantos grupos no ranking |
| concentration | No | Concentração da métrica nos primeiros grupos do ranking (soma de `pct_of_total`, duas casas) |
| published_years | No | Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado |
| available_sih_years | No | Anos com dados SIH atendíveis por este servidor |
| years_not_available | No | Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover safety (readOnly, idempotent, non-destructive, closed world), so the bar is lower; the description nonetheless adds substantive behavioral caveats: the 1992–1997 ICSAP comes from an unofficial derived CID-9 list, g03/g05 are not comparable with 1998+, `value` is nominal in period currency, and it points to `notes`. What it does not state is whether ranking ties are handled or what the output rows look like, but with an output schema present that is acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the verb+resource, then caveats, then the universe default — a sensible ordering. It is dense and slightly run-on with three caveats packed mid-paragraph, but every sentence carries information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 8-parameter, zero-required tool with a full output schema, the description supplies the non-obvious context an agent needs: historical data caveats, currency nominality, and universe scope. The remaining gap is the undocumented `deaths` metric, which the metric enum exposes but the description never surfaces.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the `universe` parameter is already fully documented in the schema, so baseline is 3. The description adds genuine semantics for the `value` metric (nominal, period currency) and reinforces the universe exclusion rules, but it does not mention the `deaths` metric or clarify year/uf interactions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: generates a ranking of the 19 CSAP groups by hospitalizations, days or value, plus identifying leading avoidable causes. An agent can tell this is the ranked-aggregate tool versus per-group lookups like list_csap_groups. It does not explicitly contrast with siblings, and it omits the `deaths` metric that the schema supports, so not a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage context is implied by the caveats (pre-1998 data comparability, currency nominality) and by naming the `universe` default, but there is no explicit when-to-use versus list_csap_groups, get_icsap_indicators or compare_icsap_trends. The agent must infer the routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
4 tool updates
v1.8.1- Changed
classify_as_csap1 field changed- added
Output schema / properties / summary / descriptionAdded value: +"Contagem dos códigos informados: sensíveis, não sensíveis e não classificados"
- Changed
compare_icsap_trends2 fields changed- added
Output schema / properties / period / descriptionAdded value: +"Intervalo de anos pedido" - added
Output schema / properties / summary / descriptionAdded value: +"Melhor e pior evolução entre os valores comparados (pela variação entre as pontas) e como ler o indicador; vazio quando não há o que dizer"
- Changed
get_hospitalization_rates2 fields changed- added
Output schema / properties / metadata / descriptionAdded value: +"De onde veio o denominador (arquivo de população por ano, avisos) e os argumentos efetivamente atendidos" - added
Output schema / properties / summary / descriptionAdded value: +"Totais somados sobre as linhas de `data` e a taxa do conjunto"
- Changed
rank_csap_groups1 field changed- added
Output schema / properties / concentration / descriptionAdded value: +"Concentração da métrica nos primeiros grupos do ranking (soma de `pct_of_total`, duas casas)"
1 tool update
v1.8.0- Changed
get_hospitalization_rates3 fields changed- changed
Output schema / properties / data / items / properties / rate / descriptionPrevious value: -"Internações por `rate_per` habitantes, duas casas"New value: +"Internações por `rate_per` habitantes, com no mínimo 3 algarismos significativos e nunca menos de duas casas (taxa pequena não vira 0)" - changed
Output schema / properties / data / items / properties / rate_per_100k / descriptionPrevious value: -"DEPRECADO — use `rate` com `rate_per`. Internações por 100 mil habitantes, qualquer que seja `rate_per`; sai numa versão futura"New value: +"DEPRECADO — use `rate` com `rate_per`. Internações por 100 mil habitantes, qualquer que seja `rate_per`, mesmo arredondamento de `rate`; sai numa versão futura" - changed
Output schema / properties / summary / properties / overall_rate / descriptionPrevious value: -"Taxa do conjunto, na base `rate_per`"New value: +"Taxa do conjunto, na base `rate_per`, mesmo arredondamento de `rate`"
12 tool updates
v1.7.0- Changed
classify_as_csap6 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
compare_icsap_trends6 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / items / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / items / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / items / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / items / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
compare_regions6 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
get_available_years6 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
get_hospitalization_rates7 fields changed- changed
Output schema / properties / data / items / properties / year / descriptionPrevious value: -"Ano (quando agrupado por ano ou mais de um ano)"New value: +"Ano da internação (DT_INTER), quando agrupado por ano ou mais de um ano" - changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / items / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / items / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / items / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / items / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
get_hospitalization_trends7 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +} - changed
Output schema / properties / series / items / anyOfPrevious value: -[ - { - "additionalProperties": false, - "description": "Ponto anual", - "properties": { - "deaths": { - "description": "Óbitos no ano", - "type": "number" - }, - "n_hospitalizations": { - "description": "Internações no ano", - "type": "number" - }, - "year": { - "description": "Ano", - "type": "number" - } - }, - "required": [ - "year", - "n_hospitalizations", - "deaths" - ], - "type": "object" - }, - { - "additionalProperties": false, - "description": "Ponto mensal", - "properties": { - "deaths": { - "description": "Óbitos no mês", - "type": "number" - }, - "n": { - "description": "Internações no mês", - "type": "number" - }, - "year_month": { - "description": "Competência AAAA-MM", - "type": "string" - } - }, - "required": [ - "year_month", - "n", - "deaths" - ], - "type": "object" - } -]New value: +[ + { + "additionalProperties": false, + "description": "Ponto anual", + "properties": { + "deaths": { + "description": "Óbitos no ano", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações no ano", + "type": "number" + }, + "year": { + "description": "Ano da internação (DT_INTER)", + "type": "number" + } + }, + "required": [ + "year", + "n_hospitalizations", + "deaths" + ], + "type": "object" + }, + { + "additionalProperties": false, + "description": "Ponto mensal", + "properties": { + "deaths": { + "description": "Óbitos no mês", + "type": "number" + }, + "n": { + "description": "Internações no mês", + "type": "number" + }, + "year_month": { + "description": "Ano-mês da INTERNAÇÃO (DT_INTER), AAAA-MM — não a competência de faturamento; só nas internações sem DT_INTER na fonte (1992-01..04, 1993-01) é a competência", + "type": "string" + } + }, + "required": [ + "year_month", + "n", + "deaths" + ], + "type": "object" + } +]
- Changed
get_hospitalizations7 fields changed- changed
Output schema / properties / data / items / properties / year / descriptionPrevious value: -"Ano (group_by: year)"New value: +"Ano da internação (DT_INTER) — group_by: year" - changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
get_icsap7 fields changed- changed
Output schema / properties / data / items / properties / year / descriptionPrevious value: -"Ano (group_by: year)"New value: +"Ano da internação (DT_INTER) — group_by: year" - changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / items / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / items / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / items / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / items / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
get_icsap_indicators7 fields changed- changed
Output schema / properties / data / items / properties / year / descriptionPrevious value: -"Ano (group_by: year)"New value: +"Ano da internação (DT_INTER) — group_by: year" - changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / items / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / items / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / items / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / items / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
list_cid_chapters6 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
list_csap_groups6 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
- Changed
rank_csap_groups6 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença"New value: +"Bloco de proveniência do portfólio: fonte, URL, competência, extração, diagnóstico de origem, citação e licença; e, só quando há o que dizer, avisos, o que o servidor calculou e se o número ainda pode mudar" - added
Output schema / properties / provenance / items / properties / derivation_noteAdded value: +{ + "description": "Como o número foi calculado; presente junto com derived", + "type": "string" +} - added
Output schema / properties / provenance / items / properties / derivedAdded value: +{ + "description": "Presente (true) quando o número foi calculado por este servidor — os cubos SIH são somas das internações dos arquivos do DATASUS", + "type": "boolean" +} - added
Output schema / properties / provenance / items / properties / noticesAdded value: +{ + "description": "Avisos que acompanham o dado (ex.: cubo atrás do espelho healthbr-data, frescor não verificado). Ausente quando não há aviso", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieval / descriptionPrevious value: -"Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)"New value: +"Diagnóstico de origem desta chamada: idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)" - added
Output schema / properties / provenance / items / properties / revisionAdded value: +{ + "additionalProperties": false, + "description": "Se o número ainda pode mudar: provisional quando algum ano da resposta ainda tem competências abertas no SIH (o total ainda pode crescer); current nos demais — o DATASUS reedita arquivos de competências passadas", + "properties": { + "note": { + "description": "O específico da fonte: o que revisa, quando, por quê", + "type": [ + "string", + "null" + ] + }, + "status": { + "description": "current = versão vigente, a fonte pode revisá-la; provisional = preliminar, incompleta ou sujeita a mudança (não compare como se fosse fechada); final = não muda mais, declarado pela fonte", + "enum": [ + "current", + "provisional", + "final" + ], + "type": "string" + } + }, + "required": [ + "status", + "note" + ], + "type": "object" +}
12 tool updates
v1.4.1- Changed
classify_as_csap2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
compare_icsap_trends2 fields changed- added
Output schema / properties / provenance / items / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
compare_regions2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_available_years2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_hospitalization_rates2 fields changed- added
Output schema / properties / provenance / items / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_hospitalization_trends2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_hospitalizations2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_icsap2 fields changed- added
Output schema / properties / provenance / items / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
get_icsap_indicators2 fields changed- added
Output schema / properties / provenance / items / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
list_cid_chapters2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
list_csap_groups2 fields changed- added
Output schema / properties / provenance / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
- Changed
rank_csap_groups2 fields changed- added
Output schema / properties / provenance / items / properties / field_sourcesAdded value: +{ + "description": "Presente só quando a resposta junta partes de origens ou momentos distintos: para cada grupo de campos, a URL, a extração e se veio do cache. Ausente nas respostas de uma origem só", + "items": { + "additionalProperties": false, + "description": "Proveniência de um grupo de campos da resposta: de onde veio e quando foi extraído", + "properties": { + "data_vintage": { + "description": "Vintage/competência da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "dataset_id": { + "description": "Identificador do conjunto da sub-fonte", + "type": [ + "string", + "null" + ] + }, + "fields": { + "description": "Campos do payload atribuídos a esta sub-fonte", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "retrieved_at": { + "description": "ISO-8601 da extração desta sub-fonte na origem", + "type": [ + "string", + "null" + ] + }, + "served_from_cache": { + "description": "true se esta sub-fonte veio do cache do servidor (retrieved_at é o da extração original); false se foi buscada nesta chamada; null se o servidor não distingue", + "type": [ + "boolean", + "null" + ] + }, + "source_url": { + "description": "URL canônica da sub-fonte que originou estes campos", + "type": "string" + } + }, + "required": [ + "fields", + "source_url", + "dataset_id", + "data_vintage", + "retrieved_at" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, o download MAIS ANTIGO, do FTP do DATASUS, entre os .dbc que alimentaram a resposta (cópia idêntica ao original naquela data, MD5 registrado no sidecar), nunca o instante da chamada"
12 tool updates
v1.2.3- Changed
classify_as_csap4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
compare_icsap_trends4 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / items / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / items / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
compare_regions4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_available_years4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_hospitalization_rates8 fields changed- added
Output schema / properties / data / items / properties / rateAdded value: +{ + "description": "Internações por `rate_per` habitantes, duas casas", + "type": "number" +} - added
Output schema / properties / data / items / properties / rate_per_100k / deprecatedAdded value: +true - changed
Output schema / properties / data / items / properties / rate_per_100k / descriptionPrevious value: -"Internações por `rate_per` habitantes (o nome do campo é histórico; a base está em `rate_per`)"New value: +"DEPRECADO — use `rate` com `rate_per`. Internações por 100 mil habitantes, qualquer que seja `rate_per`; sai numa versão futura" - changed
Output schema / properties / data / items / requiredPrevious value: -[ - "n_hospitalizations", - "deaths", - "population", - "rate_per_100k", - "rate_per", - "population_source", - "mortality_rate" -]New value: +[ + "n_hospitalizations", + "deaths", + "population", + "rate", + "rate_per", + "rate_per_100k", + "population_source", + "mortality_rate" +] - changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / items / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / items / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_hospitalization_trends4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_hospitalizations4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_icsap4 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / items / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / items / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
get_icsap_indicators4 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / items / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / items / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
list_cid_chapters4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
list_csap_groups4 fields changed- changed
Output schema / properties / provenance / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
- Changed
rank_csap_groups4 fields changed- changed
Output schema / properties / provenance / items / descriptionPrevious value: -"Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença"New value: +"Bloco de proveniência (contrato v1.1): fonte, URL, competência, extração, diagnóstico de origem, citação e licença" - added
Output schema / properties / provenance / items / properties / retrievalAdded value: +{ + "description": "Diagnóstico de origem desta chamada (contrato v1.1): idas ao canal sih/cubos/ do healthbr-data (manifesto e arquivos que faltavam no disco), tentativas somadas e anomalias contornadas; unstable=true quando houve anomalia. null = a resposta veio do DISCO (cache aquecido) ou o bloco não é do canal (listas de referência)", + "oneOf": [ + { + "additionalProperties": false, + "description": "Diagnóstico de origem da chamada: como o dado foi obtido. Medição real do servidor; unstable=true pede ao agente que trate o dado como obtido com dificuldade", + "properties": { + "anomalies": { + "description": "Anomalias superadas até o sucesso, somadas por classe, em ordem fixa; [] se nenhuma", + "items": { + "additionalProperties": false, + "properties": { + "count": { + "description": "Ocorrências desta classe na chamada", + "minimum": 1, + "type": "integer" + }, + "kind": { + "description": "Classe da anomalia (vocabulário fechado do contrato)", + "enum": [ + "timeout", + "network", + "http_4xx", + "http_5xx", + "rate_limited", + "malformed_body" + ], + "type": "string" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + }, + "type": "array" + }, + "attempts": { + "description": "Tentativas somadas, incluindo as repetidas (>= requests)", + "minimum": 1, + "type": "integer" + }, + "requests": { + "description": "Idas distintas à origem que compõem esta resposta (fatias, páginas)", + "minimum": 1, + "type": "integer" + }, + "unstable": { + "description": "true se houve repetição (attempts > requests) ou alguma anomalia", + "type": "boolean" + } + }, + "required": [ + "requests", + "attempts", + "anomalies", + "unstable" + ], + "type": "object" + }, + { + "type": "null" + } + ] +} - changed
Output schema / properties / provenance / items / properties / retrieved_at / descriptionPrevious value: -"Instante REAL da extração na origem (ISO-8601)"New value: +"Instante REAL da extração na origem (ISO-8601) — para os cubos SIH, a safra do sidecar (extração no FTP do DATASUS), nunca o instante do download" - changed
Output schema / properties / provenance / items / requiredPrevious value: -[ - "source", - "source_url", - "data_vintage", - "retrieved_at", - "citation", - "license" -]New value: +[ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "retrieval", + "citation", + "license" +]
8 tool updates
v1.0.1- Changed
compare_icsap_trends1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
compare_regions1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
get_hospitalization_rates1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
get_hospitalization_trends1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
get_hospitalizations1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
get_icsap1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
get_icsap_indicators1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
- Changed
rank_csap_groups1 field changed- added
Output schema / properties / published_yearsAdded value: +{ + "description": "Anos que o canal de cubos publica — a verdade do canal, distinta do que esta instância tem em disco; só com o cache de cubos ligado", + "items": { + "type": "number" + }, + "type": "array" +}
12 tool updates
v0.17.0- Changed
classify_as_csap1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "classifications", + "summary" + ] + } + ], + "description": "Cada código CID-10 informado classificado como sensível (com o grupo) ou não; `is_csap` é null no código que não é CID-10, que não recebe classificação", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "classifications": { + "description": "Uma entrada por código, na ordem informada", + "items": { + "additionalProperties": false, + "properties": { + "cid": { + "description": "Código como foi informado", + "type": "string" + }, + "csap_group": { + "description": "Grupo CSAP g01–g19; null quando não é sensível ou não foi classificado", + "type": [ + "string", + "null" + ] + }, + "csap_name": { + "description": "Nome do grupo; null quando não é sensível ou não foi classificado", + "type": [ + "string", + "null" + ] + }, + "error": { + "description": "Só nas entradas não classificadas: por que o código não é CID-10", + "type": "string" + }, + "is_csap": { + "description": "true quando o código cai em algum grupo CSAP; false quando é CID-10 e não cai; null quando não é um código CID-10 (não classificado — veja `error` da entrada)", + "type": [ + "boolean", + "null" + ] + } + }, + "required": [ + "cid", + "is_csap", + "csap_group", + "csap_name" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Só quando houver código não classificado: quantos foram e para onde olhar", + "type": "string" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "summary": { + "additionalProperties": false, + "properties": { + "csap": { + "description": "Quantos são sensíveis", + "type": "number" + }, + "non_csap": { + "description": "Quantos são CID-10 e não são sensíveis (não inclui os não classificados)", + "type": "number" + }, + "not_classified": { + "description": "Só quando houver: quantos não são CID-10", + "type": "number" + }, + "total": { + "description": "Códigos informados", + "type": "number" + } + }, + "required": [ + "total", + "csap", + "non_csap" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
compare_icsap_trends1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "indicator", + "period", + "compare_by", + "series", + "notes", + "summary" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Séries anuais do indicador ICSAP por UF ou grupo CSAP, com tendência linear e melhor/pior desempenho; `error` quando o intervalo está fora da cobertura", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "compare_by": { + "description": "Eixo comparado: uf, csap_group ou total (sem eixo)", + "type": "string" + }, + "data": { + "description": "Sempre vazio: só aparece no caminho de erro-mole do funil", + "items": {}, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "indicator": { + "description": "Indicador das séries", + "enum": [ + "percentage", + "count", + "rate_per_10k" + ] + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "period": { + "additionalProperties": false, + "properties": { + "end": { + "description": "Ano final pedido", + "type": "number" + }, + "start": { + "description": "Ano inicial pedido", + "type": "number" + } + }, + "required": [ + "start", + "end" + ], + "type": "object" + }, + "population_years": { + "additionalProperties": false, + "description": "Cobertura populacional; só no erro-mole de `rate_per_10k` fora do intervalo", + "properties": { + "first_year": { + "description": "Primeiro ano com população", + "type": "number" + }, + "last_year": { + "description": "Último ano com população", + "type": "number" + } + }, + "required": [ + "first_year", + "last_year" + ], + "type": "object" + }, + "provenance": { + "description": "Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem", + "items": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "type": "array" + }, + "series": { + "description": "Pontos em ordem cronológica", + "items": { + "additionalProperties": { + "description": "Valor do indicador para esta UF, grupo ou `total`", + "type": "number" + }, + "description": "Um ponto por ano: `year` mais uma chave por valor comparado (UF, grupo ou `total`) com o indicador", + "properties": { + "year": { + "description": "Ano", + "type": "number" + } + }, + "required": [ + "year" + ], + "type": "object" + }, + "type": "array" + }, + "summary": { + "additionalProperties": false, + "properties": { + "best_performer": { + "description": "Valor comparado com a melhor evolução; só com mais de uma tendência", + "type": "string" + }, + "note": { + "description": "Como ler o indicador; só para `percentage`", + "type": "string" + }, + "worst_performer": { + "description": "Valor comparado com a pior evolução; só com mais de uma tendência", + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "trends": { + "additionalProperties": { + "additionalProperties": false, + "properties": { + "avg_annual_change": { + "description": "Variação média anual", + "type": "number" + }, + "change_pct": { + "description": "Variação relativa entre as pontas, %", + "type": "number" + }, + "direction": { + "description": "Sentido da tendência", + "enum": [ + "increasing", + "decreasing", + "stable" + ] + }, + "end_value": { + "description": "Valor no último ano", + "type": "number" + }, + "slope": { + "description": "Inclinação da regressão linear (indicador por ano)", + "type": "number" + }, + "start_value": { + "description": "Valor no primeiro ano", + "type": "number" + } + }, + "required": [ + "slope", + "direction", + "avg_annual_change", + "start_value", + "end_value", + "change_pct" + ], + "type": "object" + }, + "description": "Tendência por valor comparado; só com `include_trend_line` e ao menos dois anos — ausente quando desligada", + "type": "object" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
compare_regions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "compare_by", + "metric", + "ranking", + "total_locations" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Ranking de UFs por internações ou óbitos; `error` quando nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "compare_by": { + "description": "Eixo da comparação (hoje ambos agrupam por UF)", + "enum": [ + "uf", + "region" + ] + }, + "data": { + "description": "Sempre vazio: só aparece no caminho de erro-mole do funil", + "items": {}, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "metric": { + "description": "Métrica que ordena o ranking", + "enum": [ + "n", + "deaths" + ] + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "ranking": { + "description": "Ranking em ordem decrescente da métrica", + "items": { + "additionalProperties": false, + "properties": { + "deaths": { + "description": "Óbitos", + "type": "number" + }, + "mortality_rate": { + "description": "Óbitos / internações × 100, duas casas", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações", + "type": "number" + }, + "rank": { + "description": "Posição, 1 = maior", + "type": "number" + }, + "uf": { + "description": "UF", + "type": "string" + } + }, + "required": [ + "rank", + "uf", + "n_hospitalizations", + "deaths", + "mortality_rate" + ], + "type": "object" + }, + "type": "array" + }, + "total_locations": { + "description": "Quantas localidades no ranking", + "type": "number" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_available_years1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "years", + "data_range", + "note", + "race_available", + "years_without_race", + "cid_revision", + "years_cid9", + "icsap_available", + "icsap_list_revision", + "uf_basis", + "years_uf_arquivo", + "municipality_available", + "currency", + "records_date_imputed", + "csap_universe", + "population_years", + "cubes_channel", + "freshness" + ] + }, + { + "required": [ + "error", + "years" + ] + } + ], + "description": "Anos com cubo local, o que cada ano carrega (revisão da CID, raça/cor, município, moeda, universo ICSAP), cobertura da população, canal de cubos e frescor", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "cid_revision": { + "additionalProperties": { + "additionalProperties": { + "description": "Internações naquela revisão; null quando o sidecar não traz o total", + "type": [ + "number", + "null" + ] + }, + "description": "Revisão da CID (\"9\" ou \"10\") → internações", + "type": "object" + }, + "description": "Internações por revisão da CID — chave é o ano (string)", + "type": "object" + }, + "csap_universe": { + "additionalProperties": { + "additionalProperties": false, + "description": "Universo do % ICSAP como o csapAIH; null em cubo anterior ao builder 2.6.0", + "properties": { + "excluded": { + "additionalProperties": { + "description": "Internações fora do universo por este motivo", + "type": "number" + }, + "description": "Motivo de exclusão → internações", + "type": "object" + }, + "method": { + "description": "Método (csapAIH)", + "type": "string" + }, + "records_in_universe": { + "description": "Internações dentro do universo", + "type": [ + "number", + "null" + ] + } + }, + "required": [ + "method", + "records_in_universe", + "excluded" + ], + "type": [ + "object", + "null" + ] + }, + "description": "Universo do % ICSAP — chave é o ano (string)", + "type": "object" + }, + "cubes_channel": { + "additionalProperties": false, + "description": "Canal público dos cubos e cache local", + "properties": { + "base_url": { + "description": "URL do canal público de cubos", + "type": "string" + }, + "cache_dir": { + "description": "Pasta do cache local; null quando desligado", + "type": [ + "string", + "null" + ] + }, + "enabled": { + "description": "false quando o cache de cubos está desligado", + "type": "boolean" + }, + "manifest_generated_at": { + "description": "Quando o manifesto foi gerado; null sem manifesto", + "type": [ + "string", + "null" + ] + }, + "manifest_source": { + "description": "De onde veio o manifesto", + "enum": [ + "remote", + "disk", + "none", + "disabled" + ] + }, + "note": { + "description": "Como o cache baixa os anos pedidos", + "type": "string" + }, + "published_years": { + "description": "Anos publicados no manifesto do canal", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "base_url", + "published_years", + "cache_dir", + "manifest_source" + ], + "type": "object" + }, + "currency": { + "additionalProperties": { + "description": "Moeda de `value` por competência; null quando o sidecar não informa", + "items": { + "additionalProperties": false, + "properties": { + "code": { + "description": "Código ISO 4217 (BRE, BRR, BRL)", + "type": "string" + }, + "from": { + "description": "Primeira competência (AAAA-MM)", + "type": "string" + }, + "name": { + "description": "Nome da moeda", + "type": "string" + }, + "symbol": { + "description": "Símbolo (Cr$, CR$, R$)", + "type": "string" + }, + "to": { + "description": "Última competência (AAAA-MM)", + "type": "string" + } + }, + "required": [ + "from", + "to", + "code", + "symbol", + "name" + ], + "type": "object" + }, + "type": [ + "array", + "null" + ] + }, + "description": "Moeda de `value` — chave é o ano (string)", + "type": "object" + }, + "data_range": { + "additionalProperties": false, + "description": "Intervalo dos anos locais", + "properties": { + "first_year": { + "description": "Primeiro ano local; ausente quando não há cubo", + "type": "number" + }, + "last_year": { + "description": "Último ano local; ausente quando não há cubo", + "type": "number" + }, + "total_years": { + "description": "Quantos anos", + "type": "number" + } + }, + "required": [ + "total_years" + ], + "type": "object" + }, + "error": { + "description": "Falha ao listar os anos", + "type": "string" + }, + "freshness": { + "additionalProperties": false, + "description": "Frescor dos cubos locais frente ao espelho healthbr-data", + "properties": { + "checked_at": { + "description": "Instante (UTC) da última checagem; null se nunca terminou", + "type": [ + "string", + "null" + ] + }, + "cubes": { + "description": "Cubos atrasados frente ao espelho", + "items": { + "additionalProperties": false, + "properties": { + "behind": { + "description": "true quando alguma lista acima tem item", + "type": "boolean" + }, + "cube_year": { + "description": "Ano do cubo", + "type": "number" + }, + "new_in_window": { + "description": "Competências publicadas depois do build", + "items": { + "type": "string" + }, + "type": "array" + }, + "reedited": { + "description": "Partições cujo .dbc de origem mudou (reedição do MS)", + "items": { + "type": "string" + }, + "type": "array" + }, + "removed": { + "description": "Partições que saíram do manifesto", + "items": { + "type": "string" + }, + "type": "array" + }, + "reprocessed": { + "description": "Partições regeneradas pelo espelho", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "cube_year", + "reedited", + "reprocessed", + "removed", + "new_in_window", + "behind" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Erro da checagem; null quando não houve", + "type": [ + "string", + "null" + ] + }, + "manifest_last_updated_local": { + "description": "Manifesto com que os cubos foram gerados", + "type": [ + "string", + "null" + ] + }, + "manifest_last_updated_remote": { + "description": "Manifesto público lido agora", + "type": [ + "string", + "null" + ] + }, + "manifest_url": { + "description": "URL do manifesto do espelho", + "type": [ + "string", + "null" + ] + }, + "method": { + "description": "Como checou: sonda parcial ou manifesto inteiro", + "enum": [ + "range", + "full", + null + ] + }, + "status": { + "description": "Frescor dos cubos frente ao espelho", + "enum": [ + "disabled", + "pending", + "current", + "stale", + "unknown" + ] + } + }, + "required": [ + "status", + "checked_at", + "method", + "manifest_url", + "manifest_last_updated_local", + "manifest_last_updated_remote", + "cubes", + "error" + ], + "type": "object" + }, + "icsap_available": { + "additionalProperties": { + "description": "true quando o cubo tem a marcação ICSAP", + "type": "boolean" + }, + "description": "ICSAP disponível — chave é o ano (string)", + "type": "object" + }, + "icsap_list_revision": { + "additionalProperties": { + "additionalProperties": { + "description": "Lista usada (portaria-221-2008 ou cid9-derivada)", + "type": "string" + }, + "description": "Revisão → lista", + "type": "object" + }, + "description": "Lista ICSAP por revisão da CID — chave é o ano (string)", + "type": "object" + }, + "municipality_available": { + "additionalProperties": { + "description": "false quando `municipality_code` é nulo em todas as linhas", + "type": "boolean" + }, + "description": "Município disponível — chave é o ano (string)", + "type": "object" + }, + "note": { + "description": "Aviso sobre o que `years` significa", + "type": "string" + }, + "population_years": { + "additionalProperties": false, + "description": "Cobertura dos arquivos de população por UF: o que as ferramentas de taxa aceitam", + "properties": { + "aggregated": { + "additionalProperties": false, + "description": "pop_uf_agregado.parquet — faixa etária quinquenal por UF e sexo (1991–1999)", + "properties": { + "age": { + "description": "Grão etário do arquivo", + "type": "string" + }, + "age_groups": { + "description": "Faixas etárias quinquenais (só no arquivo agregado)", + "items": { + "type": "string" + }, + "type": "array" + }, + "first_year": { + "description": "Primeiro ano coberto", + "type": "number" + }, + "last_year": { + "description": "Último ano coberto", + "type": "number" + }, + "source": { + "description": "Arquivo parquet que serve o intervalo", + "type": "string" + } + }, + "required": [ + "first_year", + "last_year", + "source", + "age" + ], + "type": [ + "object", + "null" + ] + }, + "detailed": { + "additionalProperties": false, + "description": "pop_uf.parquet — idade simples por UF e sexo (projeções IBGE, 2000+)", + "properties": { + "age": { + "description": "Grão etário do arquivo", + "type": "string" + }, + "age_groups": { + "description": "Faixas etárias quinquenais (só no arquivo agregado)", + "items": { + "type": "string" + }, + "type": "array" + }, + "first_year": { + "description": "Primeiro ano coberto", + "type": "number" + }, + "last_year": { + "description": "Último ano coberto", + "type": "number" + }, + "source": { + "description": "Arquivo parquet que serve o intervalo", + "type": "string" + } + }, + "required": [ + "first_year", + "last_year", + "source", + "age" + ], + "type": [ + "object", + "null" + ] + }, + "first_year": { + "description": "Primeiro ano com população por UF (união dos dois arquivos)", + "type": "number" + }, + "last_year": { + "description": "Último ano com população por UF", + "type": "number" + } + }, + "required": [ + "first_year", + "last_year", + "detailed", + "aggregated" + ], + "type": [ + "object", + "null" + ] + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "race_available": { + "additionalProperties": { + "description": "true quando o cubo tem raça/cor", + "type": "boolean" + }, + "description": "Raça/cor disponível — chave é o ano (string)", + "type": "object" + }, + "records_date_imputed": { + "additionalProperties": { + "description": "Internações que entraram com data imputada", + "type": "number" + }, + "description": "Datas imputadas — chave é o ano (string)", + "type": "object" + }, + "uf_basis": { + "additionalProperties": { + "description": "Base do eixo `uf`", + "enum": [ + "residencia", + "arquivo" + ] + }, + "description": "Base do eixo `uf` — chave é o ano (string)", + "type": "object" + }, + "years": { + "description": "Anos com cubos Parquet presentes localmente", + "items": { + "type": "number" + }, + "type": "array" + }, + "years_cid9": { + "description": "Anos em que o cubo usa CID-9 (1992–1997)", + "items": { + "type": "number" + }, + "type": "array" + }, + "years_uf_arquivo": { + "description": "Anos em que `uf` é a do estabelecimento (1992–1997)", + "items": { + "type": "number" + }, + "type": "array" + }, + "years_without_race": { + "description": "Anos sem raça/cor (1998–2007)", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_hospitalization_rates1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "data", + "summary", + "metadata" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Taxa de internação por população (IBGE por UF), bruta ou específica; `error` quando o ano está fora da cobertura populacional ou nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "data": { + "description": "Um estrato por linha (vazio quando não há internação no recorte)", + "items": { + "additionalProperties": false, + "properties": { + "deaths": { + "description": "Óbitos", + "type": "number" + }, + "mortality_rate": { + "description": "Óbitos / internações × 100, duas casas", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações", + "type": "number" + }, + "population": { + "description": "População do estrato (denominador)", + "type": "number" + }, + "population_source": { + "description": "Arquivo de população que serviu o ano", + "enum": [ + "detailed", + "aggregated", + null + ] + }, + "rate_per": { + "description": "Base da taxa (1000, 10000 ou 100000)", + "type": "number" + }, + "rate_per_100k": { + "description": "Internações por `rate_per` habitantes (o nome do campo é histórico; a base está em `rate_per`)", + "type": "number" + }, + "uf": { + "description": "UF (quando agrupado por UF ou mais de uma UF)", + "type": "string" + }, + "year": { + "description": "Ano (quando agrupado por ano ou mais de um ano)", + "type": "number" + } + }, + "required": [ + "n_hospitalizations", + "deaths", + "population", + "rate_per_100k", + "rate_per", + "population_source", + "mortality_rate" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "metadata": { + "additionalProperties": false, + "properties": { + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "filters_applied": { + "additionalProperties": false, + "description": "Os argumentos, com UFs normalizadas e só os anos atendidos", + "properties": { + "age_max": { + "description": "Idade máxima", + "type": "integer" + }, + "age_min": { + "description": "Idade mínima", + "type": "integer" + }, + "cid_chapter": { + "description": "Capítulos CID-10 (1-22)", + "items": { + "type": "integer" + }, + "type": "array" + }, + "group_by": { + "description": "Dimensões para agrupamento", + "items": { + "enum": [ + "year", + "uf", + "sex" + ], + "type": "string" + }, + "type": "array" + }, + "is_csap": { + "description": "Filtrar apenas CSAP", + "type": "boolean" + }, + "rate_per": { + "description": "Taxa por X habitantes (default: 100000)", + "enum": [ + 1000, + 10000, + 100000 + ], + "type": "integer" + }, + "rate_type": { + "description": "Tipo de taxa: crude (bruta) ou specific (específica por filtro)", + "enum": [ + "crude", + "specific" + ], + "type": "string" + }, + "sex": { + "description": "Filtrar por sexo", + "enum": [ + "M", + "F" + ], + "type": "string" + }, + "uf": { + "description": "UFs para filtrar", + "items": { + "type": "string" + }, + "type": "array" + }, + "year": { + "description": "Anos para calcular", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "note": { + "description": "Presente quando nenhuma internação casou o recorte", + "type": "string" + }, + "population_notes": { + "description": "Avisos sobre o denominador (faixa quinquenal antes de 2000; mistura de fontes)", + "items": { + "type": "string" + }, + "type": "array" + }, + "population_source": { + "additionalProperties": { + "description": "Arquivo que serviu o ano", + "enum": [ + "detailed", + "aggregated", + null + ] + }, + "description": "Fonte da população — chave é o ano (string)", + "type": "object" + } + }, + "required": [ + "population_source", + "filters_applied" + ], + "type": "object" + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "population_years": { + "additionalProperties": false, + "description": "Cobertura dos arquivos de população por UF: o que as ferramentas de taxa aceitam", + "properties": { + "aggregated": { + "additionalProperties": false, + "description": "pop_uf_agregado.parquet — faixa etária quinquenal por UF e sexo (1991–1999)", + "properties": { + "age": { + "description": "Grão etário do arquivo", + "type": "string" + }, + "age_groups": { + "description": "Faixas etárias quinquenais (só no arquivo agregado)", + "items": { + "type": "string" + }, + "type": "array" + }, + "first_year": { + "description": "Primeiro ano coberto", + "type": "number" + }, + "last_year": { + "description": "Último ano coberto", + "type": "number" + }, + "source": { + "description": "Arquivo parquet que serve o intervalo", + "type": "string" + } + }, + "required": [ + "first_year", + "last_year", + "source", + "age" + ], + "type": [ + "object", + "null" + ] + }, + "detailed": { + "additionalProperties": false, + "description": "pop_uf.parquet — idade simples por UF e sexo (projeções IBGE, 2000+)", + "properties": { + "age": { + "description": "Grão etário do arquivo", + "type": "string" + }, + "age_groups": { + "description": "Faixas etárias quinquenais (só no arquivo agregado)", + "items": { + "type": "string" + }, + "type": "array" + }, + "first_year": { + "description": "Primeiro ano coberto", + "type": "number" + }, + "last_year": { + "description": "Último ano coberto", + "type": "number" + }, + "source": { + "description": "Arquivo parquet que serve o intervalo", + "type": "string" + } + }, + "required": [ + "first_year", + "last_year", + "source", + "age" + ], + "type": [ + "object", + "null" + ] + }, + "first_year": { + "description": "Primeiro ano com população por UF (união dos dois arquivos)", + "type": "number" + }, + "last_year": { + "description": "Último ano com população por UF", + "type": "number" + } + }, + "required": [ + "first_year", + "last_year", + "detailed", + "aggregated" + ], + "type": "object" + }, + "provenance": { + "description": "Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem", + "items": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "type": "array" + }, + "summary": { + "additionalProperties": false, + "properties": { + "overall_rate": { + "description": "Taxa do conjunto, na base `rate_per`", + "type": "number" + }, + "rate_per": { + "description": "Base da taxa", + "type": "number" + }, + "rate_type": { + "description": "Bruta ou específica", + "enum": [ + "crude", + "specific" + ] + }, + "total_hospitalizations": { + "description": "Internações somadas", + "type": "number" + }, + "total_population": { + "description": "População somada", + "type": "number" + } + }, + "required": [ + "total_hospitalizations", + "total_population", + "overall_rate", + "rate_per", + "rate_type" + ], + "type": "object" + }, + "truncated": { + "additionalProperties": false, + "description": "Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro", + "properties": { + "returned": { + "description": "Linhas devolvidas (o teto)", + "type": "number" + }, + "total": { + "description": "Linhas que a consulta produziu", + "type": "number" + } + }, + "required": [ + "returned", + "total" + ], + "type": "object" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_hospitalization_trends1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "granularity", + "period", + "series" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Série temporal de internações, anual (`year`) ou mensal (`year_month`); `error` quando nenhum ano do intervalo tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "data": { + "description": "Sempre vazio: só aparece no caminho de erro-mole do funil", + "items": {}, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "granularity": { + "description": "Grão da série", + "enum": [ + "yearly", + "monthly" + ] + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "period": { + "additionalProperties": false, + "description": "Intervalo pedido", + "properties": { + "end": { + "description": "Ano (anual) ou AAAA-MM (mensal) final", + "type": [ + "number", + "string" + ] + }, + "start": { + "description": "Ano (anual) ou AAAA-MM (mensal) inicial", + "type": [ + "number", + "string" + ] + } + }, + "required": [ + "start", + "end" + ], + "type": "object" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "series": { + "description": "Um ponto por ano ou por mês, em ordem cronológica", + "items": { + "anyOf": [ + { + "additionalProperties": false, + "description": "Ponto anual", + "properties": { + "deaths": { + "description": "Óbitos no ano", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações no ano", + "type": "number" + }, + "year": { + "description": "Ano", + "type": "number" + } + }, + "required": [ + "year", + "n_hospitalizations", + "deaths" + ], + "type": "object" + }, + { + "additionalProperties": false, + "description": "Ponto mensal", + "properties": { + "deaths": { + "description": "Óbitos no mês", + "type": "number" + }, + "n": { + "description": "Internações no mês", + "type": "number" + }, + "year_month": { + "description": "Competência AAAA-MM", + "type": "string" + } + }, + "required": [ + "year_month", + "n", + "deaths" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_hospitalizations1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "data", + "summary", + "filters_applied" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Internações do cubo de causas, agrupadas conforme `group_by`, com totais do recorte inteiro; `error` quando nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "data": { + "description": "Linhas agrupadas (vazio no caminho de erro-mole)", + "items": { + "additionalProperties": false, + "description": "Uma linha por combinação de `group_by` (só as colunas pedidas aparecem)", + "properties": { + "age": { + "description": "Idade em anos (group_by: age)", + "type": "number" + }, + "cid_chapter": { + "description": "Capítulo da CID, 1–22 (group_by: cid_chapter)", + "type": "number" + }, + "cid_group": { + "description": "Categoria CID de 3 dígitos (group_by: cid_group)", + "type": "string" + }, + "cid_revision": { + "description": "Revisão da CID do diagnóstico: 9 ou 10 (group_by: cid_revision)", + "type": "number" + }, + "csap_group": { + "description": "Grupo CSAP g01–g19; null quando a internação não é sensível (group_by: csap_group)", + "type": [ + "string", + "null" + ] + }, + "deaths": { + "description": "Óbitos; null quando o recorte não tem nenhuma linha", + "type": [ + "number", + "null" + ] + }, + "exclusion": { + "description": "Motivo de exclusão do universo csapAIH; null quando dentro do universo (group_by: exclusion)", + "type": [ + "string", + "null" + ] + }, + "is_csap": { + "description": "Internação por condição sensível à atenção primária (group_by: is_csap)", + "type": "boolean" + }, + "month": { + "description": "Mês, 1–12 (group_by: month)", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações; null quando o recorte não tem nenhuma linha", + "type": [ + "number", + "null" + ] + }, + "race": { + "description": "Raça/cor; null em 1998–2007, quando a AIH não trazia o campo (group_by: race)", + "type": [ + "string", + "null" + ] + }, + "sex": { + "description": "Sexo: M ou F (group_by: sex)", + "type": "string" + }, + "total_days": { + "description": "Dias de permanência; null quando o recorte não tem nenhuma linha", + "type": [ + "number", + "null" + ] + }, + "total_value": { + "description": "Valor total pago (R$); null quando o recorte não tem nenhuma linha", + "type": [ + "number", + "null" + ] + }, + "uf": { + "description": "UF de residência — do estabelecimento em 1992–1997 (group_by: uf)", + "type": "string" + }, + "year": { + "description": "Ano (group_by: year)", + "type": "number" + } + }, + "required": [ + "n_hospitalizations", + "total_days", + "total_value", + "deaths" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "filters_applied": { + "additionalProperties": false, + "description": "Os argumentos recebidos, ecoados", + "properties": { + "age_max": { + "description": "Idade máxima em anos", + "type": "integer" + }, + "age_min": { + "description": "Idade mínima em anos", + "type": "integer" + }, + "cid_chapter": { + "description": "Capítulos CID-10 (1-22). Se omitido, todos.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "group_by": { + "description": "Dimensões para agrupamento", + "items": { + "enum": [ + "year", + "month", + "uf", + "cid_chapter", + "cid_revision", + "cid_group", + "sex", + "age", + "race", + "exclusion", + "is_csap", + "csap_group" + ], + "type": "string" + }, + "type": "array" + }, + "is_csap": { + "description": "Filtrar apenas CSAP (true) ou não-CSAP (false)", + "type": "boolean" + }, + "limit": { + "description": "Limitar número de resultados", + "type": "integer" + }, + "month": { + "description": "Meses (1-12). Se omitido, todos.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "race": { + "description": "Raça/cor (branca, preta, parda, amarela, indigena, ignorado). Só existe de 2008 em diante: em 1998–2007 race é nulo e o filtro não alcança esses anos.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sex": { + "description": "Filtrar por sexo", + "enum": [ + "M", + "F" + ], + "type": "string" + }, + "uf": { + "description": "Lista de UFs (ex: ['SP', 'RJ']). Se omitido, todas.", + "items": { + "type": "string" + }, + "type": "array" + }, + "year": { + "description": "Anos para consultar (ex: [2023, 2024]); série de 1992 em diante", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "summary": { + "additionalProperties": false, + "description": "Totais do recorte inteiro (não do trecho devolvido, quando truncado)", + "properties": { + "deaths": { + "description": "Óbitos", + "type": "number" + }, + "hospital_mortality_rate": { + "description": "Óbitos / internações × 100, duas casas", + "type": "number" + }, + "records_returned": { + "description": "Linhas em `data`", + "type": "number" + }, + "total_days": { + "description": "Dias de permanência", + "type": "number" + }, + "total_hospitalizations": { + "description": "Internações no recorte inteiro", + "type": "number" + }, + "total_value": { + "description": "Valor pago (R$), duas casas", + "type": "number" + } + }, + "required": [ + "total_hospitalizations", + "total_days", + "total_value", + "deaths", + "hospital_mortality_rate", + "records_returned" + ], + "type": "object" + }, + "truncated": { + "additionalProperties": false, + "description": "Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro", + "properties": { + "returned": { + "description": "Linhas devolvidas (o teto)", + "type": "number" + }, + "total": { + "description": "Linhas que a consulta produziu", + "type": "number" + } + }, + "required": [ + "returned", + "total" + ], + "type": "object" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_icsap1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "data", + "notes", + "summary", + "filters_applied" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Internações por condições sensíveis à atenção primária, agrupadas conforme `group_by`, com totais e a nota do universo; `error` quando nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "data": { + "description": "Linhas agrupadas (vazio no caminho de erro-mole)", + "items": { + "additionalProperties": false, + "description": "Uma linha por combinação de `group_by` (só as colunas pedidas aparecem)", + "properties": { + "age": { + "description": "Idade em anos (group_by: age)", + "type": "number" + }, + "cid_revision": { + "description": "Revisão da CID: 9 ou 10 (group_by: cid_revision)", + "type": "number" + }, + "csap_group": { + "description": "Grupo CSAP g01–g19 (group_by: csap_group)", + "type": [ + "string", + "null" + ] + }, + "deaths": { + "description": "Óbitos nas ICSAP", + "type": "number" + }, + "icsap_percentage": { + "description": "n_icsap / n_total × 100, duas casas", + "type": "number" + }, + "municipality_code": { + "description": "Código IBGE do município de residência (6 dígitos); null em 1992–1997 (group_by: municipality_code)", + "type": [ + "string", + "null" + ] + }, + "n_icsap": { + "description": "Internações por condições sensíveis à atenção primária no universo escolhido", + "type": "number" + }, + "n_total": { + "description": "Total de internações no universo escolhido (denominador)", + "type": "number" + }, + "race": { + "description": "Raça/cor; null em 1998–2007 (group_by: race)", + "type": [ + "string", + "null" + ] + }, + "sex": { + "description": "Sexo: M ou F (group_by: sex)", + "type": "string" + }, + "total_days": { + "description": "Dias de permanência das ICSAP", + "type": "number" + }, + "total_value": { + "description": "Valor pago das ICSAP (R$)", + "type": "number" + }, + "uf": { + "description": "UF de residência — do estabelecimento em 1992–1997 (group_by: uf)", + "type": "string" + }, + "year": { + "description": "Ano (group_by: year)", + "type": "number" + } + }, + "required": [ + "n_icsap", + "n_total", + "icsap_percentage", + "total_days", + "total_value", + "deaths" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "filters_applied": { + "additionalProperties": false, + "description": "Os argumentos recebidos, ecoados", + "properties": { + "age_max": { + "description": "Idade máxima", + "type": "integer" + }, + "age_min": { + "description": "Idade mínima", + "type": "integer" + }, + "csap_group": { + "description": "Grupos CSAP (ex: ['g01', 'g05'])", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_by": { + "description": "Dimensões para agrupamento", + "items": { + "enum": [ + "year", + "uf", + "municipality_code", + "cid_revision", + "csap_group", + "sex", + "age", + "race" + ], + "type": "string" + }, + "type": "array" + }, + "municipality_code": { + "description": "Código IBGE do município (6 dígitos)", + "type": "string" + }, + "race": { + "description": "Raça/cor (branca, preta, parda, amarela, indigena, ignorado). Só existe de 2008 em diante: em 1998–2007 race é nulo e o filtro não alcança esses anos.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sex": { + "description": "Filtrar por sexo", + "enum": [ + "M", + "F" + ], + "type": "string" + }, + "uf": { + "description": "UFs para filtrar", + "items": { + "type": "string" + }, + "type": "array" + }, + "universe": { + "description": "Universo do % ICSAP: 'csapaih' (padrão) tira do numerador e do denominador as internações por procedimento obstétrico, com diagnóstico de parto (O80-O84) e as AIH de longa permanência, como o pacote R csapAIH (Nedel); 'all' conta todas as internações.", + "enum": [ + "csapaih", + "all" + ], + "type": "string" + }, + "year": { + "description": "Anos para consultar", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "provenance": { + "description": "Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem", + "items": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "type": "array" + }, + "summary": { + "additionalProperties": false, + "description": "Totais do recorte inteiro, calculados sem agrupamento", + "properties": { + "deaths": { + "description": "Óbitos nas ICSAP", + "type": "number" + }, + "icsap_percentage": { + "description": "total_icsap / total_hospitalizations × 100, duas casas", + "type": "number" + }, + "records_returned": { + "description": "Linhas em `data`", + "type": "number" + }, + "total_days": { + "description": "Dias de permanência das ICSAP", + "type": "number" + }, + "total_hospitalizations": { + "description": "Internações no universo (denominador)", + "type": "number" + }, + "total_icsap": { + "description": "ICSAP no recorte inteiro", + "type": "number" + }, + "total_value": { + "description": "Valor pago das ICSAP (R$)", + "type": "number" + } + }, + "required": [ + "total_icsap", + "total_hospitalizations", + "icsap_percentage", + "total_days", + "total_value", + "deaths", + "records_returned" + ], + "type": "object" + }, + "truncated": { + "additionalProperties": false, + "description": "Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro", + "properties": { + "returned": { + "description": "Linhas devolvidas (o teto)", + "type": "number" + }, + "total": { + "description": "Linhas que a consulta produziu", + "type": "number" + } + }, + "required": [ + "returned", + "total" + ], + "type": "object" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
get_icsap_indicators1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "data", + "notes", + "indicators_calculated", + "note" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Percentual de ICSAP por estrato de `group_by`, com a fórmula e a nota do universo; `error` quando nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "data": { + "description": "Um estrato por linha (vazio no caminho de erro-mole)", + "items": { + "additionalProperties": false, + "description": "Uma linha por combinação de `group_by` (só as colunas pedidas aparecem)", + "properties": { + "age": { + "description": "Idade em anos (group_by: age)", + "type": "number" + }, + "cid_revision": { + "description": "Revisão da CID: 9 ou 10 (group_by: cid_revision)", + "type": "number" + }, + "csap_group": { + "description": "Grupo CSAP g01–g19 (group_by: csap_group)", + "type": [ + "string", + "null" + ] + }, + "deaths": { + "description": "Óbitos nas ICSAP", + "type": "number" + }, + "icsap_percentage": { + "description": "n_icsap / n_total × 100, duas casas", + "type": "number" + }, + "municipality_code": { + "description": "Código IBGE do município de residência (6 dígitos); null em 1992–1997 (group_by: municipality_code)", + "type": [ + "string", + "null" + ] + }, + "n_icsap": { + "description": "Internações por condições sensíveis à atenção primária no universo escolhido", + "type": "number" + }, + "n_total": { + "description": "Total de internações no universo escolhido (denominador)", + "type": "number" + }, + "race": { + "description": "Raça/cor; null em 1998–2007 (group_by: race)", + "type": [ + "string", + "null" + ] + }, + "sex": { + "description": "Sexo: M ou F (group_by: sex)", + "type": "string" + }, + "total_days": { + "description": "Dias de permanência das ICSAP", + "type": "number" + }, + "total_value": { + "description": "Valor pago das ICSAP (R$)", + "type": "number" + }, + "uf": { + "description": "UF de residência — do estabelecimento em 1992–1997 (group_by: uf)", + "type": "string" + }, + "year": { + "description": "Ano (group_by: year)", + "type": "number" + } + }, + "required": [ + "n_icsap", + "n_total", + "icsap_percentage", + "total_days", + "total_value", + "deaths" + ], + "type": "object" + }, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "indicators_calculated": { + "description": "Indicadores presentes nas linhas (icsap_percentage)", + "items": { + "type": "string" + }, + "type": "array" + }, + "note": { + "description": "Fórmula do indicador — ou, no caminho de erro-mole, como obter o dado", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "provenance": { + "description": "Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem", + "items": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "type": "array" + }, + "truncated": { + "additionalProperties": false, + "description": "Presente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro", + "properties": { + "returned": { + "description": "Linhas devolvidas (o teto)", + "type": "number" + }, + "total": { + "description": "Linhas que a consulta produziu", + "type": "number" + } + }, + "required": [ + "returned", + "total" + ], + "type": "object" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
list_cid_chapters1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "total_chapters", + "chapters" + ] + } + ], + "description": "Os 22 capítulos da CID-10 (versão 2019), com intervalo de códigos e nomes", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "chapters": { + "description": "Os capítulos, na ordem da CID", + "items": { + "additionalProperties": false, + "properties": { + "code": { + "description": "Capítulo em algarismo romano (chave usada em `cid_chapter` é o número, 1–22)", + "type": "string" + }, + "name_en": { + "description": "Nome em inglês", + "type": "string" + }, + "name_pt": { + "description": "Nome em português", + "type": "string" + }, + "range": { + "description": "Intervalo de códigos CID-10 (ex.: A00-B99)", + "type": "string" + }, + "roman": { + "description": "Capítulo em algarismo romano", + "type": "string" + } + }, + "required": [ + "code", + "roman", + "range", + "name_pt", + "name_en" + ], + "type": "object" + }, + "type": "array" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "total_chapters": { + "description": "Número de capítulos (22)", + "type": "number" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
list_csap_groups1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "total_groups", + "source", + "groups" + ] + }, + { + "required": [ + "group" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Os 19 grupos CSAP (lista completa) ou um grupo só, quando `group_code` é informado; `error` quando o código não existe", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "error": { + "description": "Grupo CSAP não encontrado", + "type": "string" + }, + "group": { + "additionalProperties": false, + "description": "O grupo pedido por `group_code`", + "properties": { + "cid_codes": { + "description": "Todos os códigos CID-10 do grupo; só com `include_cid_codes: true`", + "items": { + "type": "string" + }, + "type": "array" + }, + "code": { + "description": "Código do grupo, g01–g19", + "type": "string" + }, + "diagnoses": { + "description": "Diagnósticos que compõem o grupo, com seus códigos", + "items": { + "additionalProperties": false, + "properties": { + "cid10": { + "description": "Códigos CID-10 do diagnóstico", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Diagnóstico", + "type": "string" + } + }, + "required": [ + "name", + "cid10" + ], + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "Número do grupo na Portaria, 1–19", + "type": "number" + }, + "name_en": { + "description": "Nome em inglês", + "type": "string" + }, + "name_pt": { + "description": "Nome em português", + "type": "string" + } + }, + "required": [ + "id", + "code", + "name_pt", + "name_en", + "diagnoses" + ], + "type": "object" + }, + "groups": { + "description": "Os 19 grupos, na ordem da Portaria", + "items": { + "additionalProperties": false, + "properties": { + "cid_codes": { + "description": "Códigos CID-10 do grupo; só com `include_cid_codes: true`", + "items": { + "type": "string" + }, + "type": "array" + }, + "cid_count": { + "description": "Quantos códigos CID-10 compõem o grupo", + "type": "number" + }, + "code": { + "description": "Código do grupo, g01–g19", + "type": "string" + }, + "name": { + "description": "Nome do grupo em português", + "type": "string" + } + }, + "required": [ + "code", + "name", + "cid_count" + ], + "type": "object" + }, + "type": "array" + }, + "provenance": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "source": { + "description": "Norma que define a lista (Portaria MS/SAS 221/2008)", + "type": "string" + }, + "total_groups": { + "description": "Número de grupos na lista (19)", + "type": "number" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
- Changed
rank_csap_groups1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "metric", + "ranking", + "notes", + "concentration", + "total_groups" + ] + }, + { + "required": [ + "error" + ] + } + ], + "description": "Os grupos CSAP ordenados pela métrica, com participação de cada um e concentração nos primeiros; `error` quando nenhum ano pedido tem dado", + "properties": { + "attribution": { + "description": "URLs canônicas das fontes desta resposta (lista de atribuição)", + "items": { + "type": "string" + }, + "type": "array" + }, + "available_sih_years": { + "description": "Anos com dados SIH atendíveis por este servidor", + "items": { + "type": "number" + }, + "type": "array" + }, + "concentration": { + "additionalProperties": false, + "properties": { + "top_3_percentage": { + "description": "Soma da participação dos 3 primeiros, %", + "type": "number" + }, + "top_5_percentage": { + "description": "Soma dos 5 primeiros, %", + "type": "number" + } + }, + "required": [ + "top_3_percentage", + "top_5_percentage" + ], + "type": "object" + }, + "data": { + "description": "Sempre vazio: só aparece no caminho de erro-mole do funil", + "items": {}, + "type": "array" + }, + "error": { + "description": "Motivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)", + "type": "string" + }, + "metric": { + "description": "Métrica que ordena", + "enum": [ + "n", + "days", + "value", + "deaths" + ] + }, + "note": { + "description": "Como obter o dado (por exemplo, consultar get_available_years)", + "type": "string" + }, + "notes": { + "description": "Avisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento", + "items": { + "type": "string" + }, + "type": "array" + }, + "provenance": { + "description": "Um bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem", + "items": { + "additionalProperties": false, + "description": "Bloco de proveniência (contrato v1.0): fonte, URL, competência, extração e licença", + "properties": { + "citation": { + "description": "Citação pronta para uso", + "type": "string" + }, + "data_vintage": { + "description": "Competência ou safra do dado segundo a fonte; null quando a fonte não expõe", + "type": [ + "string", + "null" + ] + }, + "license": { + "description": "Regime legal do dado (id SPDX quando há)", + "type": [ + "string", + "null" + ] + }, + "retrieved_at": { + "description": "Instante REAL da extração na origem (ISO-8601)", + "type": "string" + }, + "source": { + "description": "Fonte oficial do dado", + "type": "string" + }, + "source_url": { + "description": "URL canônica que reproduz a consulta ou localiza a fonte", + "type": "string" + } + }, + "required": [ + "source", + "source_url", + "data_vintage", + "retrieved_at", + "citation", + "license" + ], + "type": "object" + }, + "type": "array" + }, + "ranking": { + "description": "Ranking em ordem decrescente da métrica", + "items": { + "additionalProperties": false, + "properties": { + "csap_group": { + "description": "Grupo CSAP g01–g19", + "type": "string" + }, + "csap_name": { + "description": "Nome do grupo", + "type": "string" + }, + "deaths": { + "description": "Óbitos", + "type": "number" + }, + "metric_value": { + "description": "Valor da métrica escolhida", + "type": "number" + }, + "n_hospitalizations": { + "description": "Internações do grupo", + "type": "number" + }, + "pct_of_total": { + "description": "Participação do grupo no total da métrica, %", + "type": "number" + }, + "rank": { + "description": "Posição, 1 = maior", + "type": "number" + }, + "total_days": { + "description": "Dias de permanência", + "type": "number" + }, + "total_value": { + "description": "Valor pago (R$)", + "type": "number" + } + }, + "required": [ + "rank", + "csap_group", + "csap_name", + "metric_value", + "pct_of_total", + "n_hospitalizations", + "total_days", + "total_value", + "deaths" + ], + "type": "object" + }, + "type": "array" + }, + "total_groups": { + "description": "Quantos grupos no ranking", + "type": "number" + }, + "years_not_available": { + "additionalProperties": false, + "description": "Presente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos", + "properties": { + "note": { + "description": "Quais anos ficaram fora e quais os números cobrem", + "type": "string" + }, + "years": { + "description": "Anos pedidos que não têm dados SIH e ficaram fora do resultado", + "items": { + "type": "number" + }, + "type": "array" + } + }, + "required": [ + "years", + "note" + ], + "type": "object" + } + }, + "required": [ + "provenance", + "attribution" + ], + "type": "object" +}
12 tool updates
v0.15.4- Changed
classify_as_csap1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
compare_icsap_trends1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
compare_regions1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_available_years1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_hospitalization_rates1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_hospitalization_trends1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_hospitalizations1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_icsap1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
get_icsap_indicators1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
list_cid_chapters1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
list_csap_groups1 field changed- added
Input schema / additionalPropertiesAdded value: +false
- Changed
rank_csap_groups1 field changed- added
Input schema / additionalPropertiesAdded value: +false
12 tool updates
v0.12.1- First observed
classify_as_csap - First observed
compare_icsap_trends - First observed
compare_regions - First observed
get_available_years - First observed
get_hospitalization_rates - First observed
get_hospitalization_trends - First observed
get_hospitalizations - First observed
get_icsap - First observed
get_icsap_indicators - First observed
list_cid_chapters - First observed
list_csap_groups - First observed
rank_csap_groups
TDQS
Scored across 12 tools
The CSAP-vs-general split is mostly clear (get_icsap vs get_hospitalizations, get_icsap_indicators vs get_hospitalization_rates), but the analysis family overlaps heavily: compare_icsap_trends, compare_regions and get_hospitalization_trends all produce cross-UF/time comparisons, and rank_csap_groups largely duplicates a grouped get_icsap call. Descriptions are unusually detailed and do help, but an agent must read them carefully to pick the right comparison tool.
All 12 tools follow a consistent snake_case verb_noun pattern (get_, list_, compare_, rank_, classify_) with no case or style mixing. Names are predictable and readable, with the only variation being domain terminology (csap/icsap/hospitalization) rather than naming convention.
12 tools sits comfortably in the well-scoped range, covering query, aggregation, trends, rates, indicators, ranking, comparison, classification and metadata without obvious redundancy padding. Each tool corresponds to a recognizable analytical need for this dataset.
The surface covers the full analytical lifecycle for SIH-SUS/CSAP data: raw queries, aggregation, rates, indicators, trends, rankings, comparisons, CSAP classification and year/chapter/group metadata. Minor gaps remain — no geography lookup (UF/municipality codes and names) and no general CID-10 code description lookup beyond chapters, which agents will need for filter construction.
Maintenance
Related MCP Connectors
Banco Central do Brasil (Brazil's central bank) MCP. Keyless public APIs: SGS time series + Olinda…
HCUP Inpatient Stats — national hospitalization discharges, costs and outcomes by condition and…
Pay-per-call US healthcare data: hospital financials, prices, quality, exclusions, wages.
WHO GHO MCP — World Health Organization Global Health Observatory (free, no auth)
Related MCP Servers
- AlicenseAqualityFmaintenanceMCP server for Brazilian ICD-10 (CID-10) that enables search, lookup, hierarchy navigation, statistics, and validation of disease codes from official DATASUS data.66,691 npm1MIT
- AlicenseAqualityCmaintenanceMCP server for loading and querying public data from the Brazilian National Registry of Health Establishments (CNES). It enables natural language searches for health facilities by municipality, CNES code, or state, along with statistics and data loading.6MIT
- AlicenseNot gradedqualityCmaintenanceEnables natural-language querying of Brazilian public health indicators from DataSUS microdata — mortality, dengue, hospitalizations, ICSAP, and births — through 41 tools covering consultation, analysis (peer-stratum comparison, dengue endemic channel, weekly bulletin), reliability warnings, and anomaly detection. It runs locally against the public API with anti-hallucination rules so every figure comes from a tool with its source cited.MIT
- AlicenseCqualityBmaintenanceEnables users to query Brazil's public healthcare data through read-only fixed tools for hospital and outpatient activity, facility capacity, geographic signals, mortality, and reviewed rare-disease billing views. It returns reviewed aggregate views, not patient records, and includes metadata and coverage checks to interpret scope and limitations.71MIT