> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salu.com.vc/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral e modelo de dados

> As entidades centrais da API pública da Salú e como elas se relacionam.

A Salú é uma plataforma de **saúde e segurança do trabalho (SST)**. A API pública existe
para que sistemas do cliente (ERP, folha, RH) mantenham, de forma segura e rastreável, a
estrutura da empresa e os colaboradores — e, a partir disso, o ciclo de **exames
ocupacionais** (ASO).

<Info>
  Se você ainda não leu, comece por [Como usar](/public-api/br/como-usar): ambientes,
  autenticação por `x-api-key`, paginação e erros.
</Info>

## As entidades centrais

| Entidade                                                                | O que é                                         | Endpoint público          |
| ----------------------------------------------------------------------- | ----------------------------------------------- | ------------------------- |
| [Organização](/public-api/br/conceitos/organizacao)                     | A empresa cliente (CNPJ raiz) dona dos dados    | Listar                    |
| [Unidade (Branch)](/public-api/br/conceitos/unidade-branch)             | Local físico/legal onde se trabalha             | CRUD                      |
| [Setor (Sector)](/public-api/br/conceitos/setor-sector)                 | Área/departamento dentro da empresa             | CRUD                      |
| [Cargo (Position)](/public-api/br/conceitos/cargo-position)             | Função exercida pelo colaborador                | CRUD                      |
| [Hierarquia](/public-api/br/conceitos/hierarquia)                       | A combinação Unidade × Setor × Cargo            | — (derivada)              |
| [Colaborador (Employee)](/public-api/br/conceitos/colaborador-employee) | Vínculo de uma pessoa (CPF) com a organização   | CRUD                      |
| [Pendência (Exame)](/public-api/br/conceitos/pendencia-exame)           | Obrigação de exame ocupacional                  | Listar / criar / cancelar |
| [Análise PCD](/public-api/br/conceitos/analise-pcd)                     | Análise de deficiência (pessoa com deficiência) | Criar / consultar         |

## Como se relacionam

```mermaid theme={null}
erDiagram
    ORGANIZACAO ||--o{ UNIDADE : "tem"
    ORGANIZACAO ||--o{ SETOR : "tem"
    ORGANIZACAO ||--o{ CARGO : "tem"
    UNIDADE ||--o{ HIERARQUIA : "compõe"
    SETOR ||--o{ HIERARQUIA : "compõe"
    CARGO ||--o{ HIERARQUIA : "compõe"
    HIERARQUIA ||--o{ COLABORADOR : "posiciona"
    PESSOA ||--o{ COLABORADOR : "CPF (gov_id)"
    ORGANIZACAO ||--o{ COLABORADOR : "emprega"
    COLABORADOR ||--o{ PENDENCIA : "gera"
    COLABORADOR ||--o{ ANALISE_PCD : "possui"
    PENDENCIA ||--o{ AGENDAMENTO : "tem"
    CLINICA ||--o{ AGENDAMENTO : "realiza"
```

Em palavras:

* Uma **Organização** possui **Unidades**, **Setores** e **Cargos**.
* A combinação de uma Unidade + um Setor + um Cargo forma uma **Hierarquia** — a "posição"
  na qual um colaborador é alocado. É essa combinação que define os **riscos ocupacionais** e,
  portanto, os exames exigidos.
* Um **Colaborador** é o vínculo de uma **Pessoa** (identificada pelo **CPF**) com a
  organização, em uma Hierarquia. Cada ação no colaborador (admissão, demissão, periódico,
  retorno, mudança de risco) **gera uma Pendência** de exame.
* A **Pendência** acompanha o exame até a conclusão (recebimento do ASO) ou cancelamento. O
  agendamento em clínica e a realização do exame são orquestrados internamente pela Salú.

<Note>
  **Agendamento** e **Clínica** aparecem no diagrama para explicar o ciclo do exame, mas
  **não têm endpoints públicos** — são gerenciados dentro da plataforma Salú. A API pública
  expõe os recursos marcados na tabela acima.
</Note>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Montar a estrutura da empresa" icon="sitemap" href="/public-api/br/fluxos/setup-empresa">
    Crie Unidades, Setores e Cargos antes de cadastrar colaboradores.
  </Card>

  <Card title="Onboarding de colaborador" icon="user-plus" href="/public-api/br/fluxos/onboarding-colaborador">
    Cadastre o colaborador e gere o exame admissional.
  </Card>
</CardGroup>