{
    "openapi": "3.1.0",
    "info": {
        "title": "API da vigilância sanitária — Tem Dentista",
        "version": "1.0.0",
        "description": "API aberta, gratuita e só de leitura para sistemas das vigilâncias sanitárias (municipais e estaduais). Entrega a ficha sanitária das clínicas odontológicas da área do órgão que ligaram o compartilhamento, só com os blocos liberados por cada clínica. Nunca há dado de paciente. Documentação: https://desenvolvedor.temdentista.com.br",
        "contact": {
            "name": "Tem Dentista",
            "url": "https://desenvolvedor.temdentista.com.br"
        }
    },
    "servers": [
        {
            "url": "https://app.temdentista.com.br/api/v1/vigilancia",
            "description": "Produção e ambiente de testes (a chave decide)"
        }
    ],
    "security": [
        {
            "chave": []
        },
        {
            "chaveCabecalho": []
        }
    ],
    "tags": [
        {
            "name": "Órgão"
        },
        {
            "name": "Clínicas"
        },
        {
            "name": "Arquivos"
        }
    ],
    "paths": {
        "/eu": {
            "get": {
                "tags": [
                    "Órgão"
                ],
                "operationId": "eu",
                "summary": "Quem é a chave",
                "description": "Órgão dono da chave, ambiente (producao ou testes), limite por minuto e versão. Bom para testar a ligação.",
                "responses": {
                    "200": {
                        "description": "Órgão e chave",
                        "headers": {
                            "X-Api-Versao": {
                                "schema": {
                                    "type": "string"
                                },
                                "description": "Versão do contrato."
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/RespostaEu"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    }
                }
            }
        },
        "/clinicas": {
            "get": {
                "tags": [
                    "Clínicas"
                ],
                "operationId": "listarClinicas",
                "summary": "Listar clínicas",
                "description": "Clínicas da área do órgão com o compartilhamento ligado, em ordem de id. Clínica que desliga some da lista na hora.",
                "parameters": [
                    {
                        "name": "pagina",
                        "in": "query",
                        "schema": {
                            "type": "integer",
                            "minimum": 1,
                            "default": 1
                        },
                        "description": "Página (começa em 1)."
                    },
                    {
                        "name": "por_pagina",
                        "in": "query",
                        "schema": {
                            "type": "integer",
                            "minimum": 1,
                            "maximum": 100,
                            "default": 25
                        },
                        "description": "Itens por página (até 100)."
                    },
                    {
                        "name": "situacao",
                        "in": "query",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "em_dia",
                                "atencao",
                                "atrasada",
                                "sem_informacao"
                            ]
                        },
                        "description": "Só as clínicas nesta situação."
                    },
                    {
                        "name": "atualizado_desde",
                        "in": "query",
                        "schema": {
                            "type": "string",
                            "format": "date-time"
                        },
                        "description": "Só as clínicas com mudança na ficha desde esta data (AAAA-MM-DD ou ISO 8601).",
                        "example": "2026-11-01"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Uma página de clínicas",
                        "headers": {
                            "X-Api-Versao": {
                                "schema": {
                                    "type": "string"
                                },
                                "description": "Versão do contrato."
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ListaDeClinicas"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "422": {
                        "$ref": "#/components/responses/Erro422"
                    }
                }
            }
        },
        "/clinicas/{clinica}": {
            "get": {
                "tags": [
                    "Clínicas"
                ],
                "operationId": "fichaDaClinica",
                "summary": "Ficha da clínica",
                "description": "A ficha sanitária com os blocos liberados pela clínica. Bloco não liberado não aparece em \"blocos\".",
                "parameters": [
                    {
                        "name": "clinica",
                        "in": "path",
                        "required": true,
                        "description": "id da clínica (o campo id da lista).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 900001
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A ficha",
                        "headers": {
                            "X-Api-Versao": {
                                "schema": {
                                    "type": "string"
                                },
                                "description": "Versão do contrato."
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/RespostaFicha"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "404": {
                        "$ref": "#/components/responses/Erro404"
                    }
                }
            }
        },
        "/clinicas/{clinica}/pops": {
            "get": {
                "tags": [
                    "Clínicas"
                ],
                "operationId": "situacaoDosPops",
                "summary": "Situação dos POPs",
                "description": "Os POPs da RDC 1.002/2025 e o \"Em dia com a Anvisa\". Precisa do bloco \"pops\" liberado.",
                "parameters": [
                    {
                        "name": "clinica",
                        "in": "path",
                        "required": true,
                        "description": "id da clínica (o campo id da lista).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 900001
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Situação dos POPs",
                        "headers": {
                            "X-Api-Versao": {
                                "schema": {
                                    "type": "string"
                                },
                                "description": "Versão do contrato."
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/RespostaPops"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "404": {
                        "$ref": "#/components/responses/Erro404"
                    }
                }
            }
        },
        "/clinicas/{clinica}/pasta": {
            "get": {
                "tags": [
                    "Arquivos"
                ],
                "operationId": "baixarPasta",
                "summary": "Baixar a Pasta do fiscal (.zip)",
                "description": "O último arquivo da Pasta do fiscal gerado pela clínica, só com as partes que podem sair (sem fichas da equipe nem eventos adversos). Precisa do bloco \"pasta\".",
                "parameters": [
                    {
                        "name": "clinica",
                        "in": "path",
                        "required": true,
                        "description": "id da clínica (o campo id da lista).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 900001
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Arquivo .zip",
                        "content": {
                            "application/zip": {
                                "schema": {
                                    "type": "string",
                                    "format": "binary"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "404": {
                        "$ref": "#/components/responses/Erro404"
                    }
                }
            }
        },
        "/clinicas/{clinica}/pasta/{n}": {
            "get": {
                "tags": [
                    "Arquivos"
                ],
                "operationId": "baixarItemDaPasta",
                "summary": "Baixar um arquivo da Pasta do fiscal",
                "description": "Um item da pasta pelo campo n de blocos.pasta.itens. Precisa do bloco \"pasta\".",
                "parameters": [
                    {
                        "name": "clinica",
                        "in": "path",
                        "required": true,
                        "description": "id da clínica (o campo id da lista).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 900001
                    },
                    {
                        "name": "n",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "integer"
                        },
                        "description": "O campo n do item."
                    }
                ],
                "responses": {
                    "200": {
                        "description": "O arquivo (normalmente PDF)",
                        "content": {
                            "application/pdf": {
                                "schema": {
                                    "type": "string",
                                    "format": "binary"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "404": {
                        "$ref": "#/components/responses/Erro404"
                    }
                }
            }
        },
        "/clinicas/{clinica}/documentos/{documento}": {
            "get": {
                "tags": [
                    "Arquivos"
                ],
                "operationId": "baixarDocumento",
                "summary": "Baixar um documento da pasta da vigilância",
                "description": "Licença, alvará e outros documentos de blocos.licencas.documentos com tem_arquivo = true. Documentos com dado pessoal ou de saúde da equipe nunca saem. Precisa do bloco \"licencas\".",
                "parameters": [
                    {
                        "name": "clinica",
                        "in": "path",
                        "required": true,
                        "description": "id da clínica (o campo id da lista).",
                        "schema": {
                            "type": "integer"
                        },
                        "example": 900001
                    },
                    {
                        "name": "documento",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "integer"
                        },
                        "description": "O campo documento_id."
                    }
                ],
                "responses": {
                    "200": {
                        "description": "O arquivo (PDF ou imagem)",
                        "content": {
                            "application/pdf": {
                                "schema": {
                                    "type": "string",
                                    "format": "binary"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Erro401"
                    },
                    "403": {
                        "$ref": "#/components/responses/Erro403"
                    },
                    "429": {
                        "$ref": "#/components/responses/Erro429"
                    },
                    "503": {
                        "$ref": "#/components/responses/Erro503"
                    },
                    "404": {
                        "$ref": "#/components/responses/Erro404"
                    }
                }
            }
        }
    },
    "webhooks": {
        "compartilhamento.ligado": {
            "post": {
                "summary": "compartilhamento.ligado",
                "description": "Uma clínica da área ligou o compartilhamento com a vigilância (passa a aparecer na API). Assinado no cabeçalho X-TemDentista-Assinatura (t=<unix>,v1=<HMAC-SHA256 de \"t.corpo\" com o segredo>).",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Aviso"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Recebido (qualquer 2xx). Outra resposta: tentamos de novo até 6 vezes, com espera crescente."
                    }
                }
            }
        },
        "compartilhamento.desligado": {
            "post": {
                "summary": "compartilhamento.desligado",
                "description": "Uma clínica desligou o compartilhamento: apague a cópia local da ficha dela. Assinado no cabeçalho X-TemDentista-Assinatura (t=<unix>,v1=<HMAC-SHA256 de \"t.corpo\" com o segredo>).",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Aviso"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Recebido (qualquer 2xx). Outra resposta: tentamos de novo até 6 vezes, com espera crescente."
                    }
                }
            }
        },
        "ficha.atualizada": {
            "post": {
                "summary": "ficha.atualizada",
                "description": "Algo mudou na ficha de uma clínica (blocos liberados, POPs, documentos, testes, resíduos ou Pasta do fiscal). Assinado no cabeçalho X-TemDentista-Assinatura (t=<unix>,v1=<HMAC-SHA256 de \"t.corpo\" com o segredo>).",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Aviso"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Recebido (qualquer 2xx). Outra resposta: tentamos de novo até 6 vezes, com espera crescente."
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "chave": {
                "type": "http",
                "scheme": "bearer",
                "description": "Authorization: Bearer tdv_…"
            },
            "chaveCabecalho": {
                "type": "apiKey",
                "in": "header",
                "name": "X-Api-Key"
            }
        },
        "responses": {
            "Erro401": {
                "description": "Chave ausente, inválida ou revogada",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            },
            "Erro403": {
                "description": "Órgão desligado",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            },
            "Erro404": {
                "description": "Clínica, bloco, rota ou arquivo não encontrado",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            },
            "Erro422": {
                "description": "Parâmetro inválido",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            },
            "Erro429": {
                "description": "Limite de requisições por minuto",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            },
            "Erro503": {
                "description": "API desligada",
                "headers": {
                    "X-Api-Versao": {
                        "schema": {
                            "type": "string"
                        },
                        "description": "Versão do contrato."
                    }
                },
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/Erro"
                        }
                    }
                }
            }
        },
        "schemas": {
            "Erro": {
                "type": "object",
                "properties": {
                    "erro": {
                        "type": "object",
                        "properties": {
                            "codigo": {
                                "type": "string",
                                "description": "Código fixo, para o sistema tratar.",
                                "enum": [
                                    "api_desligada",
                                    "chave_ausente",
                                    "chave_invalida",
                                    "chave_revogada",
                                    "orgao_desligado",
                                    "parametro_invalido",
                                    "clinica_nao_encontrada",
                                    "bloco_nao_liberado",
                                    "pasta_inexistente",
                                    "arquivo_nao_encontrado",
                                    "rota_inexistente",
                                    "metodo_nao_permitido",
                                    "limite_excedido",
                                    "requisicao_invalida",
                                    "erro_interno"
                                ]
                            },
                            "mensagem": {
                                "type": "string",
                                "description": "Explicação em português, para mostrar a uma pessoa."
                            },
                            "documentacao": {
                                "type": "string",
                                "description": "Link para a seção de erros."
                            }
                        },
                        "required": [
                            "codigo",
                            "mensagem",
                            "documentacao"
                        ]
                    }
                },
                "required": [
                    "erro"
                ]
            },
            "Contagem": {
                "type": "object",
                "description": "Contagem do \"Em dia com a Anvisa\".",
                "properties": {
                    "ok": {
                        "type": "integer",
                        "description": "Itens em dia."
                    },
                    "fazer": {
                        "type": "integer",
                        "description": "Itens na hora de fazer."
                    },
                    "atrasado": {
                        "type": "integer",
                        "description": "Itens atrasados ou sem registro."
                    }
                },
                "required": [
                    "ok",
                    "fazer",
                    "atrasado"
                ]
            },
            "Licenca": {
                "type": "object",
                "description": "Situação da licença sanitária.",
                "properties": {
                    "estado": {
                        "type": "string",
                        "description": "ok, fazer (vence logo), atrasado (vencida) ou falta (sem validade informada).",
                        "enum": [
                            "ok",
                            "fazer",
                            "atrasado",
                            "falta"
                        ]
                    },
                    "vale_ate": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date"
                    },
                    "dias": {
                        "type": [
                            "integer",
                            "null"
                        ],
                        "description": "Dias até vencer (negativo = vencida)."
                    }
                },
                "required": [
                    "estado",
                    "vale_ate",
                    "dias"
                ]
            },
            "RespostaEu": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "ambiente": {
                                "type": "string",
                                "enum": [
                                    "producao",
                                    "testes"
                                ]
                            },
                            "orgao": {
                                "type": "object",
                                "properties": {
                                    "id": {
                                        "type": "integer"
                                    },
                                    "nome": {
                                        "type": "string"
                                    },
                                    "esfera": {
                                        "type": "string",
                                        "enum": [
                                            "municipal",
                                            "estadual"
                                        ]
                                    },
                                    "uf": {
                                        "type": "string"
                                    },
                                    "cidade": {
                                        "type": [
                                            "string",
                                            "null"
                                        ],
                                        "description": "Nulo na vigilância estadual."
                                    },
                                    "codigo_ibge": {
                                        "type": [
                                            "string",
                                            "null"
                                        ]
                                    },
                                    "area": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "id",
                                    "nome",
                                    "esfera",
                                    "uf",
                                    "cidade",
                                    "codigo_ibge",
                                    "area"
                                ]
                            },
                            "chave": {
                                "type": "object",
                                "properties": {
                                    "nome_sistema": {
                                        "type": "string"
                                    },
                                    "prefixo": {
                                        "type": "string",
                                        "description": "Começo da chave, como aparece na tela da vigilância."
                                    },
                                    "criada_em": {
                                        "type": [
                                            "string",
                                            "null"
                                        ],
                                        "format": "date-time"
                                    },
                                    "avisos": {
                                        "type": "boolean",
                                        "description": "Se esta chave recebe avisos (webhook)."
                                    }
                                },
                                "required": [
                                    "nome_sistema",
                                    "prefixo",
                                    "criada_em",
                                    "avisos"
                                ]
                            },
                            "limite_por_minuto": {
                                "type": "integer"
                            },
                            "versao": {
                                "type": "string"
                            }
                        },
                        "required": [
                            "ambiente",
                            "orgao",
                            "chave",
                            "limite_por_minuto",
                            "versao"
                        ]
                    }
                },
                "required": [
                    "data"
                ]
            },
            "ClinicaResumo": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "nome": {
                        "type": "string"
                    },
                    "cidade": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "uf": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "codigo_ibge": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Código do município no IBGE (7 números)."
                    },
                    "cnes": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Só com o bloco \"dados\" liberado."
                    },
                    "situacao": {
                        "type": "string",
                        "description": "em_dia, atencao, atrasada ou sem_informacao (sem o bloco \"pops\").",
                        "enum": [
                            "em_dia",
                            "atencao",
                            "atrasada",
                            "sem_informacao"
                        ]
                    },
                    "em_dia": {
                        "oneOf": [
                            {
                                "$ref": "#/components/schemas/Contagem"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "licenca": {
                        "oneOf": [
                            {
                                "$ref": "#/components/schemas/Licenca"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "blocos_liberados": {
                        "type": "array",
                        "items": {
                            "type": "string",
                            "enum": [
                                "dados",
                                "responsavel",
                                "licencas",
                                "pops",
                                "autoclave",
                                "pgrss",
                                "pasta"
                            ]
                        }
                    },
                    "compartilhando_desde": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time"
                    },
                    "atualizado_em": {
                        "type": "string",
                        "description": "Última mudança em algo da ficha.",
                        "format": "date-time"
                    },
                    "links": {
                        "type": "object",
                        "properties": {
                            "ficha": {
                                "type": "string"
                            }
                        },
                        "required": [
                            "ficha"
                        ]
                    }
                },
                "required": [
                    "id",
                    "nome",
                    "cidade",
                    "uf",
                    "codigo_ibge",
                    "cnes",
                    "situacao",
                    "em_dia",
                    "licenca",
                    "blocos_liberados",
                    "compartilhando_desde",
                    "atualizado_em",
                    "links"
                ]
            },
            "ListaDeClinicas": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/ClinicaResumo"
                        }
                    },
                    "meta": {
                        "type": "object",
                        "properties": {
                            "pagina": {
                                "type": "integer"
                            },
                            "por_pagina": {
                                "type": "integer"
                            },
                            "total": {
                                "type": "integer"
                            },
                            "ultima_pagina": {
                                "type": "integer"
                            }
                        },
                        "required": [
                            "pagina",
                            "por_pagina",
                            "total",
                            "ultima_pagina"
                        ]
                    },
                    "links": {
                        "type": "object",
                        "properties": {
                            "anterior": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            },
                            "proxima": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            }
                        },
                        "required": [
                            "anterior",
                            "proxima"
                        ]
                    }
                },
                "required": [
                    "data",
                    "meta",
                    "links"
                ]
            },
            "BlocoDados": {
                "type": "object",
                "properties": {
                    "cnpj": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Só CNPJ; CPF de dono pessoa física nunca sai."
                    },
                    "cnes": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "endereco": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "telefone": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "email": {
                        "type": [
                            "string",
                            "null"
                        ]
                    }
                },
                "required": [
                    "cnpj",
                    "cnes",
                    "endereco",
                    "telefone",
                    "email"
                ]
            },
            "BlocoResponsavel": {
                "type": "object",
                "properties": {
                    "rt_nome": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "rt_cro": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "rt_substituto": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "responsavel_legal": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "supervisor_radiologica": {
                        "type": [
                            "string",
                            "null"
                        ]
                    }
                },
                "required": [
                    "rt_nome",
                    "rt_cro",
                    "rt_substituto",
                    "responsavel_legal",
                    "supervisor_radiologica"
                ]
            },
            "BlocoLicencas": {
                "type": "object",
                "properties": {
                    "licenca": {
                        "$ref": "#/components/schemas/Licenca"
                    },
                    "documentos": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "tipo": {
                                    "type": "string"
                                },
                                "rotulo": {
                                    "type": "string"
                                },
                                "documento_id": {
                                    "type": [
                                        "integer",
                                        "null"
                                    ],
                                    "description": "Nulo quando o documento não foi guardado."
                                },
                                "numero": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "orgao": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "emitido_em": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "format": "date"
                                },
                                "vence_em": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "format": "date"
                                },
                                "situacao": {
                                    "type": "string"
                                },
                                "tem_arquivo": {
                                    "type": "boolean",
                                    "description": "false também para documentos com dado pessoal da equipe (não saem)."
                                },
                                "arquivo_url": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                }
                            },
                            "required": [
                                "tipo",
                                "rotulo",
                                "documento_id",
                                "numero",
                                "orgao",
                                "emitido_em",
                                "vence_em",
                                "situacao",
                                "tem_arquivo",
                                "arquivo_url"
                            ]
                        }
                    }
                },
                "required": [
                    "licenca",
                    "documentos"
                ]
            },
            "BlocoPops": {
                "type": "object",
                "properties": {
                    "situacao": {
                        "type": "object",
                        "description": "Contagem dos POPs que se aplicam à clínica.",
                        "properties": {
                            "total": {
                                "type": "integer"
                            },
                            "aprovados": {
                                "type": "integer"
                            },
                            "rascunhos": {
                                "type": "integer"
                            },
                            "em_revisao": {
                                "type": "integer"
                            },
                            "vencidos": {
                                "type": "integer",
                                "description": "Revisão vencida."
                            },
                            "perto": {
                                "type": "integer",
                                "description": "Revisão perto de vencer."
                            }
                        },
                        "required": [
                            "total",
                            "aprovados",
                            "rascunhos",
                            "em_revisao",
                            "vencidos",
                            "perto"
                        ]
                    },
                    "resumo": {
                        "$ref": "#/components/schemas/Contagem"
                    },
                    "em_dia": {
                        "type": "array",
                        "description": "Itens do \"Em dia com a Anvisa\".",
                        "items": {
                            "type": "object",
                            "properties": {
                                "grupo": {
                                    "type": "string"
                                },
                                "titulo": {
                                    "type": "string"
                                },
                                "base": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "description": "Base legal."
                                },
                                "estado": {
                                    "type": "string",
                                    "enum": [
                                        "ok",
                                        "fazer",
                                        "atrasado",
                                        "falta"
                                    ]
                                },
                                "detalhe": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                }
                            },
                            "required": [
                                "grupo",
                                "titulo",
                                "base",
                                "estado",
                                "detalhe"
                            ]
                        }
                    },
                    "pops": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "codigo": {
                                    "type": "string"
                                },
                                "titulo": {
                                    "type": "string"
                                },
                                "versao": {
                                    "type": "integer",
                                    "description": "0 = rascunho."
                                },
                                "aprovado_em": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "format": "date"
                                },
                                "revisar_ate": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "format": "date"
                                },
                                "situacao": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "codigo",
                                "titulo",
                                "versao",
                                "aprovado_em",
                                "revisar_ate",
                                "situacao"
                            ]
                        }
                    }
                },
                "required": [
                    "situacao",
                    "resumo",
                    "em_dia",
                    "pops"
                ]
            },
            "BlocoAutoclave": {
                "type": "object",
                "properties": {
                    "ciclos_30_dias": {
                        "type": "integer"
                    },
                    "testes": {
                        "type": "array",
                        "description": "Os últimos testes biológicos e de Bowie & Dick (até 15).",
                        "items": {
                            "type": "object",
                            "properties": {
                                "data": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "format": "date-time"
                                },
                                "equipamento": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "numero": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "biologico": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "description": "Aprovado, Reprovado ou Aguardando leitura."
                                },
                                "bowie_dick": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                }
                            },
                            "required": [
                                "data",
                                "equipamento",
                                "numero",
                                "biologico",
                                "bowie_dick"
                            ]
                        }
                    }
                },
                "required": [
                    "ciclos_30_dias",
                    "testes"
                ]
            },
            "BlocoPgrss": {
                "type": "object",
                "properties": {
                    "plano": {
                        "oneOf": [
                            {
                                "type": "object",
                                "properties": {
                                    "codigo": {
                                        "type": "string"
                                    },
                                    "titulo": {
                                        "type": "string"
                                    },
                                    "versao": {
                                        "type": "integer"
                                    },
                                    "aprovado_em": {
                                        "type": [
                                            "string",
                                            "null"
                                        ],
                                        "format": "date"
                                    },
                                    "situacao": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "codigo",
                                    "titulo",
                                    "versao",
                                    "aprovado_em",
                                    "situacao"
                                ]
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "contrato": {
                        "oneOf": [
                            {
                                "type": "object",
                                "properties": {
                                    "numero": {
                                        "type": [
                                            "string",
                                            "null"
                                        ]
                                    },
                                    "vence_em": {
                                        "type": [
                                            "string",
                                            "null"
                                        ],
                                        "format": "date"
                                    },
                                    "situacao": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "numero",
                                    "vence_em",
                                    "situacao"
                                ]
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "ultima_coleta": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date"
                    },
                    "coletas_12_meses": {
                        "type": "integer"
                    }
                },
                "required": [
                    "plano",
                    "contrato",
                    "ultima_coleta",
                    "coletas_12_meses"
                ]
            },
            "BlocoPasta": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": [
                            "integer",
                            "null"
                        ],
                        "description": "Nulo quando a clínica ainda não gerou a pasta."
                    },
                    "gerada_em": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time"
                    },
                    "de": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date"
                    },
                    "ate": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date"
                    },
                    "zip_url": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "itens": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "n": {
                                    "type": "integer"
                                },
                                "parte": {
                                    "type": "string"
                                },
                                "titulo": {
                                    "type": "string"
                                },
                                "detalhe": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "arquivo": {
                                    "type": "string"
                                },
                                "url": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "n",
                                "parte",
                                "titulo",
                                "detalhe",
                                "arquivo",
                                "url"
                            ]
                        }
                    }
                },
                "required": [
                    "id",
                    "gerada_em",
                    "de",
                    "ate",
                    "zip_url",
                    "itens"
                ]
            },
            "Ficha": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "nome": {
                        "type": "string"
                    },
                    "cidade": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "uf": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "codigo_ibge": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "situacao": {
                        "type": "string",
                        "enum": [
                            "em_dia",
                            "atencao",
                            "atrasada",
                            "sem_informacao"
                        ]
                    },
                    "blocos_liberados": {
                        "type": "array",
                        "items": {
                            "type": "string",
                            "enum": [
                                "dados",
                                "responsavel",
                                "licencas",
                                "pops",
                                "autoclave",
                                "pgrss",
                                "pasta"
                            ]
                        }
                    },
                    "compartilhando_desde": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time"
                    },
                    "atualizado_em": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "blocos": {
                        "type": "object",
                        "description": "Só os blocos liberados pela clínica aparecem.",
                        "properties": {
                            "dados": {
                                "$ref": "#/components/schemas/BlocoDados"
                            },
                            "responsavel": {
                                "$ref": "#/components/schemas/BlocoResponsavel"
                            },
                            "licencas": {
                                "$ref": "#/components/schemas/BlocoLicencas"
                            },
                            "pops": {
                                "$ref": "#/components/schemas/BlocoPops"
                            },
                            "autoclave": {
                                "$ref": "#/components/schemas/BlocoAutoclave"
                            },
                            "pgrss": {
                                "$ref": "#/components/schemas/BlocoPgrss"
                            },
                            "pasta": {
                                "$ref": "#/components/schemas/BlocoPasta"
                            }
                        },
                        "required": []
                    },
                    "links": {
                        "type": "object",
                        "properties": {
                            "ficha": {
                                "type": "string"
                            },
                            "pops": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            },
                            "pasta": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            }
                        },
                        "required": [
                            "ficha",
                            "pops",
                            "pasta"
                        ]
                    }
                },
                "required": [
                    "id",
                    "nome",
                    "cidade",
                    "uf",
                    "codigo_ibge",
                    "situacao",
                    "blocos_liberados",
                    "compartilhando_desde",
                    "atualizado_em",
                    "blocos",
                    "links"
                ]
            },
            "RespostaFicha": {
                "type": "object",
                "properties": {
                    "data": {
                        "$ref": "#/components/schemas/Ficha"
                    }
                },
                "required": [
                    "data"
                ]
            },
            "RespostaPops": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "clinica_id": {
                                "type": "integer"
                            },
                            "situacao": {
                                "type": "string",
                                "enum": [
                                    "em_dia",
                                    "atencao",
                                    "atrasada",
                                    "sem_informacao"
                                ]
                            },
                            "atualizado_em": {
                                "type": "string",
                                "format": "date-time"
                            },
                            "resumo": {
                                "$ref": "#/components/schemas/Contagem"
                            },
                            "em_dia": {
                                "type": "array",
                                "description": "Itens do \"Em dia com a Anvisa\".",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "grupo": {
                                            "type": "string"
                                        },
                                        "titulo": {
                                            "type": "string"
                                        },
                                        "base": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "description": "Base legal."
                                        },
                                        "estado": {
                                            "type": "string",
                                            "enum": [
                                                "ok",
                                                "fazer",
                                                "atrasado",
                                                "falta"
                                            ]
                                        },
                                        "detalhe": {
                                            "type": [
                                                "string",
                                                "null"
                                            ]
                                        }
                                    },
                                    "required": [
                                        "grupo",
                                        "titulo",
                                        "base",
                                        "estado",
                                        "detalhe"
                                    ]
                                }
                            },
                            "pops": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "codigo": {
                                            "type": "string"
                                        },
                                        "titulo": {
                                            "type": "string"
                                        },
                                        "versao": {
                                            "type": "integer",
                                            "description": "0 = rascunho."
                                        },
                                        "aprovado_em": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "format": "date"
                                        },
                                        "revisar_ate": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "format": "date"
                                        },
                                        "situacao": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "codigo",
                                        "titulo",
                                        "versao",
                                        "aprovado_em",
                                        "revisar_ate",
                                        "situacao"
                                    ]
                                }
                            }
                        },
                        "required": [
                            "clinica_id",
                            "situacao",
                            "atualizado_em",
                            "resumo",
                            "em_dia",
                            "pops"
                        ]
                    }
                },
                "required": [
                    "data"
                ]
            },
            "Aviso": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer",
                        "description": "Número do aviso (o mesmo nas novas tentativas: use para não processar duas vezes)."
                    },
                    "evento": {
                        "type": "string",
                        "enum": [
                            "compartilhamento.ligado",
                            "compartilhamento.desligado",
                            "ficha.atualizada"
                        ]
                    },
                    "criado_em": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "clinica_id": {
                        "type": "integer"
                    },
                    "links": {
                        "type": "object",
                        "properties": {
                            "ficha": {
                                "type": [
                                    "string",
                                    "null"
                                ],
                                "description": "Nulo em compartilhamento.desligado."
                            }
                        },
                        "required": [
                            "ficha"
                        ]
                    }
                },
                "required": [
                    "id",
                    "evento",
                    "criado_em",
                    "clinica_id",
                    "links"
                ]
            }
        }
    }
}