Quando a integração for realizada através do Apache Thrift, cada ficha dentro do arquivo compactado representa um DadoTransport serializado através do TBinaryProtocol, sendo necessário que a extensão da ficha esteja definida como ".esus".

O pacote que encapsula os dados transmissíveis, cada ficha deve conter as informações de identificação deste cabeçalho, incluindo o dadoSerializado (conteúdo da ficha).

No caso do software de terceiro o campo remetente será igual ao originadora, que indica qual instalação gerou/enviou o dado.

DadoTransporte

Os atributos do registro transportado devem seguir as regras aqui descritas. Qualquer inconsistência nos dados transportados resultará no descarte da entidade DadoTransporte.

#1 uuidDadoSerializado

UUID do dado (identificador "universal" gerado na criação do registro).

Tipo Obrigatório Mínimo Máximo
String Sim 36 44

Regras: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 digitos (CNES) + 1 de hífen somados aos 36 (32 caracteres + 4 hífen) do UUID são a limitação de 44 bytes do campo. Formato canônico.

Referência: UUID Wikipedia.

#2 tipoDadoSerializado

Tipo/classe do objeto serializado através do TBinaryProtocol.

Tipo Obrigatório Mínimo Máximo
Long Sim 1 2

Referência: TipoDadoSerializado.

#3 cnesDadoSerializado

Código CNES da unidade de saúde.

Tipo Obrigatório Mínimo Máximo
String Sim 7 7

#4 codIbge

Código IBGE do dado serializado através do TBinaryProtocol.

Tipo Obrigatório Mínimo Máximo
String Sim 7 7

Referência: Municípios.

#5 ineDadoSerializado

Código INE da equipe que gerou a ficha.

Tipo Obrigatório Mínimo Máximo
String Não 10 10

#6 numLote

Número do lote para controle interno dos arquivos enviados.

Tipo Obrigatório Mínimo Máximo
Long Não - -

#7 dadoSerializado

Dado serializado através do TBinaryProtocol a partir de uma ficha.

Tipo Obrigatório Mínimo Máximo
Binary Sim - -

#8 remetente

Identifica a instalação que enviou o dado.

Tipo Obrigatório Mínimo Máximo
DadoInstalacao Sim - -

Referência: DadoInstalacao.

#9 originadora

Identifica a instalação que cadastrou/digitou.

Tipo Obrigatório Mínimo Máximo
DadoInstalacao Sim - -

Referência: DadoInstalacao.

#10 versao

Identifica a versão do e-SUS AB.

Tipo Obrigatório Mínimo Máximo
Versao Sim - -

Referência: Versão.

DadoInstalacao

#1 contraChave

Identifica o software que gerou o dado (pec/cds, cdsOff ou software de terceiros).

Tipo Obrigatório Mínimo Máximo
String Sim - -

Regras: Seguir o padrão <Nome do software do município> - Versão do software.

Observações: Campo serve para a identificar o software que gerou / cadastrou / enviou os dados.

#2 uuidInstalacao

É um identificador da instalação do software que gerou o dado. Seja ele o e-SUS ou software de terceiro. Cada e-SUS possui um UUID.

Tipo Obrigatório Mínimo Máximo
String Sim - -

Observações: Campo serve para a identificar a instalação que gerou / cadastrou / enviou os dados.

#3 cpfOuCnpj

CPF do responsável ou CNPJ da empresa responsável.

Tipo Obrigatório Mínimo Máximo
String Sim 11 15

Observações:

  • Apenas CPFs e CNPJs válidos. Rever validação;
  • Campo serve para a identificar a instalação que gerou / cadastrou / enviou os dados.

#4 nomeOuRazaoSocial

Nome do responsável ou razão social da empresa responsável.

Tipo Obrigatório Mínimo Máximo
String Sim - -

Observações: Campo serve para a identificar a instalação que gerou / cadastrou / enviou os dados.

#5 fone

Telefone da pessoa ou empresa responsável.

Tipo Obrigatório Mínimo Máximo
String Não 10 11

Observações: Campo serve para a identificar a instalação que gerou / cadastrou / enviou os dados.

#6 email

Email da pessoa ou empresa responsável.

Tipo Obrigatório Mínimo Máximo
String Não 6 255

Regras: Requerido seguir o padrão endereco@domínio.extensão.

Observações: Campo serve para a identificar a instalação que gerou / cadastrou / enviou os dados.