Este documento descreve os atributos utilizados no LEDI AB:

• O LEDI AB é 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 e-SUS AB (PEC);
• O LEDI AB pode ser implementado utilizando XML ou Apache Thrift.

Clique nos cards para acessar a documentação da versão desejada:

Este documento descreve os atributos utilizados no LEDI AB versão 3.2.1.

Confira as principais alterações da V3.0.1 para a V3.2.1 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 da unidade de saúde.

#4 codIbge

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

Referência: Municípios.

#5 ineDadoSerializado

Código INE da equipe que gerou a ficha.

#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 AB.

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

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

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

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 da unidade de saúde que o profissional está lotado.

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

#4 ine

Código INE da equipe do profissional.

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.

Referências: Municípios.

LotacaoHeader

#1 profissionalCNS

CNS do profissional.

Regras: CNS validado de acordo com o algoritmo.

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

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

#4 ine

Código INE da equipe do profissional.

VariasLotacoesHeader

#1 lotacaoFormPrincipal

Profissional responsável pelo atendimento.

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

Referências: LotacaoHeader.

#2 lotacaoFormAtendimentoCompartilhado

Profissional auxiliar no atendimento.

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

Referências: LotacaoHeader.

#3 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.

#4 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.

Observação: 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.

Regras: 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 ao profissional e a data 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.

#14 statusCadastroIndividualInativo

Marcador que indica se o cadastro está inativo.

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.

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

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.

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.

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

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. Caso contrário, o preenchimento é obrigatório.

#24 stForaArea

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

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.

Referências: OrientacaoSexual.

#5 povoComunidadeTradicional

Nome da comunidade tradicional que o cidadão pertence.

Regras:

• Não deve ser preenchido se o campo statusMembroPovoComunidadeTradicional = false;
• Se a informação for diferente das opções de referência, preencher com a opção OUTROS.

Referências: povoComunidadeTradicional.

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

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ências: ResponsavelCrianca.

SaidaCidadaoCadastro

#1 motivoSaidaCidadao

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

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.

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 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 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:

• Se o campo tipoDeImovel for diferente de 01 Domicílio, todas as famílias cadastradas devem ter o campo stMudanca = true;
• Não pode ser preenchido caso o campo statusTermoRecusa = true.

Referências: FamiliaRow.

#5 fichaAtualizada

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

Observação: 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.

Regras: 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.

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 10 dígitos, máximo 11 (DDD + 8 ou 9).

#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 ou 11 Delegacia;
• Não deve ser preenchido se o campo localizacao = 83 - Urbana.

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 ou 11 Delegacia.

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 ou 11 Delegacia.
• 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 ou 11 Delegacia.

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 ou 11 Delegacia.

Referências: TipoDeDomicilio.

#13 aguaConsumoDomicilio

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

Referências: AguaConsumoDomicilio.

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.

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.

Referências: Epoch Wikipedia em milissegundos.

Regras:

• Não pode ser posterior à data atual.

#7 stMudanca

Marcador que indica se a familia mudou-se.

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

Regras: 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ências: VariasLotacoesHeader.

#2 atendimentosIndividuais

Registro individualizado dos atendimentos.

Referências: FichaAtendimentoIndividualChild.

#3 uuidFicha

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.

#4 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

FichaAtendimentoIndividualChild

#1 numeroProntuario

Número do prontuário.

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

#2 cns

CNS do cidadão.

Regras: CNS validado de acordo com o algoritmo.

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

#3 dataNascimento

Data de nascimento do cidadão.

Regras: Não pode ser posterior à dataAtendimento e anterior à 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 localDeAtendimento

Código do local onde o atendimento foi realizado.

Regras: Apenas valores de 1 a 10.

Referências: LocalDeAtendimento.

#5 sexo

Código do sexo do cidadão.

Referências: Sexo.

#6 turno

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

Referências: Turno.

#7 tipoAtendimento

Código do tipo de atendimento realizado.

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

Referências: TipoDeAtendimento.

#8 pesoAcompanhamentoNutricional

Peso do cidadão em quilogramas.

Regras:

• Apenas números e ponto (.);
• Máximo de 3 casas decimais;
• Valor mínimo 0.5 e máximo 500.

#9 alturaAcompanhamentoNutricional

Altura do cidadão em centímetros.

Regras:

• Apenas números e ponto (.);
• Máximo de 1 casa decimal;
• Valor mínimo 20 e máximo 250.

#10 aleitamentoMaterno

Código do marcador referente ao aleitamento materno.

Referências: AleitamentoMaterno.

#11 dumDaGestante

Data da última menstruação da gestante.

Regras:

• Não pode ser superior a dataAtendimento, nem inferior a data de nascimento;
• Não pode ser preenchido quando Sexo = 0 (masculino).

Referências: Epoch Wikipedia em milissegundos.

#12 idadeGestacional

Idade gestacional em semanas.

Regras

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

#13 atencaoDomiciliarModalidade

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

Regras: Apenas valores de 1 a 3.

Referências: ModalidadeAD.

#14 problemaCondicaoAvaliada

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

Referências: ProblemaCondicaoAvaliacaoAI.

#15 examesSolicitados

Lista de exames solicitados que são apresentados na ficha.

Regras:

• Não pode conter dois exames iguais;
• Preencher apenas com o código AB do exame.

Referências: ListaExames.

Observação: Inserir o código do exame AB em caracteres maiúsculos, sem espaços.

#16 examesAvaliados

Lista de exames avaliados que são apresentados na ficha.

Regras:

• Não pode conter dois exames iguais;
• Preencher apenas com o código AB do exame.

Referências: ListaExames.

Observação: Inserir o código do exame AB em caracteres maiúsculos, sem espaços.

#17 outrosSia

Lista de outros exames.

Regras:

• Só é possível inserir exames cujo grupo é igual a 02 - Procedimentos com finalidade diagnóstica;
• Não podem conter exames que estejam presentes na tabela ListaExames;
• Não podem haver exames com o mesmo código.

Referências: OutrosSia.

#18 vacinaEmDia

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

#19 ficouEmObservacao

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

#20 nasfs

Código das ações realizadas pelo Núcleo de Atenção a Saúde da Família.

Referências: Nasf.

#21 condutas

Código das condutas adotadas no atendimento.

Regras: Não deve conter duas condutas iguais.

Referências: CondutaEncaminhamento.

#22 stGravidezPlanejada

Marcador que indica se a gravidez é planejada.

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

#23 nuGestasPrevias

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

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

#24 nuPartos

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

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

#25 racionalidadeSaude

Código da racionalidade em saúde utilizada.

Referências: racionalidadeSaude.

#26 perimetroCefalico

Perímetro cefálico do cidadão em centímetros.

Regras:

• Apenas números e ponto (.);
• Máximo de 2 casas decimais;
• Valor mínimo 10 e máximo 200.

#27 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ências: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#28 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

Regras:

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

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

OutrosSia

#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;
• Não inserir exames que estejam presentes na tabela ListaExames.

Referências: Tabela do SIGTAP, competência 02/2019 disponível em: Tabela Unificada SIGTAP.

Observação: Inserir o código do exame sem ponto ou hífen, ex: 0201010010.

#2 solicitadoAvaliado

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

Referências: SituacaoExame.

ProblemaCondicaoAvaliacaoAI

#1 ciaps

Código dos CIAPs apresentados na lista.

Regras:

• Não deve conter dois "Problemas / Condições" iguais;
• Devem ser apresentados somente os CIAP's listados na referência, cujo código inicia com letra seguida de número.
• Preencher apenas com o código AB relacionado a CIAP2 desejada;
• É Requerido o preenchimento de pelo menos um dos itens de #1 a #5.

Referências: ListaCiapCondicaoAvaliada.

Observação: Inserir o código em caracteres maiúsculos, sem espaços.

#2 outroCiap1

Código do CIAP2 registrado no antedimento.

Regras:

• Não pode ser igual a outroCiap2;
• Não pode conter nenhum dos item listados em ListaCiapCondicaoAvaliada;
• É Requerido o preenchimento de pelo menos um dos itens de #1 a #5.

#3 outroCiap2

Código do CIAP2 registrado no antedimento.

Regras:

• Não pode ser igual a outroCiap1;
• Não pode conter nenhum dos item listados em ListaCiapCondicaoAvaliada;
• É Requerido o preenchimento de pelo menos um dos itens de #1 a #5.

#4 cid10

Código do CID10 registrado no atendimento.

Regras:

• Não pode ser igual a cid10_2;
• É Requerido o preenchimento de pelo menos um dos itens de #1 a #5.

#5 cid10_2

Código do CID10 registrado no atendimento.

Regras:

• Não pode ser igual a cid10;
• É Requerido o preenchimento de pelo menos um dos itens de #1 a #5.

ListaCiapCondicaoAvaliada

ListaExames

* Procedimentos pertencentes a competência 02/2019 do SIGTAP.

FichaAtendimentoOdontologicoMaster

#1 uuidFicha

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.

#2 headerTransport

Profissionais que realizaram o atendimento.

Regras: Somente as CBOs apresentadas na Tabela 4 - CBOs que podem registrar ficha de atendimento odontológico individual podem ser adicionadas no campo CBO do profissional principal.

Referências: VariasLotacoesHeader.

#3 atendimentosOdontologicos

Registro individualizado dos atendimentos.

Referências: FichaAtendimentoOdontologicoChild.

#4 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

FichaAtendimentoOdontologicoChild

#1 dtNascimento

Data de nascimento do cidadão.

Regras: Não pode ser posterior à dataAtendimento e anterior à 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.

#2 cnsCidadao

CNS do cidadão.

Regras: CNS validado de acordo com o algoritmo.

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

#3 numProntuario

Número do prontuário do cidadão.

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

#4 gestante

Marcador que indica se o cidadão está gestante.

#5 necessidadesEspeciais

Marcador que indica se o cidadão é portador de necessidades especiais.

#6 localAtendimento

Código do local onde o atendimento foi realizado.

Regras: Apenas valores de 1 a 10.

Referências: LocalDeAtendimento.

#7 tipoAtendimento

Código do tipo de atendimento realizado.

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

Referências: TipoDeAtendimento.

#8 tiposEncamOdonto

Código das condutas adotadas e possíveis encaminhamentos.

Regras:

• A opção 15 - Tratamento concluído só pode ser selecionada se no campo tiposConsultaOdonto for selecionada uma das opções 1 - Primeira consulta odontológica programática ou 2 - Consulta de retorno em odontologia;
• A opção 17 - Alta do episódio não pode ser selecionada se no campo tiposConsultaOdonto for selecionada uma das opções 1 - Primeira consulta odontológica programática ou 2 - Consulta de retorno em odontologia.

Referências: CondutaEncaminhamentoOdonto.

#9 tiposFornecimOdonto

Código dos materiais fornecidos durante o atendimento.

Referências: FornecimentoOdonto.

#10 tiposVigilanciaSaudeBucal

Código dos marcadores referentes a situação de vigilância em saúde bucal.

Referências: VigilanciaEmSaudeBucal.

#11 tiposConsultaOdonto

Código do tipo de consulta odontológica realizada.

Regras:

• É de preenchimento obrigatório se o TipoDeAtendimento = 2 (consulta agendada);
• Não pode ser preenchido se o TipoDeAtendimento = 4 (escuta inicial ou orientação);
• Se o TipoDeAtendimento = 6 (atendimento de urgência), a opção de 2 (consulta de retorno) não pode ser marcada;
• Se TipoDeAtendimento = 5 (consulta no dia), o campo é opcional;
• Aceita apenas um registro.

Referências: TipoDeConsultaOdonto

#12 procedimentosRealizados

Código dos procedimentos que são apresentados na ficha.

Regras:

• Não podem haver procedimentos com o mesmo código;
• Somente os procedimentos AB listados em ListaProcedimentosRealizados podem ser adicionados. Verificar o procedimento AB correspondente ao procedimento SIGTAP desejado.

Referências: ProcedimentoQuantidade.

#13 outrosSiaProcedimentos

Lista de outros códigos de procedimentos.

Regras:

• Não pode conter procedimentos da ListaProcedimentosRealizados;
• Não podem haver procedimentos com o mesmo código.

Referências: ProcedimentoQuantidade.

#14 sexo

Código do sexo do cidadão.

Referências: Sexo.

#15 turno

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

Referências: Turno.

#16 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ências: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#17 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

Regras:

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

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

ProcedimentoQuantidade

#1 coMsProcedimento

Código do procedimento no MS.

Regras:

• Quando a lista partir da estrutura procedimentosRealizados, somente os procedimentos AB listados em ListaProcedimentosRealizados podem ser adicionados. Verificar o procedimento AB correspondente ao procedimento SIGTAP desejado;
• Quando a lista partir da estrutura outrosSiaProcedimentos, ela não pode conter procedimentos da ListaProcedimentosRealizados e só podem ser inseridos procedimentos cujo grupo é igual a 01 - Ações de promoção e prevenção em saúde, 02 - Procedimentos com finalidade diagnóstica, 03 - Procedimentos clínicos ou 04 - Procedimentos cirúrgicos.

Referência: Tabela do SIGTAP, competência 02/2019 disponível em: Tabela Unificada SIGTAP.

Observações:

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

#2 quantidade

Quantidade de procedimentos realizados.

ListaProcedimentosRealizados

* Procedimentos pertencentes a competência 02/2019 do SIGTAP.

FichaAtividadeColetiva

#1 uuidFicha

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: UUID Wikipedia.

#2 outraLocalidade

Descrição do local onde é realizada a atividade coletiva.

Regras:

• Preencher somente um dos campos: outraLocalidade, inep ou cnesLocalAtivade;
• Não deve ser preenchido se pseEducacao = true ou pseSaude = true.

#3 inep

Número INEP da instituição.

Regras:

• Preencher somente um dos campos: outraLocalidade, inep ou cnesLocalAtivade;
• É de preenchimento obrigatório se pseEducacao = true ou pseSaude = true.

Referências: Os números INEP das instituições de ensino podem ser obtidos a partir do site do INEP. Faça download do arquivo mais atual do "Censo escolar". Na pasta "Dados" está contido o arquivo "ESCOLAS.zip", que contém a tabela com os dados das instituições. O número INEP da instituição se encontra na coluna "CO_ENTIDADE" e o nome da instituição na coluna "NO_ENTIDADE".

#4 numParticipantes

Número de participantes da atividade.

Regras:

• Valores entre 1 e 999;
• Deve ser maior ou igual a quantidade de participantes inseridos em participantes.

#5 numAvaliacoesAlteradas

Número de avaliações alteradas.

Regras:

• Valores entre 0 e 999.
• O valor do campo deve ser igual ao número de participantes que tiveram o campo avaliacaoAlterada = true.

#6 profissionais

Lista dos profissionais que participaram da atividade.

Regras:

• Não pode ser preenchido se pseEducacao = true e pseSaude = false.

Referências: ProfissionalCboRowItem.

#7 atividadeTipo

Código do tipo da atividade que será realizada.

Regras:

• Os itens:

  • 01 - Reunião de equipe;
  • 02 - Reunião com outras equipes de saúde;
  • 03 - Reunião intersetorial / Conselho local de saúde / Controle social;
  • 05 - Atendimento em grupo.

Não podem ser selecionados se pseEducacao = true e pseSaude = false.

Referências: TipoAtividadeColetiva.

#8 temasParaReuniao

Temas para reunião.

Regras:

• É de preenchimento obrigatório se atividadeTipo for 1, 2 ou 3;
• Não pode ser preenchido se atividadeTipo for 4, 5, 6 ou 7;
• Não pode ser preenchido se pseEducacao = true e pseSaude = false.

Referências: TemasParaReuniao.

#9 publicoAlvo

Código do público alvo da atividade.

Regras:

• É de preenchimento obrigatório se atividadeTipo for 4, 5, 6 ou 7;
• Não pode ser preenchido se atividadeTipo for 1, 2 ou 3.

Referências: PublicoAlvo.

#10 participantes

Cidadãos que participaram da atividade coletiva.

Regras: É de preenchimento obrigatório se atividadeTipo for 5 ou 6.

Referências: ParticipanteRowItem.

#11 tbCdsOrigem

Tipo de origem dos dados do registro.

Observações: Utilizar valor 3 (sistemas terceiros).

#12 cnesLocalAtividade

CNES do local de atividade.

Regras:

• Preencher somente um dos campos: outraLocalidade, inep ou cnesLocalAtivade;
• Não deve ser preenchido se pseEducacao = true ou pseSaude = true.

#13 procedimento

Código do SIGTAP do procedimento coletivo realizado.

Regras: Só pode ser preenchido se o campo praticasEmSaude possuir o valor 30.

Referências: OutroProcedimentoColetivo.

#14 turno

Turno de realização da atividade.

Referências: Turno.

#15 headerTransport

Dados referentes ao profissional responsável e a data do cadastro.

Regras: Somente as CBOs apresentadas na Tabela 5 - CBOs que podem registrar ficha de atividade coletiva podem ser adicionadas no campo CBO do profissional.

Referências: UnicaLotacaoHeader.

#16 temasParaSaude

Códigos dos temas para saúde abordados na atividade.

Regras:

• Não pode ser preenchido se atividadeTipo = 1, 2 ou 3;
• É de preenchimento obrigatório se atividadeTipo = 4, 5 ou 7;
• Se temasParaSaude = 18 - Semana saúde na escola, torna-se obrigatório o preenchimento de pseEducacao ou pseSaude.

Referências: TemasParaSaude.

#17 praticasEmSaude

Códigos das práticas em saúde abordadas na atividade.

Regras:

• Não pode ser preenchido se atividadeTipo = 1, 2, 3, 4 ou 7;
• É de preenchimento obrigatório se atividadeTipo = 6;
• Os itens 2 - Aplicação tópica de flúor e 9 - Escovação dental supervisionada só podem ser utilizados se atividadeTipo = 6;

• Os itens:

  • 2 - Aplicação tópica de flúor;
  • 9 - Escovação dental supervisionada;
  • 25 - PNCT* sessão 1;
  • 26 - PNCT* sessão 2;
  • 27 - PNCT* sessão 3;
  • 28 - PNCT* sessão 4;
  • 24 - Verificação da situação vacinal;
  • 30 - Outro procedimento coletivo.

Não podem ser selecionados se pseEducacao = true e pseSaude = false.

Referências: PraticasEmSaude.

#18 pseEducacao

Marcador que indica que foram exercidas práticas educativas por um profissional de educação na escola

Regras:

• Se pseEducacao = true, inep torna-se obrigatório;
• Deve receber o valor true se temasParaSaude = 18 - Semana saúde na escola e pseSaude = false.
• Se pseEducacao = true e pseSaude = false:
  • O grupo profissionais não deve ser preenchido;
  • Os itens 01 - Reunião de equipe, 02 - Reunião com outras equipes de saúde, 03 - Reunião intersetorial / Conselho local de saúde / Controle social e 05 - Atendimento em grupo do campo atividadeTipo não devem ser selecionados;
  • O grupo temasParaReuniao não deve ser preenchido;
  • Os itens 2 - Aplicação tópica de flúor, 9 - Escovação dental supervisionada, 25 - PNCT* sessão 1, 26 - PNCT* sessão 2, 27 - PNCT* sessão 3, 28 - PNCT* sessão 4, 24 - Verificação da situação vacinal e 30 - Outro procedimento coletivo do campo praticasEmSaude não devem ser selecionados;

#19 pseSaude

Marcador que indica que foram exercidas práticas de saúde por um profissional da saúde na escola.

Regras:

• Se pseSaude = true, o campo inep torna-se obrigatório;
• Deve receber o valor true se temasParaSaude = 18 - Semana saúde na escola e pseEducacao = false.

ParticipanteRowItem

#1 cnsParticipante

CNS do cidadão que participou da atividade.

Regras:

• CNS validado de acordo com o algoritmo;
• É de preenchimento obrigatório se atividadeTipo for 5 ou 6.

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

#2 dataNascimento

Data de nascimento do cidadão.

Regras: Não pode ser posterior a dataAtendimento e anterior a 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.

#3 avaliacaoAlterada

Marcador que indica que a avaliação do cidadão teve um valor diferente dos considerados normais.

#4 peso

Peso do cidadão em quilogramas.

Regras:

• Apenas números e ponto (.);
• Máximo de 3 casas decimais;
• Valor mínimo 0.5 e máximo 500.

#5 altura

Altura do cidadão em centímetros.

Regras:

• Apenas números e ponto (.);
• Máximo de 1 casa decimal;
• Valor mínimo 20 e máximo 250.

#6 cessouHabitoFumar

Marcação se o cidadão cessou o hábito de fumar.

Regras: Não deve ser preenchido se o campo praticasEmSaude for diferente de 25, 26, 27 ou 28 (referentes ao PNCT).

#7 abandonouGrupo

Marcação se o cidadão abandonou o grupo de tabagismo.

Regras: Não deve ser preenchido se o campo praticasEmSaude for diferente de 25, 26, 27 ou 28 (referentes ao PNCT).

#8 sexo

Sexo do cidadão.

Referências: Sexo.

ProfissionalCboRowItem

#1 cnsProfissional

CNS do profissional.

Regras: CNS validado de acordo com o algoritmo.

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

Observações: Esta entidade é utilizada para representar os profissionais que participaram da atividade coletiva

#2 codigoCbo2002

Código CBO do profissional.

Referências: Lista com todas as CBOs.

Observações: Esta entidade é utilizada para representar os profissionais que participaram da atividade coletiva.

OutroProcedimentoColetivo

* Procedimentos pertencentes a competência 02/2019 do SIGTAP.

FichaVacinacaoMaster

#1 uuidFicha

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.

#2 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

#3 headerTransport

Profissional que realizou a vacinação.

Regras: Somente as CBOs apresentadas na Tabela 12 - CBOs que podem registrar ficha de vacinação podem ser adicionadas no campo CBO do profissional. Referências: UnicaLotacaoHeader.

#4 vacinacoes

Lista de registros de Vacinação.

Referências: FichaVacinacaoChild.

FichaVacinacaoChild

#1 turno

Código do turno onde aconteceu o atendimento.

Referências: Turno.

#2 numProntuario

Número do prontuário do cidadão na UBS.

#3 cnsCidadao

CNS do cidadão.

Regras: Validado por algoritmo.

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

#4 dtNascimento

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

Regras: Não pode ser posterior à dataAtendimento e anterior à 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.

#5 sexo

Código do sexo do cidadão.

Referências: Sexo.

#6 localAtendimento

Código do local onde o atendimento foi realizado.

Regras: Apenas valores de 1 a 10.

Referências: LocalDeAtendimento.

#7 viajante

Marcador que indica se o cidadão é viajante.

#8 comunicanteHanseniase

Marcador que indica se o cidadão é comunicante de hanseníese.

Regras:

• O campo somente pode ser preenchido se for registrada uma vacinação com o imunobiológico 15 - BCG;
• O campo é de preenchimento obrigatório quando for registrada uma vacinação com o imunobiológico 15 - BCG.

#9 gestante

Marcador que indica se a cidadã está gestante.

Regras: Não pode ser preenchido ser for marcado o campo puerpera.

#10 puerpera

Marcador que indica se a cidadã está puérpera.

Regras: Não pode ser preenchido ser for marcado o campo gestante.

#11 vacinas

Registro das vacinas aplicadas.

Referências: VacinaRowThrift.

Regras: Deve estar de acordo com os relacionamentos de Imunobiológico x Estratégia x Dose definidos na tabela Regras de vacinação.

#12 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ências: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#13 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

Regras:

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

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

VacinaRowThrift

#1 imunobiologico

Código do imunobiológico aplicado na vacinação.

Referências: Imunobiologico.

#2 estrategiaVacinacao

Código da estratégia da vacinação.

Referências: EstrategiaVacinacao.

#3 dose

Código da dose do imunobiológico aplicado na vacinação.

Referências: Dose.

#4 lote

Valor do lote do imunobiológico aplicado na vacinação.

Regras: Apenas letras, números, /, . e -.

#5 fabricante

Nome do fabricante do imunobiológico aplicado na vacinação.

Regras: Apenas letras, números, /, ., espaço simples e -.

FichaProcedimentoMaster

#1 uuidFicha

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.

#2 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

#3 headerTransport

Profissional que realizou os procedimentos.

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

Referências: UnicaLotacaoHeader.

#4 atendProcedimentos

Registro dos procedimentos realizados.

Referências: FichaProcedimentoChild.

Observação: É requerido pelo menos um dentre os itens #4 a #11.

#5 numTotalAfericaoPa

Quantidade de aferições de pressão realizadas.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

#6 numTotalGlicemiaCapilar

Quantidade de aferições de glicemia capilar.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

#7 numTotalAfericaoTemperatura

Quantidade de aferições de temperatura realizadas.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

#8 numTotalMedicaoAltura

Quantidade de aferições de altura.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

#9 numTotalCurativoSimples

Quantidade de curativos simples realizados.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

#10 numTotalMedicaoPeso

Quantidade de aferições de peso.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11..

#11 numTotalColetaMaterialParaExameLaboratorial

Quantidade de coletas para exame laboratorial.

Regras:

• Não pode ser preenchido com o valor "0" (zero);
• É requerido pelo menos um dentre os itens #4 a #11.

FichaProcedimentoChild

#1 numProntuario

Número do prontuário do cidadão na UBS.

#2 cnsCidadao

CNS do cidadão.

Regras: Validado por algoritmo.

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

#3 dtNascimento

Data de nascimento do cidadão.

Regras: Não pode ser posterior a dataAtendimento e anterior a 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 sexo

Código do sexo do cidadão.

Referências: Sexo.

#5 localAtendimento

Código do local onde o atendimento foi realizado.

Regras: Apenas valores de 1 a 10.

Referências: LocalDeAtendimento.

#6 turno

Código do turno onde aconteceu o atendimento.

Referências: Turno.

#7 statusEscutaInicialOrientacao

Indica a realização da escuta inicial.

#8 procedimentos

Lista dos códigos dos procedimentos que são registrados na ficha de procedimentos.

Regras:

• Preencher apenas com o código AB do procedimento;
• É requerido pelo menos um dentre os itens #8 e #9;
• Se o campo statusEscutaInicialOrientacao = true, este campo é opcional.

Referências: Procedimentos da Ficha.

Observação: Inserir o código do procedimento AB em caracteres maiúsculos, sem espaços.

#9 outrosSiaProcedimentos

Código dos outros procedimentos do SIGTAP ou SISAB.

Regras:

• Só é permitido inserir procedimentos cujo grupo é igual a 01 - Ações de promoção e prevenção em saúde, 02 - Procedimentos com finalidade diagnóstica, 03 - Procedimentos clínicos ou 04 - Procedimentos cirúrgicos;
• Não podem haver procedimentos que estão na tabela Procedimentos da Ficha;
• Não podem haver procedimentos com o mesmo código;
• É requerido pelo menos um dentre os itens #8 e #9;
• Se o campo statusEscutaInicialOrientacao = true, este campo é opcional.

Referências: Tabela do SIGTAP, competência 02/2019 disponível em: Tabela unificada SIGTAP.

Observação: Inserir o código do procedimento sem ponto ou hífen, ex: 0201010010.

#10 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ências: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.

#11 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

Regras:

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

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

Procedimentos da Ficha

* Procedimentos pertencentes a competência 02/2019 do SIGTAP.

FichaVisitaDomiciliarMaster

#1 uuidFicha

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.

#2 tpCdsOrigem

Tipo de origem dos dados do registro.

Regras: Utilizar valor 3 (sistemas terceiros).

#3 headerTransport

Profissional que realizou a visita.

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

Referências: UnicaLotacaoHeader.

#4 visitasDomiciliares

Lista de Fichas de Visita Domiciliar e Territorial.

Referências: FichaVisitaDomiciliarChild.

FichaVisitaDomiciliarChild

#1 turno

Código do turno onde aconteceu o atendimento.

Referências: Turno.

#2 numProntuario

Número do prontuário do cidadão na UBS.

Regras:

• Somente letras e números;
• Não deve ser preenchido se o campo tipoDeImovel = 02 comércio, 03 terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche ou 12 Estabelecimento religioso.

#3 cnsCidadao

CNS do cidadão.

Regras:

• Validado pelo algoritmo;
• Não deve ser preenchido se o campo tipoDeImovel = 02 comércio, 03 terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche ou 12 Estabelecimento religioso;
• Para visita periódica ou visita domiciliar para controle vetorial preencher este campo com o CNS do responsável familiar.

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

#4 dtNascimento

Data de nascimento do cidadão.

Regras:

• Não pode ser posterior a dataAtendimento e anterior a 130 anos a partir da dataAtendimento;
• Não deve ser preenchido se o campo tipoDeImovel = 02 comércio, 03 terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche ou 12 Estabelecimento religioso;

• É de preenchimento obrigatório somente se tipoDeImovel = 01 Domicílio, 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida sócio educativa, 11 Delegacia ou 99 Outros e pelo menos uma das condições a seguir seja obedecida:

  • Campo "CNS do cidadão";
  • Campo "Sexo";
  • Campo motivosVisita possuir qualquer opção dos grupos #BUSCA_ATIVA ou #ACOMPANHAMENTO inserida;
  • Campo motivosVisita possuir pelo menos uma das opções 25 Egresso de internação ou 31 Orientação / Prevenção inseridas;
  • Pelo menos um dos campos pesoAcompanhamentoNutricional e alturaAcompanhamentoNutricional for preenchido.

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.

#5 sexo

Código do sexo do cidadão.

Regras:

• Não deve ser preenchido se o campo tipoDeImovel = 02 comércio, 03 terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche ou 12 Estabelecimento religioso;

• É de preenchimento obrigatório somente se tipoDeImovel =01 Domicílio, 07 Abrigo, 08 Instituição de longa permanência para idosos, 09 Unidade prisional, 10 Unidade de medida sócio educativa, 11 Delegacia ou 99 Outros e pelo menos uma das condições a seguir seja obedecida:

  • Campo "CNS do cidadão";
  • Campo "Data de nascimento";
  • Campo motivosVisita possuir qualquer opção dos grupos #BUSCA_ATIVA ou #ACOMPANHAMENTO inserida;
  • Campo motivosVisita possuir pelo menos uma das opções 25 Egresso de internação ou 31 Orientação / Prevenção inseridas;
  • Pelo menos um dos campos pesoAcompanhamentoNutricional e alturaAcompanhamentoNutricional estiver preenchido.

Referências: Sexo.

#6 statusVisitaCompartilhadaOutroProfissional

Marcador que indica se a visita foi compartilhada com outro profissional.

#7 motivosVisita

Código dos motivos da visita.

Regras:

• Não deve ser preenchido caso o campo desfecho = 3 Ausente ou 2 Visita Recusada;

• Se o campo tipoDeImovel = 02 comércio, 03 terreno baldio, 04 Ponto Estratégico, 05 Escola, 06 Creche ou 12 Estabelecimento religioso, então as opções selecionadas deste campo só podem ser:

  • 1 Cadastramento / Atualização;
  • 34 Ação educativa;
  • 35 Imóvel com foco;
  • 36 Ação mecânica;
  • 37 Tratamento focal;
  • 27 Convite para atividades coletivas / campanha de saúde;
  • 31 Orientação / Prevenção;
  • 28 Outros.

Referências: MotivoVisita.

#8 desfecho

Código dos resultados da ação de visita.

Referências: Desfecho.

#9 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.

#10 stForaArea

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

#11 tipoDeImovel

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

Referências: tipoDeImovel.

#12 pesoAcompanhamentoNutricional

Peso do cidadão em Quilogramas.