changedOutput 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"
+}
