1. Descrição

O Prontuário Eletrônico e-SUS APS, atualmente, permite a configuração de sistemas externos através do módulo de integração, disponível para o administrador da instalação. Atualmente os sistemas externos são exibidos dentro do contexto do Atendimento individual e Odontológico em uma aba específica e no menu principal do sistema, dependendo da configuração realizada pelo administrador.

Nas documentações abaixo apresentamos mais detalhes sobre aspectos de configuração e segurança:

• Sistemas habilitados para iFrame;
• Chave de assinatura;
• Parâmetros dinâmicos de integração.

2. Cadastro do sistema externo

1. O cadastro de sistemas externos está habilitado somente para as instalações que possuam HTTPS configurado.

2. O cadastro deve ser feito pelo Administrador da Instalação no módulo "Integração > Sistemas externos". Sendo necessário informar os seguintes dados dos integradores:

• Para cadastro de "Pessoa física" o registro deve conter as seguintes informações da pessoa que será responsável pela integração: URL de acesso ao sistema externo, Nome, CPF, E-mail e Nome do sistema;
• Para cadastro de "Pessoa jurídica" o registro deve conter as seguintes informações da pessoa que será responsável pela integração: URL de acesso ao sistema externo, Nome, CNPJ, E-mail e Nome do sistema.

3. Após realizar o cadastro de um integrador o sistema irá gerar a chave de assinatura, que será utilizada para gerar a chave durante a requisição de acesso ao sistema externo. Sendo o Administrador da Instalação responsável por repassar a chave para os responsáveis dos sistemas externos. Não é possível recuperar uma chave gerada previamente, caso a chave seja perdida é necessário realizar um novo cadastro.

1. Objetivo

Este documento apresenta detalhes sobre como um sistema deve ser configurado para permitir o uso dentro de um iFrame.

2. Sistemas habilitados para iFrame

Não é possível carregar o iFrame no Prontuário Eletrônico e-SUS APS, caso o sistema configurado possua configurações que restrinjam o uso do conteúdo, como, por exemplo, quando o servidor envia cabeçalhos de segurança específicos. Os cabeçalhos que podem causar essa restrição incluem:

• Content-Security-Policy: Se configurado como frame-ancestors 'none', impede que qualquer site carregue o conteúdo em um iFrame.
• X-Frame-Options: Definido com valores como SAMEORIGIN ou DENY, esse cabeçalho restringe a exibição do conteúdo em iFrames. O valor SAMEORIGIN permite que o conteúdo seja exibido apenas em páginas do mesmo domínio, enquanto DENY bloqueia completamente a exibição em iFrames.

Para mais informações:

• CSP;
• X-Frame Options.

1. Objetivo

Este documento apresenta detalhes sobre como pode ser realizada a validação de segurança em relação a requisição de acesso realizada pelo Prontuário Eletrônico e-SUS APS.

Durante a configuração do sistema externo, o Prontuário Eletrônico e-SUS APS gera uma chave de assinatura, o objetivo dessa chave de assinatura é permitir que o sistema externo que está sendo acessado valide que a requisição realmente partiu do Prontuário Eletrônico e-SUS APS. A chave de assinatura deve ser obtida através de contato com o administrador da instalação do município.

2. Exemplo

Verificação de Assinatura HMAC da requisição

Exemplo de URL

https://localhost:4000/iframe?documento-profissional=12345&documento-cidadao=67890&cnes=[CNES]&pec_timestamp=1749542182&pec_sign=9e6c598297ba33f47cfccafa4869ec70428ac3c76b0e037ec08daf96d2616c0f

Como funciona

1. Parte Base da URL (usada para assinar):

https://localhost:4000/iframe?documento-profissional=12345&documento-cidadao=67890&cnes=[CNES]&pec_timestamp=1749542182

Esta é a parte que será usada para gerar e verificar a assinatura. Note que ela termina no timestamp.

2. Timestamp:

• O parâmetro pec_timestamp=1749542182 representa o momento da requisição (segundos);
• O sistema pode estabelecer um critério de validade, por exemplo, considerando válidas apenas requisições numa janela de 30 minutos.

3. Assinatura:

• O parâmetro pec_sign=9e6c...6c0f contém a assinatura HMAC-SHA256 da URL;
• A assinatura é calculada usando toda a URL até o timestamp (inclusive);
• É usado o algoritmo HMAC-SHA256 com a chave secreta para gerar a assinatura.

Processo de Verificação

1. O sistema pega a URL completa e remove tudo após &pec_sign=;
2. Usa esta URL "limpa" para calcular um novo HMAC;
3. Compara o HMAC calculado com o recebido no parâmetro pec_sign;
4. Simultaneamente, verifica se o pec_timestamp está dentro de uma janela esperada.

A requisição só é considerada válida se:

• A parte da URL até o timestamp gerar a mesma assinatura que foi recebida;
• O timestamp estiver dentro da janela estabelecida.

Implementação de Exemplo (Javascript/Node/Express)

Cálculo do HMAC

function calculateHMAC(req) {
  const fullUrl = `${req.protocol}://${req.get("host")}${req.originalUrl}`; //url assinada no PEC é canônica. Pode ser necessário codificar a url se tiver caracteres especiais.
  const urlToSign = fullUrl.split("&pec_sign=")[0];

  return {
    urlToSign,
    signature: crypto
      .createHmac("sha256", HMAC_KEY) //HMAC_KEY corresponde a chave obtida junto ao administrador da instalação
      .update(urlToSign)
      .digest("hex"),
  };
}

Verificação do Timestamp

function verifyTimestamp(timestamp) {
  const currentTimeInSeconds = Math.floor(Date.now() / 1000);
  const timeDiff = Math.abs(currentTimeInSeconds - timestamp);
  // Permitir diferença de até 30 minutos
  return timeDiff <= 1800;
}

1. Objetivo

Este documento apresenta os parâmetros dinâmicos disponíveis para comunicação entre o Prontuário Eletrônico e-SUS APS e o Sistema externo.

Os parâmetros permitem que o Prontuário Eletrônico e-SUS APS envie informações através da URL para o sistema externo que está sendo acessado.

2. Parâmetros disponíveis

1. [CNES]: código CNES do estabelecimento da lotação do profissional realizando o atendimento

2. [documentoCidadao]: identificador do cidadão que está sendo atendido pelo profissional, preferencialmente é enviado o CPF do cidadão, caso não exista, é enviado o CNS. Essa variável está disponível apenas quando o Local de acesso do sistema externo cadastrado estiver definido como "Atendimento".

3. [documentoProfissional]: identificador do profissional que está acessando o sistema externo, preferencialmente é enviado o CPF do profissional, caso não exista, é enviado o CNS.

3. Exemplo de URL

O sistema externo deverá disponibilizar a URL para o administrador da instalação utilizando as variáveis, no formato previsto pelo Prontuário Eletrônico e-SUS APS:

https://[url_do_sistema_externo]?documento-profissional=[documentoProfissional]&documento-cidadao=[documentoCidadao]&cnes=[CNES]

Ao acionar a URL, o Prontuário Eletrônico e-SUS APS irá substituir os valores das variáveis pelo efetivo valor da mesma:

https://[url_do_sistema_externo]?documento-profissional=27406912030&documento-cidadao=07838480051&cnes=1205677

Dessa forma, o sistema externo poderá identificar o profissional, o cidadão e o estabelecimento envolvidos na requisição, direcionando a busca com precisão para os dados corretos no sistema de destino.

Importante ressaltar que os dados de segurança sempre serão enviados através da URL, mais detalhes estão disponíveis em Chave de assinatura.

Este documento descreve os atributos utilizados no LEDI APS:

• O LEDI APS é uma camada abstrata que especifica as informações, e seus formatos, que são aceitos no envio de dados de sistemas próprios para o PEC e-SUS APS;
• O LEDI APS pode ser implementado utilizando XML ou Apache Thrift;
• Possui versionamento independente, podendo não corresponder com a respectiva versão do sistema PEC e-SUS APS. A Tabela 1 apresenta a compatibilidade entre as versões do LEDI APS e do PEC e-SUS APS.

Tabela 1. Compatibilidade entre as versões do LEDI APS e PEC e-SUS APS

Esta documentação descreve as estruturas de dados, seus atributos e regras utilizadas no LEDI APS versão 8.4.2.

A versão LEDI APS 8.4.2 é compatível com o sistema PEC e-SUS APS versão 5.5.21 ou superior.

Confira as principais alterações na versão 8.4.2 aqui.

Lote

Um lote é um conjunto de arquivos de dados.

Arquivo de dados

Cada arquivo de dados representa uma ficha.

Os arquivos de dados possuem a mesma macro estrutura, referenciada como camada de transporte. A camada de transporte do arquivo de dados independe do tipo da ficha.

Quando a integração é realizada através do Apache Thrift os arquivos de dados devem ser compactados com extensão ".esus". Cada arquivo representa um dadoTransport serializado através do TBinaryProtocol.

A estrutura da Camada de Transporte é ilustrada na imagem abaixo:

Camada de transporte - Macro estrutura de um arquivo de dados

A definição de cada um dos elementos da Camada de transporte é apresentada no documento Camada de Transporte de Dados.

O dado serializado possui dois componentes: Cabeçalho e Dados da ficha.

• O dicionário de dados do Cabeçalho é definido no documento Cabeçalho (headerTransport);

• Os Dados da ficha devem ser estruturados em registros Thrift/XML conforme descrito no documento Registros Thrift / XSD por ficha.

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).

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.

Referência: TipoDadoSerializado.

#3 cnesDadoSerializado

Código CNES do estabelecimento de saúde.

Regras: Somente fichas de CNES pertencentes ao respectivo município são consideradas válidas.

#4 codIbge

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

Regras: Somente fichas com IBGE ativo na instalação são consideradas válidas.

Referência: Municípios.

#5 ineDadoSerializado

Código INE da equipe que gerou a ficha.

Regras: Somente fichas com INE pertencentes ao respectivo município são consideradas válidas.

#6 numLote

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

#7 dadoSerializado

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

#8 remetente

Identifica a instalação que enviou o dado.

Referência: DadoInstalacao.

#9 originadora

Identifica a instalação que cadastrou/digitou.

Referência: DadoInstalacao.

#10 versao

Identifica a versão do e-SUS APS.

Referência: Versão.

DadoInstalacao

#1 contraChave

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

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.

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.

Observações: 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.

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.

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

#6 email

E-mail da pessoa ou empresa responsável.

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.

UnicaLotacaoHeader

#1 profissionalCNS

CNS do profissional.

Regras:

• CNS validado de acordo com o algoritmo de validação;
• Somente fichas de profissionais com vínculo com o respectivo município são consideradas válidas.

Observações: Esta entidade é utilizada para representar o profissional responsável pelas fichas.

#2 cboCodigo_2002

Código do CBO do profissional.

Regras: Somente as CBOs apresentadas na tabela da respectiva ficha podem ser adicionadas neste campo.

Referências: Grupos de CBOs x Tipo de ficha.

Observações: Esta entidade é utilizada para representar o profissional responsável pelas fichas.

#3 cnes

Código do CNES do estabelecimento de saúde onde o profissional está lotado.

Regras: Deve ser preenchido com a mesma informação do campo #3 cnesDadoSerializado.

Observações: Esta entidade é utilizada para representar o profissional responsável pelas fichas.

#4 ine

Código INE da equipe do profissional.

Regras: Deve ser preenchido com a mesma informação do campo #5 ineDadoSerializado.

Observações: Esta entidade é utilizada para representar o profissional responsável pelas fichas.

#5 dataAtendimento

Data em que está sendo realizada a ação.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

Regras: Não pode ser posterior à data atual.

#6 codigoIbgeMunicipio

Código IBGE do município.

Regras: Deve ser preenchido com a mesma informação do campo #4 codIbge.

Referências: Municípios.

LotacaoHeader

#1 profissionalCNS

CNS do profissional.

Regras:

• CNS validado de acordo com o algoritmo de validação;
• Somente fichas de profissionais com vínculo com o respectivo município são consideradas válidas.

#2 cboCodigo_2002

Código do CBO do profissional.

Regras:

• Se for registro de lotacaoFormPrincipal somente as Grupos de CBOs x Tipo de ficha apresentadas na tabela da respectiva ficha podem ser adicionadas neste campo;
• Se for registro de lotacaoFormAtendimentoCompartilhado a referência é a Lista com todas as CBOs.

#3 cnes

Código do CNES da unidade de saúde que o profissional está lotado.

Regras:

• Se for registro de lotacaoFormPrincipal, deve ser preenchido com a mesma informação do campo #3 cnesDadoSerializado;
• Se for registro de lotacaoFormAtendimentoCompartilhado, pode ser preenchido com qualquer CNES pertencente ao respectivo município.

#4 ine

Código INE da equipe do profissional.

Regras:

• Se for registro de lotacaoFormPrincipal, deve ser preenchido com a mesma informação do campo #5 ineDadoSerializado;
• Se for registro de lotacaoFormAtendimentoCompartilhado, pode ser preenchido com qualquer INE pertencente ao respectivo município.

VariasLotacoesHeader

#1 lotacaoFormPrincipal

Profissional responsável pelo atendimento.

Referências: LotacaoHeader.

Observações: Esta entidade é utilizada para representar o profissional responsável pela ficha.

#2 lotacaoFormAtendimentoCompartilhado

Profissional auxiliar no atendimento.

Referências: LotacaoHeader.

Observações: Esta entidade é utilizada para representar um profissional que auxiliou o profissional responsável pela ficha.

#3 dataAtendimento

Data em que está sendo realizada a ação.

Regras: Não pode ser posterior à data atual.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#4 codigoIbgeMunicipio

Código IBGE do município.

Regras: Deve ser preenchido com a mesma informação do campo #4 codIbge.

Referências: Municípios.

LotacaoThrift

#1 CPF

CPF do profissional.

Regras:

• Somente CPF válido;
• Somente CPF já existente na base de dados será considerado válido.

#2 CNS

CNS do profissional.

Regras:

• CNS validado de acordo com o algoritmo de validação;
• Somente CNS já existente na base de dados será considerado válido.
• Somente fichas de profissionais com vínculo com o respectivo município são consideradas válidas.

#3 cboCodigo_2002

Código do CBO do profissional.

Regras: Somente CBO Válido.

#4 ine

Código INE da equipe do profissional.

#5 cnes

Código do CNES do estabelecimento de saúde onde o profissional está lotado.

#6 codigoIbgeMunicipio

Código IBGE do município.

Referências: Municípios.

CadastroIndividual

#1 condicoesDeSaude

Formulário referente as condições de saúde do cidadão.

Regras: Não deve ser preenchido se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

Referências: CondicoesDeSaude.

#3 emSituacaoDeRua

Formulário referente a informações de situação de rua (se o cidadão se encontrar nessa situação).

Regras: Não deve ser preenchido se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

Referências: EmSituacaoDeRua.

#4 fichaAtualizada

Marcador que indica se a ficha é uma atualização.

Regra: Caso seja uma ficha de atualização, o campo uuidFichaOriginadora deve ser preenchido com o UUID da ficha que deu origem ao registro.

#5 identificacaoUsuarioCidadao

Dados que identificam o cidadão.

Regras: Opcional se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

Referências: IdentificacaoUsuarioCidadao.

#6 informacoesSocioDemograficas

Informações sócio-demográficas fornecidas pelo cidadão.

Regras: Não deve ser preenchido se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

Referências: InformacoesSocioDemograficas

#7 statusTermoRecusaCadastroIndividualAtencaoBasica

Marcador que indica se o termo de recusa foi assinalado.

#8 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

#9 uuid

Código UUID para identificar a ficha na base de dados nacional.

Regras: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 dígitos (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ências: Para ver a referência sobre o UUID, acesse: UUID Wikipedia.

#10 uuidFichaOriginadora

Código UUID para identificar a ficha que deu origem ao cadastro do registro.

Regra: Se for uma ficha de atualização, deve ser preenchido com o UUID da ficha que deu origem ao registro. Se for a ficha de cadastro, este campo deve ser igual ao campo UUID.

Referências: Para ver a referência sobre o UUID, acesse: UUID Wikipedia.

#12 saidaCidadaoCadastro

Dados referentes a saída do cidadão do cadastro.

Referências: SaidaCidadaoCadastro.

#13 headerTransport

Dados referentes ao profissional e a data do cadastro.

Regras: Somente as CBOs apresentadas na Tabela 1 - CBOs que podem registrar ficha de cadastro individual podem ser adicionadas no campo CBO do profissional.

Referências: UnicaLotacaoHeader.

CondicoesDeSaude

#1 descricaoCausaInternacaoEm12Meses

Descrição da causa de internação do cidadão.

Observação: Não deve ser preenchido se o campo statusTeveInternadoem12Meses = false.

#2 descricaoOutraCondicao1

Condição de saúde informada pelo cidadão.

#3 descricaoOutraCondicao2

Condição de saúde informada pelo cidadão.

#4 descricaoOutraCondicao3

Condição de saúde informada pelo cidadão.

#5 descricaoPlantasMedicinaisUsadas

Descrição das plantas medicinais utilizadas.

Regras: Não deve ser preenchido se o campo statusUsaPlantasMedicinais = false.

#6 doencaCardiaca

Código das doenças cardíacas que o cidadão informou.

Regras:

• Requerido preenchimento de pelo menos um item se o campo statusTeveDoencaCardiaca = true;
• Não deve ser preenchido se o campo statusTeveDoencaCardiaca = false.

Referências: DoencaCardiaca.

#7 doencaRespiratoria

Código das doenças respiratórias que o cidadão informou.

Regras:

• Requerido preenchimento de pelo menos um item se o campo statusTemDoencaRespiratoria = true;
• Não deve ser preenchido o campo statusTemDoencaRespiratoria = false.

Referências: DoencaRespiratoria.

#8 doencaRins

Código das doenças renais que o cidadão informou.

Regras:

• Requerido preenchimento de pelo menos um item se o campo statusTemTeveDoencasRins = true;
• Não deve ser preenchido se o campo statusTemTeveDoencasRins = false.

Referências: ProblemaRins.

#9 maternidadeDeReferencia

Nome da maternidade de referência.

Regras: Não pode ser preenchido se o campo statusEhGestante = false.

#10 situacaoPeso

Código da situação referente ao peso corporal.

Referências: ConsideracaoPeso.

#11 statusEhDependenteAlcool

Marcador se o cidadão faz uso de álcool.

#12 statusEhDependenteOutrasDrogas

Marcador se o cidadão faz uso de outras drogas.

#13 statusEhFumante

Marcador se o cidadão é fumante.

#14 statusEhGestante

Marcador se a cidadã está gestante.

Regras: Não pode ser preenchido se:

• Campo sexoCidadao = 0 - Masculino;
• Campo dataNascimentoCidadao for menor que 9 anos ou maior que 60 anos a partir da dataAtendimento.

#15 statusEstaAcamado

Marcador se o cidadão está acamado.

#16 statusEstaDomiciliado

Marcador se o cidadão está domiciliado.

#17 statusTemDiabetes

Marcador se o cidadão tem diabetes.

#18 statusTemDoencaRespiratoria

Marcador se o cidadão tem doença respiratória.

#19 statusTemHanseniase

Marcador se o cidadão tem hanseníase.

#20 statusTemHipertensaoArterial

Marcador se o cidadão tem hipertensão arterial.

#21 statusTemTeveCancer

Marcador se o cidadão tem ou teve câncer.

#22 statusTemTeveDoencasRins

Marcador se o cidadão tem ou teve doenças nos rins.

#23 statusTemTuberculose

Marcador se o cidadão tem tuberculose.

#24 statusTeveAvcDerrame

Marcador se o cidadão teve AVC.

#25 statusTeveDoencaCardiaca

Marcador se o cidadão teve doença cardíaca.

#26 statusTeveInfarto

Marcador se o cidadão teve infarto.

#27 statusTeveInternadoem12Meses

Marcador se o cidadão esteve internado nos últimos 12 meses.

#28 statusUsaOutrasPraticasIntegrativasOuComplementares

Marcador se o cidadão utiliza outras práticas integrativas complementares.

#29 statusUsaPlantasMedicinais

Marcador se o cidadão utiliza plantas medicinais.

#30 statusDiagnosticoMental

Marcador que indica se o cidadão teve diagnóstico de problema mental.

EmSituacaoDeRua

#1 grauParentescoFamiliarFrequentado

Grau de parentesco do familiar que frequenta.

Regras:

• Não pode ser preenchido se o campo statusSituacaoRua = false;
• Não pode ser preenchido se o campo statusVisitaFamiliarFrequentemente = false.

#2 higienePessoalSituacaoRua

Código das condições de higiene que o cidadão tem acesso.

Regras:

• Não pode ser preenchido se o campo statusSituacaoRua = false;
• Requerido preenchimento de pelo menos um item se o campo statusTemAcessoHigienePessoalSituacaoRua = true.

Referências: AcessoHigiene.

#3 origemAlimentoSituacaoRua

Código da origem da alimentação do cidadão em situação de rua.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

Referências: OrigemAlimentacao.

#4 outraInstituicaoQueAcompanha

Nome de outra instituição que acompanha o cidadão.

Regras:

• Não pode ser preenchido se o campo statusSituacaoRua = false;
• Não pode ser preenchido se o campo statusAcompanhadoPorOutraInstituição = false.

#5 quantidadeAlimentacoesAoDiaSituacaoRua

Código da quantidade de vezes que o cidadão se alimenta por dia.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

Referências: QuantasVezesAlimentacao.

#6 statusAcompanhadoPorOutraInstituicao

Marcador que indica se o cidadão é acompanhado por outra instituição.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

#7 statusPossuiReferenciaFamiliar

Marcador que indica se o cidadão possuiu alguma referência familiar.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

#8 statusRecebeBeneficio

Marcador que indica se o cidadão recebe algum benefício.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

#9 statusSituacaoRua

Marcador que indica se o cidadão está em situação de rua.

Regras:

• Obrigatório se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = false.
• Não deve ser preenchido se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

#10 statusTemAcessoHigienePessoalSituacaoRua

Marcador que indica se o cidadão tem acesso a higiene pessoal.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

#11 statusVisitaFamiliarFrequentemente

Marcador que indica se o cidadão visita algum familiar frequentemente.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

#12 tempoSituacaoRua

Código do tempo que o cidadão está em situação de rua.

Regras: Não pode ser preenchido se o campo statusSituacaoRua = false.

Referências: TempoSituacaoDeRua.

IdentificacaoUsuarioCidadao

#1 nomeSocial

Nome social do cidadão.

Regras: Somente texto e apóstrofo (').

#2 codigoIbgeMunicipioNascimento

Código IBGE do município.

Regras: Só pode ser preenchido se o campo nacionalidadeCidadao = 1 (Brasileiro). Neste caso é de preenchimento obrigatório.

Referências: Municipios.

#3 dataNascimentoCidadao

Data de nascimento do cidadão no formato epoch time.

Regras: Não pode ser posterior a dataAtendimento ou mais anterior que 130 anos a partir da dataAtendimento.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos . Para realizar a conversão, pode ser utilizado o conversor Current millis.

#4 desconheceNomeMae

Marcador que indica que o cidadão desconhece o nome da mãe

#5 emailCidadao

E-mail do cidadão.

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

#6 nacionalidadeCidadao

Código do marcador que indica se o cidadão é brasileiro, naturalizado ou estrangeiro.

Referências: Nacionalidade.

#7 nomeCidadao

Nome completo do cidadão.

Regras: As regras de validação de um nome estão descritas em Validar nome.

#8 nomeMaeCidadao

Nome da mãe do cidadão.

Regras:

• As regras de validação de um nome estão descritas em Validar nome;
• Não deve ser preenchido se o campo desconheceNomeMae = true.

#9 cnsCidadao

CNS do cidadão.

Regras:

• Validado por algoritmo;
• Não pode ser preenchido se o campo cpfCidadao for preenchido;
• Este campo é de preenchimento obrigatório apenas se o campo cpfCidadao não estiver preenchido e o campo stNaoPossuiCpf = true.

Referências: O algoritmo de validação está presente em Validar CNS.

#10 cnsResponsavelFamiliar

CNS do responsável do cidadão.

Regras:

• Validado por algoritmo;
• Só pode ser preenchido se o campo statusEhResponsavel = false;
• Não pode ser preenchido se o campo cpfResponsavelFamiliar for preenchido.

Referências: O algoritmo de validação está presente em Validar CNS.

#11 telefoneCelular

Número de celular do cidadão.

Regras:

• Apenas números;
• O preenchimento do campo é obrigatório apenas se o campo nacionalidadeCidadao estiver preenchido como "brasileira" ou "naturalizado".

#12 numeroNisPisPasep

Número do NIS (PIS / PASEP) do cidadão.

Regras: Apenas números.

#13 paisNascimento

Código do país de nascimento do cidadão.

Regras:

• Só pode ser preenchido se o campo nacionalidadeCidadao = 3 (Estrangeiro). Neste caso o preenchimento é obrigatório;
• Se o campo nacionalidadeCidadao for igual a 1 (Brasileira), este campo deve ser preenchido com 31 (BRASIL).

Referências: País.

#14 racaCorCidadao

Código da raça / cor do cidadão.

Referências: RacaCor.

#15 sexoCidadao

Código do sexo do cidadão.

Referências: Sexo.

#16 statusEhResponsavel

Marcador que indica se o cidadão é responsável familiar.

#17 etnia

Etnia do cidadão.

Regras:

• Só deve ser preenchido se o campo racaCorCidadao = 5. Neste caso o preenchimento é obrigatório;
• O campo deve ser preenchido com a informação da coluna Código descrito no Dicionário de dados.

Referências: etnia.

#18 nomePaiCidadao

Nome do pai do cidadão.

Regras:

• As regras de validação de um nome estão descritas em Validar nome;
• Não deve ser preenchido se o campo desconheceNomePai = true. Caso contrário, o preenchimento é obrigatório.

#19 desconheceNomePai

Marcador que indica que o cidadão desconhece o nome do pai.

#20 dtNaturalizacao

Data de naturalização do cidadão.

Regras:

• Só deve ser preenchido se o campo nacionalidadeCidadao = 2. Neste caso, é de preenchimento obrigatório;
• Não pode ser posterior a dataAtendimento;
• Não pode ser anterior a dataNascimentoCidadao.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos . Para realizar a conversão, pode ser utilizado o conversor Current millis.

#21 portariaNaturalizacao

Portaria de naturalização do cidadão.

Regras: Só deve ser preenchido se o campo nacionalidadeCidadao = 2. Neste caso o preenchimento é obrigatório.

#22 dtEntradaBrasil

Data em que o cidadão entrou no Brasil.

Regras:

• Só deve ser preenchido se o campo nacionalidadeCidadao = 3. Neste caso o preenchimento é obrigatório;
• Não pode ser posterior a dataAtendimento;
• Não pode ser anterior a dataNascimentoCidadao.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos . Para realizar a conversão, pode ser utilizado o conversor Current millis.

#23 microarea

Microárea na qual o cidadão se encontra.

Regras: Não deve ser preenchido se o campo stForaArea = true.

#24 stForaArea

Marcador que indica que o cidadão está fora da área.

#25 cpfCidadao

CPF do cidadão.

Regras:

• Somente CPF válido será aceito;
• Não pode ser preenchido se o campo cnsCidadao for preenchido;
• Este campo é de preenchimento obrigatório se o campo cnsCidadao não estiver preenchido e o campo stNaoPossuiCpf = false.

#26 cpfResponsavelFamiliar

CPF do responsável do cidadão.

Regras:

• Somente CPF válido será aceito;
• Só pode ser preenchido se o campo statusEhResponsavel = false;
• Não pode ser preenchido se o campo cnsResponsavelFamiliar for preenchido.

#27 estadoCivil

Estado civil do cidadão.

Referências: estadoCivil.

#28 tipoSanguineo

Tipo sanguíneo do cidadão.

Referências: tipoSanguineo.

#29 dnv

Número da Declaração de Nascido Vivo do cidadão.

#30 stNaoPossuiCpf

Marcador que indica que o CPF do cidadão não existe ou não está disponível no momento do cadastro.

#31 justificativaNaoPossuiCpf

Justificativa para o cidadão não possuir ou não informar CPF.

Regras:

• É permitido o envio apenas de justificativas que constam na listagem de referência;
• Não pode ser preenchido se o campo stNaoPossuiCpf = false;
• É obrigatório se o campo stNaoPossuiCpf = true.

Referências: justificativaNaoPossuiCpf.

InformacoesSocioDemograficas

#1 deficienciasCidadao

Código das deficiências que o cidadão possui.

Regras:

• Requerido preenchimento de pelo menos um item se o campo statusTemAlgumaDeficiencia = true;
• Não deve ser preenchido se o campo statusTemAlgumaDeficiencia = false.

Referências: DeficienciaCidadao.

#2 grauInstrucaoCidadao

Código do curso mais elevado que o cidadão frequenta ou frequentou.

Referências: CursoMaisElevado.

#3 ocupacaoCodigoCbo2002

Código do CBO que representa a ocupação do cidadão.

Regras:

• Deve ser um código de CBO válido.

Referências: CBO.

#4 orientacaoSexualCidadao

Código da orientação sexual informada pelo cidadão.

Regras:

• Não pode ser preenchido se o campo statusDesejaInformarOrientacaoSexual = false;
• É de preenchimento obrigatório se o campo statusDesejaInformarOrientacaoSexual = true.

Referências: OrientacaoSexual.

#6 relacaoParentescoCidadao

Código da relação de parentesco com o responsável familiar.

Regras: Só pode ser preenchido se o campo statusEhResponsavel = false.

Referências: RelacaoParentesco.

#7 situacaoMercadoTrabalhoCidadao

Código da situação do cidadão no mercado de trabalho.

Referências: SituacaoMercadoTrabalho.

#8 statusDesejaInformarOrientacaoSexual

Marcador que indica se o cidadão deseja informar sua orientação sexual.

#9 statusFrequentaBenzedeira

Marcador que indica se o cidadão frequenta cuidador tradicional.

#10 statusFrequentaEscola

Marcador que indica se o cidadão frequenta escola ou creche.

#11 statusMembroPovoComunidadeTradicional

Marcador que indica se o cidadão é membro de um povo ou comunidade tradicional.

#12 statusParticipaGrupoComunitario

Marcador que indica se o cidadão participa de algum grupo comunitário.

#13 statusPossuiPlanoSaudePrivado

Marcador que indica se o cidadão possui plano de saúde privado.

#14 statusTemAlgumaDeficiencia

Marcador que indica se cidadão tem alguma deficiência.

#15 identidadeGeneroCidadao

Código da identidade de gênero informada pelo cidadão.

Regras:

• Não pode ser preenchido se o campo statusDesejaInformarIdentidadeGenero = false;
• É de preenchimento obrigatório se o campo statusDesejaInformarIdentidadeGenero = true.

Referências: identidadeGeneroCidadao.

#16 statusDesejaInformarIdentidadeGenero

Marcador que indica se o cidadão deseja informar sua identidade de gênero.

#17 responsavelPorCrianca

Código do responsável por crianças de até 9 anos.

Regras: Não pode ser preenchido se a dataNascimentoCidadao for maior ou igual a 10 anos a partir da dataAtendimento.

Referência: ResponsavelCrianca.

#18 coPovoComunidadeTradicional

Código do povo ou comunidade tradicional que o cidadão pertence.

Regra: Não deve ser preenchido se o campo statusMembroPovoComunidadeTradicional = false.

Referências: povoComunidadeTradicional.

SaidaCidadaoCadastro

#1 motivoSaidaCidadao

Código do motivo da saída do cidadão do cadastro.

Regras: Não pode ser preenchido se o campo statusTermoRecusaCadastroIndividualAtencaoBasica = true.

Referências: MotivoSaida.

#2 dataObito

Data de óbito do cidadão.

Regras:

• Só pode ser preenchido se o campo motivoSaidaCidadao = 135. Neste caso o preenchimento é obrigatório;
• Não pode ser anterior a dataNascimentoCidadao;
• Não pode ser anterior a dtEntradaBrasil;
• Não pode ser anterior a dtNaturalizacao;
• Não pode ser posterior a dataAtendimento.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos . Para realizar a conversão, pode ser utilizado o conversor Current millis.

#3 numeroDO

Número da declaração de óbito do cidadão.

Regras: Só pode ser preenchido se o campo motivoSaidaCidadao = 135.

InformacoesSocioEconomicas

#1 alimentosAcabaramAntesTerDinheiroComprarMais

Resposta da pergunta 1 da TRIA: "Nos últimos três meses, os alimentos acabaram antes que você tivesse dinheiro para comprar mais comida?".

Regras:

• Só pode ser preenchido se o campo comeuAlgunsAlimentosQueTinhaDinheiroAcabou for preenchido. Neste caso o preenchimento é obrigatório;

#2 comeuAlgunsAlimentosQueTinhaDinheiroAcabou

Resposta da pergunta 2 da TRIA: "Nos últimos três meses, você comeu apenas alguns alimentos que ainda tinha, porque o dinheiro acabou?".

Regras:

• Só pode ser preenchido se o campo alimentosAcabaramAntesTerDinheiroComprarMais for preenchido. Neste caso o preenchimento é obrigatório;

CadastroDomiciliar

#1 animaisNoDomicilio

Lista de código dos animais no domicílio.

Regras:

• Só pode ser preenchido se o campo tipoDeImovel = 01 Domicílio;
• Não pode ser preenchido se o campo stAnimaisNoDomicilio = false;
• Não pode ser preenchido se o campo statusTermoRecusa = true.

Referências: AnimalNoDomicilio.

#2 condicaoMoradia

Condições de moradia do domicílio.

Regras:

• Não deve ser preenchido se o campo tipoDeImovel = 02 Comércio, 03 Terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche, 12 Estabelecimento Religioso, 13 CASAI ou 99 Outros;
• Não deve ser preenchido se o campo statusTermoRecusa = true.

Referências: CondicaoMoradia.

#3 enderecoLocalPermanencia

Informações sobre o endereço do domicílio.

Regras: Preenchimento obrigatório caso o campo statusTermoRecusa = false.

Referências: EnderecoLocalPermanencia.

#4 familias

Lista das famílias que residem no domicílio.

Regras:

• Só pode ser preenchido se o campo tipoDeImovel = 01 Domicílio;
• Não pode ser preenchido se o campo stAtivo = false;
• Não podem ser cadastradas famílias com o mesmo numeroCnsResponsavel;
• Não pode ser preenchido caso o campo statusTermoRecusa = true.

Referências: FamiliaRow.

#5 fichaAtualizada

Marcador que indica se a ficha é uma atualização.

Regra: Caso seja uma ficha de atualização, o campo uuidFichaOriginadora deve ser preenchido com o UUID da ficha que deu origem ao registro.

#6 quantosAnimaisNoDomicilio

Número de animais no domicílio.

Regras:

• Só pode ser preenchido se o campo tipoDeImovel = 01 Domicílio;
• Não pode ser preenchido se o campo stAnimaisNoDomicilio = false;
• Não pode ser preenchido se o campo statusTermoRecusa = true;
• Não pode ser preenchido com o valor "0" (zero);
• Deve ser maior ou igual ao número de opções selecionadas no campo animaisNoDomicilio.

#7 stAnimaisNoDomicilio

Marcador que indica se existem animais no domicílio.

Regras:

• Só pode ser preenchido se o campo tipoDeImovel = 01 Domicílio;
• Não pode ser preenchido se o campo statusTermoRecusa = true.

#8 statusTermoRecusa

Marcador que indica se o termo de recusa de cadastro do domicílio foi selecionado.

#9 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

#10 uuid

Código UUID para identificar a ficha na base de dados nacional.

Regras: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 dígitos (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ências: Para ver a referência sobre o UUID, acesse: UUID Wikipedia.

#11 uuidFichaOriginadora

Código UUID para identificar a ficha que deu origem ao cadastro do registro.

Regra: Se for uma ficha de atualização, deve ser preenchido com o UUID da ficha que deu origem ao registro. Se for uma ficha de cadastro, este campo deve ser igual ao campo UUID.

Referências: Para ver a referência sobre o UUID, acesse: UUID Wikipedia.

#12 tipoDeImovel

Indica o tipo de imóvel do domicílio.

Referências: tipoDeImovel.

#13 instituicaoPermanencia

Informações referentes a instituição de permanência.

Regras:

• Só pode ser preenchido quando o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa ou 11 Delegacia;
• Não deve ser preenchido se o campo statusTermoRecusa = true.

Referências: InstituicaoPermanencia.

#14 headerTransport

Informações sobre o profissional e a data do cadastro.

Regras: Somente as CBOs apresentadas na Tabela 2 - CBOs que podem registrar ficha de cadastro domiciliar e territorial podem ser adicionadas no campo CBO do profissional.

Referências: UnicaLotacaoHeader.

#15 latitude

Informação da latitude do imóvel.

Regras:

• É de preenchimento obrigatório se o campo longitude for preenchido;
• Os valores são limitados por -90 a 90 e apresentam até 8 casas decimais.

#16 longitude

Informação da longitude do imóvel.

Regras:

• É de preenchimento obrigatório se o campo latitude for preenchido;
• Os valores são limitados por -180 a 180 e apresentam até 8 casas decimais.

#17 tipoEndereco

Código do tipo de endereço do cadastro.

Regras: Utilizar valor 3 (logradouro).

#18 stAtivo

Indica se o cadastro do imóvel está ativo.

Regras:

• Só pode ser preenchido se o campo fichaAtualizada = true.
• Só pode ser true se não houver famílias no cadastro ou todas as famílias tiverem stMudanca = true.

EnderecoLocalPermanencia

#1 bairro

Bairro onde está localizado o domicílio.

#2 cep

CEP do logradouro do domicílio.

Regras: Apenas números.

#3 codigoIbgeMunicipio

Código IBGE do município.

Referências: Municipios.

#4 complemento

Complemento do endereço do domicílio.

#5 nomeLogradouro

Nome do logradouro.

#6 numero

Número do domicílio.

Regras:

• Apenas letras e números;
• Não pode ser preenchido caso stSemNumero = true.

#7 numeroDneUf

Código indexador referente a Unidade Federativa.

Referências: Estados.

#8 telefoneContato

Telefone para contato.

Regras: Mínimo 10 dígitos, máximo 11 (DDD + 8 ou 9).

#9 telefoneResidencia

Telefone residencial.

Regras:

• Mínimo de 10 e máximo de 11 dígitos (DDD + 8 ou 9 dígitos);
• Só pode ser preenchido se o campo tipoDeImovel = 01 Domicílio.

#10 tipoLogradouroNumeroDne

Tipo do logradouro onde está o domicílio.

Regras: Deve ser informado o código DNE.

Referências: TipoLogradouro.

#11 stSemNumero

Marcador que indica que o domicílio não possui número.

#12 pontoReferencia

Indica um ponto de referência para o domicílio do cidadão.

#13 microArea

Microárea na qual o cidadão se encontra.

Regras: Não deve ser preenchido se o campo stForaArea = true. Caso contrário, o preenchimento é obrigatório.

#14 stForaArea

Marcador que indica que o cidadão está fora da área.

CondicaoMoradia

#1 abastecimentoAgua

Código do tipo de abastecimento de água.

Referências: AbastecimentoDeAgua.

#2 areaProducaoRural

Código da condição de posse e uso da terra.

Regras:

• Não deve ser preenchido se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa, 11 Delegacia ou 13 CASAI;
• Não deve ser preenchido se o campo localizacao = 83 - Urbana ou 205 - Periurbana.

Referências: CondicaoDePosseEUsoDaTerra.

#3 destinoLixo

Código do destino do lixo.

Referências: DestinoDoLixo.

#4 formaEscoamentoBanheiro

Código da forma de escoamento do banheiro ou sanitário.

Referências: FormaDeEscoamentoDoBanheiroOuSanitario.

#5 localizacao

Código da localização do domicílio.

Referências: LocalizacaoDaMoradia.

#6 materialPredominanteParedesExtDomicilio

Código do tipo de material predominante nas paredes externas do domicílio.

Regras: Não deve ser preenchido se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa, 11 Delegacia ou 13 CASAI.

Referências: MaterialPredominanteNaConstrucao.

#7 nuComodos

Número de cômodos do domicílio.

Regras:

• Não deve ser preenchido se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa, 11 Delegacia ou 13 CASAI.
• Não pode ser preenchido com o valor "0" (zero).

#8 nuMoradores

Número de moradores do domicílio.

Regras:

• Não pode ser menor que o número de familias cadastradas;
• Não pode ser menor que o somatório dos valores preenchidos no campo numeroMembrosFamilia, considerando o valor 1 quando este campo não foi informado no cadastro de uma família.

#9 situacaoMoradiaPosseTerra

Código da situação de moradia ou de posse da terra.

Regras: Não devem ser preenchidos se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa ou 11 Delegacia.

Referências: SituacaoDeMoradia.

#10 stDisponibilidadeEnergiaEletrica

Marcador que indica se existe disponibilidade de energia elétrica.

#11 tipoAcessoDomicilio

Código do tipo de acesso ao domicílio.

Regras: Não deve ser preenchido se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa, 11 Delegacia ou 13 CASAI.

Referências: TipoDeAcessoAoDomicilio.

#12 tipoDomicilio

Código do tipo de domicílio.

Regras: Não deve ser preenchido se o campo tipoDeImovel = 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida socioeducativa, 11 Delegacia ou 13 CASAI.

Referências: TipoDeDomicilio.

#13 aguaConsumoDomicilio

Código do tipo do tratamento de água para consumo do domicílio.

Referências: AguaConsumoDomicilio.

#14 tipoOrigemEnergiaEletrica

Código do tipo de energia elétrica disponível.

Regras: Não deve ser preenchido se o campo stDisponibilidadeEnergiaEletrica = false.

Referências: TipoOrigemEnergiaEletrica.

FamiliaRow

#1 dataNascimentoResponsavel

Data de nascimento, no formato epoch time, do cidadão responsável pela família.

Referências: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos . Para realizar a conversão, pode ser utilizado o conversor Current millis.

Regras:

• Não pode ser posterior a dataAtendimento e anterior a 130 anos a partir da dataAtendimento.

#2 numeroCnsResponsavel

CNS do responsável familiar.

Regras:

• Validado por algoritmo;
• Não pode ser preenchido se o campo cpfResponsavel for preenchido.

Referências: O algoritmo de validação está presente em Validar CNS.

#3 numeroMembrosFamilia

Quantidade de membros do núcleo familiar.

Regras: Não pode ser preenchido com o valor "0" (zero).

#4 numeroProntuario

Código do prontuário familiar na UBS.

Regras: Apenas letras e números.

#5 rendaFamiliar

Código da renda familiar em salários mínimos.

Referências: RendaFamiliar.

#6 resideDesde

Mês e ano que a família começou a residir no domicílio, no formato epoch time.

Regras: Não pode ser posterior à data atual.

Referências: Epoch Wikipedia em milissegundos.

#7 stMudanca

Marcador que indica se a familia mudou-se.

#8 cpfResponsavel

CPF do responsável.

Regras:

• Somente CPF válido será aceito;
• Não pode ser preenchido se o campo numeroCnsResponsavel for preenchido.

InstituicaoPermanencia

#1 nomeInstituicaoPermanencia

Indica o nome da instituição de permanência.

#2 stOutrosProfissionaisVinculados

Marcador que indica se existem outros profissional de saúde vinculados à instituição (não inclui profissionais da rede pública de saúde).

#3 nomeResponsavelTecnico

Indica o nome do responsável técnico da instituição de permanência.

Regras: As regras de validação de um nome estão descritas em Validar nome.

#4 cnsResponsavelTecnico

Indica o CNS do responsável técnico da instituição de permanência.

Referências: O algoritmo de validação está presente em Validar CNS.

#5 cargoInstituicao

Indica o cargo do responsável técnico da instituição de permanência.

#6 telefoneResponsavelTecnico

Indica o telefone para contato do responsável técnico da instituição de permanência.

Regras: Mínimo 10 dígitos, máximo 11 (DDD + 8 ou 9).

FichaAtendimentoIndividualMaster

#1 headerTransport

Profissionais que realizaram o atendimento

Regra: Somente as CBOs apresentadas na Tabela 3 - CBOs que podem registrar ficha de atendimento individual podem ser adicionadas no campo CBO do profissional principal.

Referência: VariasLotacoesHeader.

#2 atendimentosIndividuais

Registro individualizado dos atendimentos.

Referência: FichaAtendimentoIndividualChild.

#3 uuidFicha

Código UUID para identificar a ficha na base de dados nacional.

Regra: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 dígitos (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: Para ver a referência sobre o UUID, acesse: UUID Wikipedia.

#4 tpCdsOrigem

Tipo de origem dos dados do registro.

Regra: Utilizar valor 3 (sistemas terceiros).

FichaAtendimentoIndividualChild

#1 numeroProntuario

Número do prontuário.

Regra: Apenas letras e números são aceitos.

#2 cnsCidadao

CNS do cidadão.

Regras:

• CNS validado de acordo com o algoritmo de validação;
• Não pode ser preenchido se o campo cpfCidadao for preenchido.

#3 dataNascimento

Data de nascimento do cidadão.

Regra: Não pode ser posterior à dataAtendimento e anterior à 130 anos a partir da dataAtendimento.

Referência: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#4 localDeAtendimento

Código do local onde o atendimento foi realizado.

Regra: Apenas valores de 1 a 10.

Referência: LocalDeAtendimento.

#5 sexo

Código do sexo do cidadão.

Referência: Sexo.

#6 turno

Código do turno em que o atendimento foi realizado.

Referência: Turno.

#7 tipoAtendimento

Código do tipo de atendimento realizado.

Regra: Apenas as opções 1, 2, 4, 5 ou 6 são aceitas.

Referência: TipoDeAtendimento.

#8 medicoes

Lista de medições registradas no atendimento.

Referência: medicoes.

#9 aleitamentoMaterno

Código do marcador referente ao aleitamento materno.

Referência: AleitamentoMaterno.

#10 dumDaGestante

Data da última menstruação da gestante.

Regras:

• Não pode ser preenchido quando Sexo = 0 (masculino);
• Não pode ser superior à dataAtendimento.

Referência: Epoch Wikipedia em milissegundos.

#11 idadeGestacional

Idade gestacional em semanas.

Regras

• Não pode ser preenchido quando Sexo = 0 (masculino);
• Valor mínimo 1 e máximo 42.

#12 atencaoDomiciliarModalidade

Código do modalidade AD do cidadão atendido.

Regra: Apenas valores de 1 a 3.

Referência: ModalidadeAD.

#13 exame

Lista de exames solicitados e/ou avaliados.

Referência: Exames.

#14 vacinaEmDia

Marcador referente a vacinação em dia do cidadão.

#15 ficouEmObservacao

Marcador referente se o cidadão ficou em observação no atendimento.

Referência: profissionalFinalizadorObservacao.

#16 emultis

Código das ações realizadas pelas Equipes Multiprofissionais na Atenção Primária à Saúde.

Referência: eMulti.

#17 condutas

Código das condutas adotadas no atendimento.

Regra: Não deve conter duas condutas iguais.

Referência: CondutaEncaminhamento.

#18 stGravidezPlanejada

Marcador que indica se a gravidez é planejada.

Regra: Não pode ser preenchido quando Sexo = 0 (masculino).

#19 nuGestasPrevias

Número de gestações prévias.

Regra: Não pode ser preenchido quando Sexo = 0 (masculino).

#20 nuPartos

Número de partos que a mulher já teve.

Regra: Não pode ser preenchido quando Sexo = 0 (masculino).

#21 racionalidadeSaude

Código da racionalidade em saúde utilizada.

Referência: racionalidadeSaude.

#22 dataHoraInicialAtendimento

Data e hora do início do atendimento.

Regras:

• Não pode ser anterior à dataAtendimento;
• Não pode ser posterior à dataHoraFinalAtendimento e à data atual.

Referência: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#23 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

Regras:

• Não pode ser anterior à dataHoraInicialAtendimento;
• Não pode ser posterior à data atual.

Referência: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#24 cpfCidadao

CPF do cidadão.

Regras:

• Somente CPF válido será aceito;
• Não pode ser preenchido se o campo cnsCidadao for preenchido.

#25 Medicamentos

Lista de medicamentos prescritos durante o atendimento.

Referência: medicamentos.

#26 Encaminhamentos

Lista com os encaminhamentos realizados durante o atendimento.

Regras:

• Não pode ter itens duplicados na lista. Serão considerados duplicados os itens que tiverem a mesma especialidade e hipoteseDiagnosticoCID10 ou a mesma especialidade e hipoteseDiagnosticoCIAP2;
• Todos os encaminhamentos devem ser preenchidos ou com CID10 ou com CIAP2;
• Ao preencher este grupo, é obrigatório o preenchimento do campo condutas com o valor 4 - Encaminhamento para serviço especializado.

Referência: encaminhamentos.

#27 resultadosExames

Lista de exames e seus resultados.

Referência: resultadosExames.

#28 problemasCondicoes

Situações de saúde avaliadas no atendimento.

Referência: problemacondicao.

#29 tipoParticipacaoCidadao

Código para identificar se o tipo de participação do cidadão foi síncrono ou assíncrono.

Regras:

• As participações possíveis são: NAO_PARTICIPOU (1L, "Não participou"), PRESENCIAL (2L, "Presencial"), CHAMADA_DE_VIDEO(3L, "Chamada de vídeo"), CHAMADA_DE_VOZ (4L, "Chamada de voz"), EMAIL (5L, "E-mail"), MENSAGEM(6L, "Mensagem"), OUTROS (7L, "Outros").

Referência: Tipo de participação no atendimento.

#30 tipoParticipacaoProfissionalConvidado

Código para identificar se o tipo de participação do profissional convidado foi síncrono ou assíncrono.

Regras:

• As participações possíveis são: NAO_PARTICIPOU (1L, "Não participou"), PRESENCIAL (2L, "Presencial"), CHAMADA_DE_VIDEO(3L, "Chamada de vídeo"), CHAMADA_DE_VOZ (4L, "Chamada de voz"), EMAIL (5L, "E-mail"), MENSAGEM(6L, "Mensagem"), OUTROS (7L, "Outros").

Referência: Tipo de participação no atendimento.

#31 ivcf

Registro de IVCF-20 (Índice de Vulnerabilidade Clínico-Funcional).

Regra: Só pode ser preenchido se a idade do cidadão na data do atendimento for 60 anos ou mais.

Referência: ivcf.

#32 solicitacoesOci

Lista de procedimentos SIGTAP de Oferta de Cuidado Integrado (OCI) solicitados.

Regras:

• Em um mesmo atendimento, não deve haver duplicidade de itens na lista. Cada procedimento de OCI deve ser registrado apenas uma vez.

Referência: SolicitacoesOci.

#33 stNaoPossuiCpf

Marcador que indica que o CPF do cidadão não existe ou não está disponível no momento do cadastro.

#34 justificativaNaoPossuiCpf

Justificativa para o cidadão não possuir ou não informar CPF.

Regras:

• É permitido o envio apenas de justificativas que constam na listagem de referência;
• Não pode ser preenchido se o campo stNaoPossuiCpf = false;
• É obrigatório se o campo stNaoPossuiCpf = true.

Referências: justificativaNaoPossuiCpf.

Exame

#1 codigoExame

Código do exame solicitado ou avaliado.

Regras:

• Só é possível inserir exames cujo grupo é igual a 02 - Procedimentos com finalidade diagnóstica ou exames que estejam presentes na tabela ListaExames, neste caso, se o exame não tiver uma referência no SIGTAP, deve ser informado o código AB do exame;
• Não pode conter exames repetidos.

Referências:

• Tabela do SIGTAP, competência 03/2026 disponível em: Tabela Unificada SIGTAP;
• ListaExames.

Observações:

• Inserir o código do exame SIGTAP sem ponto ou hífen, ex: 0214010015;
• Inserir o código do exame AB em caracteres maiúsculos, sem espaços, ex: ABEX022.

#2 solicitadoAvaliado

Código do indicador se o exame foi Solicitado e / ou Avaliado.

Referência: SituacaoExame.

SolicitacoesOci

#1 codigoSigtap

Código SIGTAP do procedimento de Oferta de Cuidado Integrado (OCI) solicitado.

Regras:

• Só é possível inserir procedimentos SIGTAP cujo grupo é igual a 09 - Procedimentos para Ofertas de Cuidados Integrados.
• Em um mesmo atendimento, não deve haver duplicidade de itens na lista. Cada procedimento de OCI deve ser registrado apenas uma vez.
• O código do procedimento SIGTAP deve ser inserido sem ponto ou hífen, ex: 0901010014;

Referências:

• Tabela do SIGTAP, competência 03/2026 disponível em: Tabela Unificada SIGTAP;

ProblemaCondicao

#1 uuidProblema

Código identificador único do problema ou condição.

Regras:

• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap;
• Se torna obrigatório caso preenchido uuidEvolucaoProblema, coSequencialEvolucao ou situacao.

#2 uuidEvolucaoProblema

Código identificador único da evolução do problema ou condição.

Regras:

• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap;
• Se torna obrigatório caso preenchido uuidProblema, coSequencialEvolucao ou situacao.

#3 coSequencialEvolucao

Código sequencial da evolução dentro do próprio problema e condição atual.

Regras:

• A primeira evolução do problema ou condição possui o valor 1, as evoluções subsequentes incrementam de 1 em 1;
• Não é recomendado repetir dentro do mesmo problema ou condição;
• É recomendado que o valor do sequencial seja reiniciado para cada problema ou condição novo;
• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap;
• Se torna obrigatório caso preenchido uuidEvolucaoProblema, uuidProblema ou situacao.

#4 ciap

Código da CIAP registrada no atendimento.

Regras:

• Não deve repetir a mesma CIAP2 ou Código AB;
• Pode ser preenchido com Código AB da ListaCiapCondicaoAvaliada;
• Não pode conter nenhum dos itens listados no grupo Procedimentos da Tabela CIAP2;
• Não é permitida CIAP2 relacionada ao pré-natal com uma CID de desfecho de gestação (exemplo: CIAP2 "GRAVIDEZ DE ALTO RISCO - W84" relacionada a CID10 "PARTO ÚNICO ESPONTÂNEO - O80");
• Não é permitida CIAP2 relacionada ao pré-natal caso a idade seja inferior a 9 anos;
• A CIAP2 "GRAVIDEZ - W78" só pode ser vinculada a uma CID10 da familia Z34;
• O código deve ser inserido em caracteres maiúsculos, sem espaços;
• Se torna obrigatório caso o campo cid10 não seja preenchido.

#5 cid10

Código da CID10 registrada no atendimento.

Regras:

• Não deve repetir a mesma CID10;
• Não é permitida mais que uma CID10 da familia Z34 na mesma ficha;
• Se torna obrigatório caso o campo ciap não seja preenchido.

#6 situacao

Situação do problema ou condição.

Regras:

• Quando a ciap informada for "GRAVIDEZ - W78" não é permitido preencher a situação com o valor "1 - Latente";
• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap;
• Apenas valores de 0 a 2;
• Se torna obrigatório caso preenchido uuidEvolucaoProblema, uuidProblema ou coSequencialEvolucao.

Referência: SituacaoProblemasCondicoes.

#7 dataInicioProblema

Data de inicio do problema ou condição.

Regras:

• Deve ser igual ou posterior a dataNascimento;
• Deve ser anterior ou igual dataAtendimento;
• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap.

#8 dataFimProblema

Data de finalização do problema ou condição.

Regras:

• Se torna obrigatório quando o campo situacao possuir o valor "2 - Resolvido";
• Deve ser igual ou posterior a dataNascimento;
• Deve ser anterior ou igual dataAtendimento;
• Deve ser posterior ou igual a dataInicioProblema;
• Não é permitido o preenchimento caso seja informado um Código AB no campo ciap.

#9 isAvaliado

Indicador se o problema ou condição foi avaliado durante o atendimento.

IVCF

#1 resultado

Resultado em pontos do registro.

Regra: Valor mínimo 0 e máximo 40.

#2 hasSgIdade

Indicador de alteração na dimensão "Idade".

#3 hasSgPercepcaoSaude

Indicador de alteração na dimensão "Percepção da saúde".

#4 hasSgAvdInstrumental

Indicador de alteração na dimensão "AVD Instrumental".

#5 hasSgAvdBasica

Indicador de alteração na dimensão "AVD Básica".

#6 hasSgCognicao

Indicador de alteração na dimensão "Cognição".

#7 hasSgHumor

Indicador de alteração na dimensão "Humor".

#8 hasSgAlcancePreensaoPinca

Indicador de alteração na dimensão "Alcance, preensão e pinça", do grupo "Mobilidade".

#9 hasSgCapAerobicaMuscular

Indicador de alteração na dimensão "Capacidade aeróbica e/ou muscular", do grupo "Mobilidade".

#10 hasSgMarcha

Indicador de alteração na dimensão "Marcha", do grupo "Mobilidade".

#11 hasSgContinencia

Indicador de alteração na dimensão "Continência esfincteriana", do grupo "Mobilidade".

#12 hasSgVisao

Indicador de alteração na dimensão "Visão", do grupo "Comunicação".

#13 hasSgAudicao

Indicador de alteração na dimensão "Audição", do grupo "Comunicação".

#14 hasSgComorbidade

Indicador de alteração na dimensão "Comorbidade múltipla".

#15 dataResultado

Data do registro do IVCF-20.

Regras:

• Não pode ser posterior à data atual;
• Não pode ser posterior à dataHoraFinalAtendimento.
• A diferença entre a dataAtendimento e a dataNascimento deve ser maior ou igual a 60 anos.

Referência: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

Medicamentos

Regra: Não é possível adicionar mais de um registro de medicamento com todos os campos iguais.

#1 codigoCatmat

Código identificador do medicamento/princípio ativo.

Regra: Deve ser preenchido com o valor presente na coluna Código CATMAT da Tabela de Medicamentos CATMAT.

#2 viaAdministracao

A via em que o medicamento/princípio ativo entrará em contato com o organismo.

Referência: viaAdministracao.

#3 dose

Dose em que o medicamento/princípio ativo deve ser administrado.

#4 doseUnica

Indica que será uma única dose.

Regra: Este campo só pode ser marcado como "Verdadeiro" caso o campo usoContinuo estiver marcado com a opção "Falso".

#5 usoContinuo

Indica que é de uso contínuo.

Regra: Este campo só pode ser marcado como "Verdadeiro" caso o campo doseUnica estiver marcado com a opção "Falso".

#6 doseFrequenciaTipo

Tipo da frequência da dose.

Regra:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro";
• Caso o campo doseUnica estiver marcado como "Falso", este campo é de preenchimento obrigatório.

Referência: doseFrequenciaTipo.

#7 doseFrequencia

Refere-se ao valor do tipo de frequência da dose.

Regras:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro";
• Se o campo doseFrequenciaTipo = 1 - Turno, então deve ser preenchido com a descrição do turno conforme essa tabela, complementando a informação com o preenchimento dos campos doseFrequenciaQuantidade e doseFrequenciaUnidadeMedida;
• Se o campo doseFrequenciaTipo = 2 - Frequência, então deve ser preenchido com o número de vezes que a dose deverá ser administrada, complementando a informação com o preenchimento dos campos doseFrequenciaQuantidade e doseFrequenciaUnidadeMedida;
• Se o campo doseFrequenciaTipo = 3 - Intervalo, então deve ser preenchido com o intervalo de horas que a dose deverá ser administrada.

#8 doseFrequenciaQuantidade

Refere-se à periodicidade em que a dose será administrada.

Regras:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro";
• Não pode ser preenchido caso o campo doseFrequenciaTipo = 3 - Intervalo;
• É de preenchimento obrigatório caso o campo doseFrequenciaTipo for 1 - Turno ou 2 - Frequência.

#9 doseFrequenciaUnidadeMedida

Unidade de tempo associada à quantidade da frequência da dose.

Regras:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro";
• Não pode ser preenchido caso o campo doseFrequenciaTipo = 3 - Intervalo;
• É de preenchimento obrigatório caso o campo doseFrequenciaTipo for 1 - Turno ou 2 - Frequência.

Referência: doseFrequenciaUnidadeMedida.

#10 dtInicioTratamento

Data de início do tratamento.

Regra: Não pode ser anterior à dataAtendimento.

Referência: A data deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#11 duracaoTratamento

Tempo de duração do tratamento.

Regras:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro";
• Não pode ser preenchido caso o campo duracaoTratamentoMedida = 4 - Indeterminado;
• O valor deste campo deve ser maior que o valor do campo doseFrequenciaQuantidade, respeitando as devidas unidades de medidas.

#12 duracaoTratamentoMedida

Unidade de medida para o tempo de duração do tratamento.

Regra: Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro".

Referência: duracaoTratamentoMedida.

#13 quantidadeReceitada

Quantidade receitada do medicamento/princípio ativo.

#15 qtDoseManha

Quantidade de doses do medicamento/princípio ativo a ser administrada pelo paciente durante o turno da manhã.

Regra:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro".
• É obrigatório preencher no mínimo 2 turnos.
• A quantidade de doses por turno (manhã, tarde, noite) pode ser separada por barra ou vírgula.

#16 qtDoseTarde

Quantidade de doses do medicamento/princípio ativo a ser administrada pelo paciente durante o turno da tarde.

Regra:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro".
• É obrigatório preencher no mínimo 2 turnos.
• A quantidade de doses por turno (manhã, tarde, noite) pode ser separada por barra ou vírgula.

#17 qtDoseNoite

Quantidade de doses do medicamento/princípio ativo a ser administrada pelo paciente durante o turno da noite.

Regra:

• Não pode ser preenchido caso o campo doseUnica estiver marcado como "Verdadeiro".
• É obrigatório preencher no mínimo 2 turnos.
• A quantidade de doses por turno (manhã, tarde, noite) pode ser separada por barra ou vírgula.

Encaminhamentos

#1 especialidade

Especialidade em que o cidadão será encaminhado.