FichaVacinacaoMaster

#1 uuidFicha

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

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

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.

#2 tpCdsOrigem

Tipo de origem dos dados do registro.

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

Regra: Utilizar valor 3 (sistemas terceiros).

#3 headerTransport

Profissional que realizou a vacinação.

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

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

Referência: UnicaLotacaoHeader.

#4 vacinacoes

Lista de registros de Vacinação.

Tipo Obrigatório Mínimo Máximo
List<FichaVacinacaoChild> Sim 1 99

Referência: FichaVacinacaoChild.

FichaVacinacaoChild

#1 turno

Código do turno onde aconteceu o atendimento.

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

Referência: Turno.

#2 numProntuario

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

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

#3 cnsCidadao

CNS do cidadão.

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

Regras:

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

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

#4 dtNascimento

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

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

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.

#5 sexo

Código do sexo do cidadão.

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

Referência: Sexo.

#6 localAtendimento

Código do local onde o atendimento foi realizado.

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

Regra: Apenas valores de 1 a 10.

Referência: LocalDeAtendimento.

#7 viajante

Marcador que indica se o cidadão é viajante.

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

#8 comunicanteHanseniase

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

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

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.

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

Regras:

  • Não pode ser preenchido quando Sexo = 0 (masculino);
  • Não pode ser preenchido ser for marcado o campo puerpera.

#10 puerpera

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

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

Regras:

  • Não pode ser preenchido quando Sexo = 0 (masculino);
  • Não pode ser preenchido ser for marcado o campo gestante.

#11 vacinas

Registro das vacinas aplicadas.

Tipo Obrigatório Mínimo Máximo
List<VacinaRowThrift> Sim 1 10

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

Referência: VacinaRowThrift.

#12 dataHoraInicialAtendimento

Data e hora do início do atendimento.

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

Regras:

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.

#13 dataHoraFinalAtendimento

Data e hora do fim do atendimento.

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

Regras:

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.

#14 cpfCidadao

CPF do cidadão.

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 cnsCidadao for preenchido.

VacinaRowThrift

#1 imunobiologico

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

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

Regra: Se o imunobiologico for igual a 85, 86, 87 ou 88 é obrigatório o preenchimento do cnsCidadao ou do cpfCidadao.

Referência: Imunobiologico.

#2 estrategiaVacinacao

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

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

Referência: EstrategiaVacinacao.

#3 dose

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

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

Referência: Dose.

#4 lote

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

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

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

#5 fabricante

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

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

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

#6 grupoAtendimento

Grupo alvo ao qual o cidadão pertence em vacinações de campanha.

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

Regra: Só pode ser preenchido se o campo estrategiaVacinacao = 5 (Campanha). Neste caso o preenchimento é obrigatório.

Referência: Grupo de Atendimento.