Ficha de Cadastro Domiciliar

CadastroDomiciliar

#1 animaisNoDomicilio

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

Tipo Obrigatório Mínimo Máximo
List<Long> Condicional 0 5

Regras:

Referências: AnimalNoDomicilio

#2 condicaoMoradia

Condições de moradia do domicílio.

Tipo Obrigatório Mínimo Máximo
CondicaoMoradia Condicional - -

Regras:

Referências: CondicaoMoradia

#3 dadosGerais

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

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

Referências: HeaderCdsCadastro

#4 enderecoLocalPermanencia

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

Tipo Obrigatório Mínimo Máximo
EnderecoLocalPermanencia Condicional - -

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

Referências: EnderecoLocalPermanencia

#5 familias

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

Tipo Obrigatório Mínimo Máximo
List<FamiliaRow> Condicional 0 4

Regras:

#6 fichaAtualizada

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

Tipo Obrigatório Mínimo Máximo
Boolean Sim 1 1

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.

#7 quantosAnimaisNoDomicilio

Número de animais no domicílio.

Tipo Obrigatório Mínimo Máximo
String Condicional 0 2

Regras:

#8 stAnimaisNoDomicilio

Marcador que indica se existem animais no domicílio.

Tipo Obrigatório Mínimo Máximo
Boolean Condicional - -

Regras:

#9 statusTermoRecusaCadatroDomiciliarAtencaoBasica

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

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

#10 tpCdsOrigem

Tipo de origem dos dados do registro.

Tipo Obrigatório Mínimo Máximo
Integer Sim 1 1

Regras: Utilizar valor 3 (sistemas terceiros).

#11 uuid

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

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

Regras: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 digitos (CNES) + 1 de hífen somados aos 3 (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.

#12 uuidFichaOriginadora

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

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

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.

FamiliaRow

#1 dataNascimentoResponsavel

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

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

Referências: Epoch Wikipedia em milisegundos.

#2 numeroCnsResponsavel

CNS do responsável familiar.

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

Referências: Para ver o algoritmo utilizado, acesse: Cartão Net Datasus, em "Downloads" baixe o arquivo de rotina de validação Java.

#3 numeroMembrosFamilia

Quantidade de membros do núcleo familiar.

Tipo Obrigatório Mínimo Máximo
Interger Não 0 2

#4 numeroProntuario

Código do prontuário familiar na UBS.

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

Regras: Apenas letras e números.

#5 rendaFamiliar

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

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

Referências: RendaFamiliar

# resideDesde

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

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

Referências: Epoch Wikipedia em milisegundos.

#7 stMudanca

Marcador que indica se a familia mudou-se.

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

EnderecoLocalPermanencia

#1 bairro

Bairro onde está localizado o domicílio.

Tipo Obrigatório Mínimo Máximo
String Sim 1 256

#2 cep

CEP do logradouro do domicílio.

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

Regras: Apenas números.

#3 codigoIbgeMunicipio

Código IBGE do município.

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

Referências: Municipios

#4 complemento

Complemento do endereço do domicílio.

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

#5 nomeLogradouro

Nome do logradouro.

Tipo Obrigatório Mínimo Máximo
String Sim 1 256

#6 numero

Número do domicílio.

Tipo Obrigatório Mínimo Máximo
String Sim 1 10

Regras:

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

#7 numeroDneUf

Código indexador referente a Unidade Federativa.

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

Referências: Estados

#8 telReferencial

Telefone de referência.

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

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

#9 telResidencial

Telefone residencial.

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

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

#10 tipoLogradouroNumeroDne

Tipo do logradouro onde está o domicílio.

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

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.

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

CondicaoMoradia

#1 abastecimentoAgua

Código do tipo de abastecimento de água.

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

Referências: AbastecimentoDeAgua

#2 areaProducaoRural

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

Tipo Obrigatório Mínimo Máximo
Long Condicional - -

Regras: Preenchimento obrigatório caso o campo Localização = 84 (rural).

Referências: CondicaoDePosseEUsoDaTerra

#3 destinoLixo

Código do destino do lixo.

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

Referências: DestinoDoLixo

#4 formaEscoamentoBanheiro

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

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

Referências: FormaDeEscoamentoDoBanheiroOuSanitario

#5 localizacao

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

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

Referências: LocalizacaoDaMoradia

#6 materialPredominanteParedesExtDomicilio

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

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

Referências: MaterialPredominanteNaConstrucao

#7 nuComodos

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

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

#8 nuMoradores

Número de moradores do domicílio.

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

#9 situacaoMoradiaPosseTerra

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

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

Referências: SituacaoDeMoradia

#10 stDiponibilidadeEnergiaeletrica

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

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

#11 tipoAcessoDomicilio

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

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

Referências: TipoDeAcessoAoDomicilio

#12 tipoDomicilio

Código do tipo de domicílio.

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

Referências: TipoDeDomicilio

#13 tratamentoAguaDomicilio

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

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

Referências: TratamentoDeAguaNoDomicilio