Ficha de Vacinação
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 | Sim | 15 | 15 |
Regras:
- Validado por algoritmo;
- Deixa de ser obrigatório se o campo cpfCidadao for preenchido.
- 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íase.
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 vacinas
Registro das vacinas aplicadas.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
List<VacinaRowThrift> | Sim | 1 | 10 |
Regras:
- Não pode ter imunobiológicos repetidos se o campo stRegistroAnterior =
false
; - Quando o campo stRegistroAnterior =
false
, o registro da vacina deve estar de acordo com os relacionamentos de Imunobiológico x Estratégia x Dose definidos na tabela Regras de vacinação; - Quando o campo stRegistroAnterior =
true
, o registro da vacina não irá considerar os relacionamentos de Imunobiológico x Estratégia x Dose definidos na tabela Regras de vacinação.
Referência: VacinaRowThrift.
#10 dataHoraInicialAtendimento
Data e hora do início do atendimento.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | - | - |
Regras:
- Não pode ser anterior à dataAtendimento;
- Não pode ser posterior à dataHoraFinalAtendimento e à data atual.
Referência: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.
#11 dataHoraFinalAtendimento
Data e hora do fim do atendimento.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | - | - |
Regras:
- Não pode ser anterior à dataHoraInicialAtendimento;
- Não pode ser posterior à data atual.
Referência: Deve ser apresentada seguindo o padrão Epoch, convertido em milissegundos. Para realizar a conversão, pode ser utilizado o conversor Current millis.
#12 cpfCidadao
CPF do cidadão.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | 11 | 11 |
Regras:
- Somente CPF válido será aceito;
- Deixa de ser obrigatório se o campo cnsCidadao for preenchido.
- Não pode ser preenchido se o campo cnsCidadao for preenchido.
#13 condicaoMaternal
Código que indica o tipo de condição maternal.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Condicional | - | - |
Regras:
- Quando o Sexo = 0 (masculino) o campo não deve ser preenchido;
- Quando o Sexo =
1 (Feminino)
ou Sexo =5 (Indeterminado)
o campo passa a ser obrigatório e pode receber o valor1
(Nenhuma),2
(Gestante) ou3
(Puérpera);
VacinaRowThrift
#1 imunobiologico
Código do imunobiológico aplicado na vacinação.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | - | - |
Referência: Imunobiologico.
#2 estrategiaVacinacao
Código da estratégia da vacinação.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Condicional | - | - |
Regras:
- É de preenchimento obrigatório se o campo stRegistroAnterior =
false
; - Se o campo stRegistroAnterior =
true
, não é de preenchimento obrigatório e pode ser preenchido somente com o valor11 - Pesquisa
; - Este campo deverá ser preenchido com o valor da coluna Código e-SUS APS da tabela de referência.
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 | Condicional | 1 | 30 |
Regras:
- Apenas
letras
,números
,/
,.
e-
; - É de preenchimento obrigatório se o campo stRegistroAnterior =
false
.
#5 fabricante
Nome do fabricante do imunobiológico aplicado na vacinação.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | 1 | 60 |
Regras:
- Apenas
letras
,números
,/
,.
,espaço simples
e-
; - É de preenchimento obrigatório se o campo stRegistroAnterior =
false
; - Se o campo Imunobiológico =
85
, o campo deve ser preenchido com o valor =OXFORD-ASTRAZENECA
; - Se o campo Imunobiológico =
86
, o campo deve ser preenchido com o valor =SINOVAC/BUTANTAN
; - Se o campo Imunobiológico =
87
, o campo deve ser preenchido com o valor =PFIZER/BIONTECH
; - Se o campo Imunobiológico =
88
, o campo deve ser preenchido com o valor =JANSSEN-CILAG
; - Se o campo Imunobiológico =
89
, o campo deve ser preenchido com o valor =ASTRAZENECA-ChAdOx1-S
; - Se o campo Imunobiológico =
95
, o campo deve ser preenchido com o valor =GAMALEYA-SPUTNIK-V
; - Se o campo Imunobiológico =
96
, o campo deve ser preenchido com o valor =BHARAT-COVAXIN
; - Se o campo Imunobiológico =
97
, o campo deve ser preenchido com o valor =MODERNA
; - Se o campo Imunobiológico =
98
, o campo deve ser preenchido com o valor =SINOVAC-CORONAVAC
; - Se o campo Imunobiológico =
99
ou102
o campo deve ser preenchido com o valor =BIONTECH
; - Se o campo Imunobiológico =
103
o campo deve ser preenchido com o valor =COMIRNATY-PFIZER/BIONTECH
; - Se o campo Imunobiológico =
112
o campo deve ser preenchido com o valor =SERUM-INDIA
; - Se o campo Imunobiológico =
114
o campo deve ser preenchido com o valor =BEIJING
.
#6 grupoAtendimento
Grupo alvo ao qual o cidadão pertence em vacinações.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Condicional | - | - |
Regras:
- É de preenchimento obrigatório se o campo stRegistroAnterior =
false
; - Não pode ser preenchido se o campo stRegistroAnterior =
true
;
Referência: Grupo de Atendimento.
#7 stRegistroAnterior
Indica se o imunobiológico foi aplicado em um atendimento anterior.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Sim | - | - |
#8 dataRegistroAnterior
Data em que foi aplicada a vacina.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Condicional | - | - |
Regras:
- É de preenchimento obrigatório se o campo stRegistroAnterior =
true
; - Não pode ser preenchido se o campo stRegistroAnterior =
false
; - Não pode ser posterior à dataAtendimento e anterior à dtNascimento.
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.
#9 stAplicadoExterior
Utilizado para identificar se o cidadão foi vacinado no exterior.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Condicional | - | - |
Regra: Só pode ser preenchido se o campo stRegistroAnterior = true
e o campo Imunobiológico receber um dos valores 85
, 86
, 87
, 88
, 89
, 95
, 96
, 97
, 98
, 99
, 102
, 103
, 105
ou 112
pertencentes aos imunobiológicos de COVID-19. Nestas condições, é de preenchimento obrigatório.
#10 cboPrescritorCodigo2002
Código que indica o CBO do profissional prescritor.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Não | - | - |
Referência: CBOs prescritores.
Referência: CBOs específicos.
#11 cid10MotivoIndicacao
Código que indica o CID10 do motivo da prescrição.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Sim | - | - |
Regra:
- Obrigatório se estrategiaVacinacao =
02- Especial
; - Preencher o campo de string com o código CID10.
#12 stPesquisaClinica
Código que indica se a aplicação foi feita no contexto de pesquisa clínica.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Boolean | Sim | - | - |
#13 anvisaProtocoloEstudo
Número do protocolo de estudo da ANVISA.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | - | 10 |
Regra: Só pode ser preenchido e se torna obrigatório se stPesquisaClinica = true
;
#14 anvisaProtocoloVersao
Número da versão do protocolo da ANVISA.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | - | 10 |
Regra: Só pode ser preenchido e se torna obrigatório se stPesquisaClinica = true
;
#15 anvisaNumeroRegistro
Número do registro da ANVISA.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
String | Condicional | - | 10 |
Regra: Só pode ser preenchido e se torna obrigatório se stPesquisaClinica = true
;
#16 viaAdministracao
Via de administração do imunobiológico aplicado.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | 1 | 1 |
Referência: Via de administração.
#17 localAplicacao
Local em que o imunobiológico foi aplicado.
Tipo | Obrigatório | Mínimo | Máximo |
---|---|---|---|
Long | Sim | 1 | 1 |
Regras:
Os dados do campo "Local de aplicação" são validados de acordo com o campo "Via de administração".
- Se
Via de administração
=Endovenosa
, o campo deve ser preenchido com o valor =Rede venosa
; - Se
Via de administração
=Intramuscular
ouIntramuscular Profunda
, o campo deve ser preenchido com um dos valores =Vastolateral da coxa direito
,Vastolateral da coxa esquerdo
,Deltóide direito
,Deltóide esquerdo
,Dorso glúteo direito
,Dorso glúteo esquerdo
,Vastolateral da coxa direito
,Vastolateral da coxa esquerdo
,Ventro glúteo direito
,Ventro glúteo esquerdo
,Outro
; - Se
Via de administração
=Intradérmica
ouSubcutânea
, o campo deve ser preenchido com um dos valores =Face ânterolateral externa da coxa direito
,Face ânterolateral externa da coxa esquerdo
,Face ânterolateral externo do antebraço direito
,Face ânterolateral externo do antebraço esquerdo
,Face ânterolateral externa do braço direito
,Face ânterolateral externa do braço esquerdo
,Face externa superior do braço direito
,Face externa superior do braço esquerdo
,Face externa inferior do braço direito
,Face externa inferior do braço esquerdo
,Outro
; - Se
Via de administração
=Oral
, o campo deve ser preenchido com o valor =Boca
;
Referência: Local de aplicação.