Ministério da Saúde

DATASUS

Quais são as normas gerais para o padrão de nomenclatura no DATASUS?

publicado: 08/08/2019 11h11,
última modificação: 08/08/2019 11h11


1. O nome do objeto deve apresentar clareza, de forma a indicar a sua finalidade no negócio a que está vinculada. Não deve ferir a norma culta da língua portuguesa.

2. O nome de um objeto de banco de dados deverá ser formado por uma ou mais palavras com todas as letras em maiúsculas e no singular, cada uma separada pelo caractere separador do underscore (_).  A sequencia das palavras deve ser lógica de tal forma que dê um significado preciso em Português.

3. Para a formação de cada palavra de  um nome, deve-se sempre considerar a portabilidade entre SGBD´s, sendo assim utilize apenas os caracteres alfabéticos não acentuados e numéricos.

4.  Para o caso de abreviações, as seguintes regras devem ser observadas:

5. Utilize abreviações  ou siglas somente quando o nome completo ultrapassar o tamanho máximo estipulado e nestas situações, somente se for de aceitação e conhecimento geral do órgão.;

6. A palavra principal que compõe o nome de um elemento de dado não deve ser abreviada;

7. Na abreviação de palavras, siga as regras definidas no item 4 deste documento.

8. Palavras em outro idioma não serão permitidas. As exceções deverão ser tratadas caso a caso.

9. Nome de qualquer tipo de objeto e colunas de tabelas deve possuir  a formação Prefixo_NomeObjeto.  O prefixo para o caso de tabelas e colunas define uma categorização para cada um, sendo que no caso de colunas não é indicado tipo e tamanho que deve estar associado, pois isso depende do negócio, mas é importante observar o bom senso nesse tipo de definição, por exemplo, para colunas cujo tamanho é de informações conhecidas como CPF  ou  CNPJ deve-se utilizar o tipo e tamanho de acordo com a definição existente, sendo CPF com varchar2(11) ou char(11) e CNPJ com varchar2(14) ou char(14). Para os casos, onde o domínio está definido em tabela do DBGERAL deve ser utilizada esta com FK.

10. Nomes de schemas não devem utilizar caracter separador e devem ser compostos de apenas uma palavra com no máximo 20 caracteres, sendo que a sua formação é DBNomeSchema, sendo que no caso de o schema ser de uma aplicação, deve ser DBSiglaAplicacao.

11.  O prefixo de cada objeto deve indicar da finalidade do mesmo, conforme definido no Anexo I.

12. Para o caso de exclusão lógica de registro em uma tabela esta deve ter um campo com nome ST_REGISTRO_ATIVO datatype CHAR(1) e domínio S ou N. A sua descrição pode ser “Indica se o registro está ativo ou não (excluído logicamente). O seu domínio é: S – Sim (está ativo) ou N – Não (não está ativo). O controle no uso de registros excluídos deve ser feito pela aplicação.”.

13.  Uma observação importante é que quando a tabela é criada já com essa coluna, não é obrigatório a definição de um valor DEFAULT, mas quando a coluna é adicionada em uma tabela já existente, deve-se definir o valor DEFAULT, pois assim a coluna pode ser criada como NOT NULL e o valor DEFAULT será preenchido para todos os registros existentes na tabela.

14. Para o caso de necessidade de exclusão física de registros é obrigatório que seja implementada auditoria na tabela.

15.  Não serão criados sinônimos para acessar os objetos.  Será necessário fazer referência ao esquema (owner) antes do nome do objeto.

16.  O tamanho máximo de um nome de objeto não pode exceder 30 caracteres. Para os casos de Intermedia Index o tamanho máximo é de 25 caracteres, devido a uma limitação do SGBD.

17.  No caso do nome do objeto ultrapassar o tamanho máximo estipulado, a seguinte regra deve ser utilizada:

  • Verificar a possibilidade de substituir palavras por acrônimos ou siglas;
  • Abreviar as palavras utilizando-se da norma culta de nossa língua.

18.  No item onde são tratados os prefixos dos objetos, as seguintes regras devem ser consideradas:

  • [NOME DA TABELA]: o nome da tabela não ter conter o prefixo, a menos que seja uma tabela com prefixo RL, TL_ ou AU_; não deve conter o caracter separador _.
  • [NOME DA COLUNA]: não deve conter o caracter separador _, sendo que este caracter deverá conter quando for utilizada mais de uma coluna.
  • [NOME FK]: deve conter o prefixo ; não deve conter o caracter separador _.