Esta página estabelece as diretrizes arquiteturais a serem adotadas pelas
equipes de desenvolvimento de software sob responsabilidade do Datasus, bem
como nos projetos que venham a ser por ele internalizados.
A definição baseou-se nas normas governamentais e ministeriais relacionadas ao
tema, nas melhores práticas de mercado e no planejamento estratégico do
Datasus.
O escopo abarca os seguintes tópicos:
As orientações apresentadas nesta página não são exaustivas. Casos omissos e
tecnologias não previstas no catálogo institucional deverão ser analisados
previamente pela COATIC.
A homologação de uma linguagem, biblioteca, plataforma ou serviço está
vinculada ao contexto de utilização definido em sua página específica. A
existência de uma tecnologia nesta Wiki não representa autorização para sua
utilização em outras finalidades ou arquiteturas.
Os sistemas poderão ser acessados por meio de rede local ou Internet;
A linguagem de desenvolvimento utilizada para os sistemas deve ser uma das
homologadas pelo Datasus, conforme as características do sistema e os
recursos necessários;
A homologação deverá considerar o cenário de uso e os limites publicados
para cada tecnologia. Em especial, Python está autorizado para RPA, ETL,
Inteligência Artificial e funções serverless de responsabilidade pontual e
bem definida, desde que não caracterizem back-end, API ou microsserviço de
negócio, conforme as diretrizes de utilização do Python. Python
não constitui stack homologada para back-end, front-end, APIs ou
microsserviços sem excepcionalização prévia;
O servidor de aplicações será definido conforme a plataforma de
desenvolvimento adotada;
Os sistemas deverão ter os dados de persistência de sessão preparados para
provisionamento em contêineres ou, se necessário, em máquinas virtuais,
facilitando sua escalabilidade;
Os sistemas deverão ser acessíveis para pessoas com deficiência visual;
Autenticação e autorização: os sistemas deverão utilizar o provedor de
identidade corporativo Keycloak, integrado ao
Gov.br e às identidades internas conforme o contexto da solução.
A autenticação não substitui a autorização. O controle de acesso às
funcionalidades e aos dados permanecerá sob responsabilidade da solução e
deverá considerar os atributos fornecidos pelo token e os mecanismos
corporativos aplicáveis, incluindo o SCPA quando previsto para o projeto.
Nos sistemas em que o Autorizador do Datasus ou o SCPA já façam parte da
arquitetura aprovada, sua continuidade ou transição deverá ser definida com
a COATIC no contexto do projeto.
Portabilidade de SGBDs: deverá ser utilizado framework de mapeamento
objeto-relacional (ORM) na camada de persistência para a abstração do acesso
ao banco de dados, exceto em situações excepcionais, a serem avaliadas em
conjunto com a equipe da COATIC.
Reuso de componentes: todos os componentes deverão ser construídos
prevendo alto grau de desacoplamento, visando a garantir seu reuso em outros
projetos.
Portabilidade de código: o desenvolvimento de aplicações para
dispositivos móveis deverá produzir código multiplataforma, permitindo a
publicação sem alterações nas principais lojas de aplicativos, bem como no
conceito PWA (Progressive Web App).
Utilização de padrões arquiteturais agnósticos: a concepção de novas
soluções deverá ser agnóstica com relação à infraestrutura de produção, ou
seja, não pode estar vinculada a produtos específicos de provedores nem a
fornecedores de soluções externas ao Datasus. Além disso, deverá,
preferencialmente, seguir a arquitetura de
microsserviços.
Quando um recurso específico de provedor fizer parte de uma plataforma
aprovada para o projeto, a dependência deverá ser isolada e sua estratégia de
portabilidade ou substituição deverá ser documentada. A aprovação da
plataforma não autoriza acoplamento desnecessário a recursos proprietários.
Controle de inatividade: os sistemas deverão respeitar as políticas
corporativas de validade e renovação de tokens e de expiração de sessão por
inatividade. Encerrada a sessão, nova autenticação será exigida.
Interfaces de usuário amigáveis e dinâmicas: a interface de usuário deve
contemplar a usabilidade e a acessibilidade da aplicação, seguindo os padrões
visuais adotados pelo Governo Federal, baseados no Modelo de Acessibilidade em
Governo Eletrônico (eMAG).
Envio de e-mail: será utilizada a estrutura de servidores SMTP do Datasus
para o envio de e-mail.
Paginação de dados: sempre que possível, deverá ser adotada a estratégia
de paginação sob demanda, visando a evitar a sobrecarga do banco de dados e do
tráfego de rede.
Processamento em lote: rotinas de processamento em lote devem ser
implementadas em módulos independentes nos projetos e sua execução deverá
suportar agendamento.
As rotinas de extração, transformação e carga deverão observar as
diretrizes de ETL. O consumo contínuo de streams permanece sujeito à
stack homologada para essa finalidade e não deverá ser enquadrado
automaticamente como ETL.
Processamento assíncrono: requisições com duração acima de 10 segundos
deverão fazer uso de fila de processamento, executada de forma assíncrona.
Exclusão lógica de dados: por restrições legais, informações não serão
excluídas do banco de dados e, em função disso, deverá ser aplicada a exclusão
lógica de dado. Cada tabela terá um atributo para indicar se o registro está
ativo ou não, conforme a Metodologia de Administração de Dados do Datasus
(disponível em
https://datasus.saude.gov.br/metodologia-de-administracao-de-dados-mad/).
Caso exista um mecanismo de registro de trilhas de auditoria na tabela, a
exclusão lógica é opcional.
Trilhas de auditoria: o registro de trilhas de auditoria será feito
automaticamente por meio de mecanismos internos do banco de dados. A
aplicação deverá integrar-se ao framework comum do Datasus para gravar os
dados e o endereço IP do usuário a cada operação de inclusão, alteração e
exclusão de registros.
Armazenamento de arquivos: o armazenamento de arquivos nas aplicações
deverá usar a API corporativa provida pelo Datasus.
Serviço de descoberta: todo serviço web deverá ser publicado utilizando
Serviço de Descoberta, visando a manter lista atualizada das instâncias dos
serviços e não entregar tráfego em servidores indisponíveis.
Exportação massiva de dados: a exportação de grande volume de dados
deverá ser previamente analisada, caso a caso, em conjunto com a equipe de
arquitetura do Datasus.
Indexação e pesquisa textual: as aplicações que envolvam indexação e
pesquisa textual deverão ter as finalidades prioritárias de registro de logs
e de pesquisa de textos. As ferramentas de indexação e pesquisa textual não
poderão ser acessadas diretamente por código front-end. Além disso, não devem
ser usadas para réplica de banco (relacional, NoSQL), ainda que a finalidade
seja a construção de BI.
Segurança dos sistemas: os sistemas deverão seguir as políticas de
segurança do Ministério da Saúde, implementando autenticação baseada em
OpenID Connect (OIDC), sobre OAuth 2.0, e adotando soluções de segurança para
tratar os dez maiores riscos em aplicações Web publicados pela comunidade
OWASP. A publicação de código em ambiente de produção será precedida de
validação da sua
qualidade, bem como de verificação do
seu ambiente operacional e das suas dependências.
Logs: os sistemas deverão registrar as principais ocorrências relevantes
à aplicação, abrangendo obrigatoriamente: login e logout de usuário (nome de
usuário, data, hora e endereço IP); erros e exceções não programados.
Trilhas de auditoria: operações de escrita deverão ser registradas em
trilhas de auditoria, com identificação do usuário, operação executada e
data/hora.
As diretrizes gerais desta página deverão ser aplicadas em conjunto com as
orientações específicas de cada domínio:
A diretriz específica complementa esta página e não dispensa a análise de
arquitetura, segurança, privacidade, dados e infraestrutura aplicável à
solução.
A adoção de novas tecnologias pelo Datasus, tais como ferramentas de
Inteligência Artificial, de ciência de dados, de
automação de processos de negócios, de processamento de linguagem
natural etc., será precedida de análise prévia em conjunto com a equipe de
arquitetura do Datasus, com vistas à definição dos padrões mínimos a serem
adotados.
Quando houver diretriz específica publicada, a adoção deverá observar os
critérios e as avaliações nela definidos.
Qualquer linguagem, framework, plataforma, serviço, banco de dados,
orquestrador, provedor ou componente de infraestrutura que não esteja listado
nas diretrizes institucionais, ou que seja utilizado fora do escopo publicado,
deverá ser submetido previamente à análise da COATIC e das áreas responsáveis,
conforme suas competências.
A autorização concedida para um caso excepcional será específica para a solução
avaliada e não constituirá homologação geral da tecnologia nem autorização para
seu uso em outros projetos ou finalidades.
Uma biblioteca não listada não está automaticamente proibida. Bibliotecas
utilitárias de baixo risco poderão ser adotadas sem autorização específica
quando a página da respectiva tecnologia estabelecer essa possibilidade e os
critérios nela definidos forem atendidos.
Na ausência de regra específica, ou quando a dependência alterar a arquitetura,
introduzir novo provedor, transmitir dados a serviço externo, implementar
servidor, API, interface ou serviço permanente, ou apresentar risco relevante
de segurança, privacidade ou licenciamento, sua adoção exigirá avaliação
prévia.