Skip to main content
Glama

Internações por condições sensíveis (ICSAP)

get_icsap
Read-onlyIdempotent

Query Brazilian SIH/SUS hospital admissions for primary care-sensitive conditions (ICSAP) filtered by state, municipality, sex, age, race, CSAP group, and year to analyze avoidable hospitalizations.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ufNoUFs para filtrar
sexNoFiltrar por sexo
raceNoRaç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.
yearNoAnos para consultar
age_maxNoIdade máxima
age_minNoIdade mínima
group_byNoDimensões para agrupamento
universeNoUniverso 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_groupNoGrupos CSAP (ex: ['g01', 'g05'])
municipality_codeNoCódigo IBGE do município (6 dígitos)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoLinhas agrupadas (vazio no caminho de erro-mole)
noteNoComo obter o dado (por exemplo, consultar get_available_years)
errorNoMotivo pelo qual não há dados nesta resposta (ano sem dado, cobertura populacional, falha na consulta)
notesNoAvisos que qualificam os números: era CID-9, raça/cor ausente, universo do % ICSAP, denominador populacional, truncamento
summaryNoTotais do recorte inteiro, calculados sem agrupamento
truncatedNoPresente só quando `data` foi truncado no teto de linhas; os totais em `summary` são do conjunto inteiro
provenanceYesUm bloco por procedência que contribuiu com esta resposta (SIH, lista CSAP, csapAIH, população…); licenças nunca se fundem
attributionYesURLs canônicas das fontes desta resposta (lista de atribuição)
filters_appliedNoOs argumentos recebidos, ecoados
published_yearsNoAnos 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_yearsNoAnos com dados SIH atendíveis por este servidor
years_not_availableNoPresente só quando parte dos anos pedidos não tem dado: os números cobrem apenas os anos atendidos

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.1
    • addedOutput schema / properties / published_years
      Added 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"
      +}
  2. Changed1 schema field changedv0.17.0
    • changedOutput 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"
      +}
  3. Changed1 schema field changedv0.15.4
    • addedInput schema / additionalProperties
      Added value: +false
  4. First observedv0.12.1

TDQS

A4.1/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (readOnly, idempotent, non-destructive), the description discloses notable data behaviors: race is null in 1998–2007 and the filter won't reach those years; ICSAP for 1992–1997 is derived from a non-official CID-9 list, making g03/g05 non-comparable; uf is the file's UF and municipality_code is null in that period; and the default universe excludes obstetric, delivery, and long-stay admissions. This is rich behavioral context that annotations cannot convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single dense paragraph, but it is tightly organized: purpose first, then filters, then critical data caveats, then the universe calculation. Each sentence carries distinct information and there is no filler or repetition. It remains readable despite the complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 10-parameter tool with historical data caveats, the description covers the major lifetime issues (race availability, ICD-9 revision change, municipality/UF basis) and the calculation universe. It points to get_available_years for additional notes, and an output schema exists so return format is not needed. Still, it could be slightly more explicit about the intended use case versus sibling tools like get_icsap_indicators, but overall it is near complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While the schema already describes all 10 parameters (100% coverage), the description adds semantic caveats for parameters: it specifies the meaning of `race` null periods, the `uf` file-basis in 1992–1997, municipality_code null, and the `universe` exclusions. These nuances go beyond the schema's terse descriptions, particularly for uf and municipality_code.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Consulta internações por Condições Sensíveis à Atenção Primária (ICSAP)', a specific verb and resource, and enumerates the available filters. However, it does not explicitly distinguish this tool from siblings like get_icsap_indicators or get_hospitalizations, so it misses the top-tier sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool is for querying ICSAP hospitalizations with filters, and it refers to get_available_years for data-revision caveats. It does not state explicit when-to-use vs alternatives, nor when not to use it (e.g., if the user needs indicators or trends). The guidance is mostly implicit through the tool's name and filter list.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.