Ficha de Cadastro Domiciliar e Territorial
CadastroDomiciliar
#1 animaisNoDomicilio
Lista de código dos animais no domicílio.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
List<Long> | Condicional | 0 | 4 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
CondicaoMoradia | Condicional | - | - |
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 ou99
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
EnderecoLocalPermanencia | Condicional | - | - |
Regras: Preenchimento obrigatório caso o campo statusTermoRecusa = false
.
Referências: EnderecoLocalPermanencia.
#4 familias
Lista das famílias que residem no domicílio.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
List<FamiliaRow> | Condicional | - | - |
Regras:
- Se o campo tipoDeImovel for diferente de
01
Domicílio, todas as famílias cadastradas devem ter o campo stMudanca =true
; - 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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Sim | 1 | 1 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | 0 | 2 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Condicional | - | - |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Não | - | - |
#9 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).
#10 uuid
Código UUID para identificar a ficha na base de dados nacional.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 36 | 44 |
Regras: É recomendado concatenar o CNES na frente do UUID, de modo que os 7 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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 36 | 44 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | - | - |
Referências: tipoDeImovel.
#13 instituicaoPermanencia
Informações referentes a instituição de permanência.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
InstituicaoPermanencia | Não | - | - |
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 ou11
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
UnicaLotacaoHeader | Sim | - | - |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Double | Condicional | - | 10 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Double | Condicional | - | 11 |
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.
EnderecoLocalPermanencia
#1 bairro
Bairro onde está localizado o domicílio.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 0 | 72 |
#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 | 7 | 7 |
Referências: Municipios.
#4 complemento
Complemento do endereço do domicílio.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 30 |
#5 nomeLogradouro
Nome do logradouro.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 0 | 72 |
#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 telefoneContato
Telefone para contato.
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 telefoneResidencia
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 | - | - |
#12 pontoReferencia
Indica um ponto de referência para o domicílio do cidadão.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 40 |
#13 microArea
Microárea na qual o cidadão se encontra.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | 2 | 2 |
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.
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:
- 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 ou11
Delegacia; - Não deve ser preenchido se o campo localizacao =
83 - Urbana
.
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 da 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 | - | - |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 2 |
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 ou11
Delegacia. - Não pode ser preenchido com o valor "0" (zero).
#8 nuMoradores
Número de moradores do domicílio.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 4 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | - | - |
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.
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 | - | - |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Não | - | - |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Não | - | - |
Referências: AguaConsumoDomicilio.
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: 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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 15 | 15 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Integer | Não | 0 | 2 |
Regras: Não pode ser preenchido com o valor "0" (zero).
#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.
#6 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 | - | - |
Regras: Não pode ser posterior à data atual.
Referências: Epoch Wikipedia em milissegundos.
#7 stMudanca
Marcador que indica se a familia mudou-se.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Não | - | - |
#8 cpfResponsavel
CPF do responsável.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 11 | 11 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 100 |
#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).
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Não | - | - |
#3 nomeResponsavelTecnico
Indica o nome do responsável técnico da instituição de permanência.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 3 | 70 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 15 | 15 |
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.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | 0 | 100 |
#6 telefoneResponsavelTecnico
Indica o telefone para contato do responsável técnico da instituição de permanê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).