Nidus-vacinacao-req-ptbr

Projet o Nidus Ce n t r o d e Pe s q u i s a , D e s e n v o l v i m e n t o e En g e n h a r i a d e So f t w a r e Li v r e

Siste m a de Controle de Vacinação Especificação de Requisitos

Identificador do Documento:

Nidus -Vacinação- REQ-ptBr

Versão:

1.1

Data:

30- 03- 2006

Localização:

/var/comum/Repositorio VACINACAO/UML/Analise

Histórico d e revisões Versão

Data

Autor

Descrição

Localizaçã o

1.0 BETA

31/Out/20 0 5

Fabiano Jacoboski

Descrição da primeira versão do documento

1.1

30/03/2005

Leandro

Descrição versão definitiva documento

/var/comum/Rep ositorio VACINACAO/UML /Analise /var/comum/Rep ositorio VACINACAO/UML /Analise

da do

1 . In t rodução 1.1 Propósito Este docu me n t o especifica os requisitos do Siste m a de Controle de Vacinaç ã o a ser desenvolvido pelo Nidus, fornec e n d o ao cliente e aos desenvolvedor e s as inform a ç õ e s necess á ri a s para o projeto e impleme n t a ç ã o, assim como realizaç ão dos testes e homolog a ç ã o do siste m a.

1.2 Público Alvo Este docu me n t o se destin a ao cliente, arquite tos de softwar e, engen h ei ro s de softwa r e e testa do r e s.

1.3 Escopo Este docu me n t o realiza a especificaç ão de requisitos do Siste m a de Controle de Vacinaçã o.

1.4 Metodologia de Desenvolvimento O sistem a deve seguir a metodologia de desenvolvimen to de softwa r e do Nidus, propost a nos seguinte s planos: SPMP[4], PGQS[5], SCMP[6].

1.5 Visão geral do documento Na seç ã o 1 : é apres e n t a d a a introd u ç ã o do docum e n t o; Na Se ç ã o 2 : é apre s e n t a d a uma visão geral do Sistem a de Controle Vacinaçã o, cara ct e riz a n d o qual é o seu escopo e descr ev e n d o seus usuá rios; Na S eçã o 3 : são enum e r a d o s todos os requisitos funcionais. Na Se ç ã o 4 : são enum e r a d o s os requisitos não- funcion ais do sistem a. Na S eçã o 5 : são especifica do s os casos de uso.

2. Visão Geral do Produto O objetivo geral do Sistem a de Controle de Vacinaç ão é gere ncia r as pacient e s, vacinaçõe s e camp a n h a s de vacinaç ã o. O sistem a possuir á módulos de cada st ro s, consulta s e relatórios onde o usuá rio pode r á obter as inform a ç õ e s a qualq u e r momen to e quem qualqu e r lugar que ofereç a acesso a intern e t. As tecnologia utilizada s para o criaçã o desta ferra m e n t a são: –

Modela g e m : Poseidon e DBDesign e r

–

Desenvolvime n to: Eclipse

–

Lingua g e m de progr a m a ç ã o: PHP

–

Interfac e com usuá rio: Páginas Web Dinâmica s

2.1 Descrição dos usuários As pesso as que poder ã o utilizar o sistem a são: –

Administr a d o r

–

Usuá rios

2.2 Premissas e restrições A Infra- estru t u r a necess á ri a a implant a ç ã o do siste m a no lado do Cliente é a que segue: Equipa m e n t o: 1 (um) Microcom p u t a d o r não inferior a um Pentium III, ou equivale nt e, com um HD de, pelo menos, 10 GB que funciona r á como servidor Proxy, de Banco de Dados e Web. O sistem a opera cion al será uma distribuiç ão Linux a ser escolhida. Observa ç ã o: O cliente pode r á ainda hospe d a r esses serviços, por sua própria conta, em um provedor de sua prefer ê n ci a. Respons a bilida d e s: Cliente: O cliente deve arca r com a manu t e n ç ã o dos servidor e s, assim como se respons a bilizar pelas cópias de segur a n ç a (backu p) de seus dados. O cliente dever á tamb é m provide ncia r todos recu r so s huma n o s para a opera ç ã o do sistem a . Nidus: O projeto se respons a biliza pelo suport e ao uso do softwa r e dese nvolvido para o seu propósito, bem como, antes de sua instalaç ão, efetu a r os devidos testes para seu funciona m e n t o. Todos recur sos do sistem a serão apres e n t a d o s aos opera do r e s atravé s de treina m e n t o, seja no client e ou no Nidus.

2.1 Descrição dos usuários São apres e n t a d o s dois tipos de usuá rios, os Administr a d o r do Siste m a e o Usuá rio Comum, para o qual cabe ao Administr a d o r do Siste m a dar as devida s permissõ e s. O usuá rio deverá ter tempo e disponibilida d e para realizar o teste por completo.

2.2 Premissas e restrições A FACCAT disponibilizar á as máquin a s para para funciona m e n t o do softwar e, conforme por parte do Nidus fornec e r a aplicaç ão arquivo de deployment e scripts para a criação

deployment e toda a infra- estr ut u r a foi solicitado pelo cliente, ficando em pleno funciona m e n t o, com o da base de dados.

3. Requisitos Funcionais 3.1 [RF001] Cadastros de usuários O sistem a deve permitir cadast r o de usuá rios com as respe c tiva s permissõe s: criar, alter a r, excluir, busca r nos usuá rios, pacient e s, vacinas e camp a n h a s .

3.2 [RF002] Cadastro de pacientes O sistem a deve permitir ao administr a d o r ou ao usuá rio, o cadast r o de pacient e s conte n do os campos nome, ende r e ç o, RG, CPF, telefone, ende r e ç o, email, data e certid ão de nascime n t o, filiação, sexo.

3.3 [RF003] Cadastro de vacinas O sistem a deve permitir o cadast ro de vacinas conten do os campos nome da vacina, descriçã o, faixa etária para aplicaç ã o, duraç ã o da imunida d e, doenç a s evitad a s, quantid a d e de doses.

3.4 [RF004] Ficha de vacinação O sistem a deve permitir que os pacient e s tenha uma ficha de vacinaç ã o conte n do data de aplicaç ã o das vacinas, lote que a vacina que foi aplicad a pert e n c e, dose da vacina que foi aplicad a e a valida d e da vacina (tempo de imunida d e) .

3.5 [RF005] Cadastro de posto O sistem a deve permitir o cadast ro do posto onde são aplicad a s as vacina s conte n do o campo nome do posto e o nome do respon s áv el pelo posto.

3.6 [RF006] Cadastro de Campanhas de Vacinação O sistem a deve permitir o cadast ro de camp a n h a s de vacinaç ã o conten do o período da camp a n h a , nome da camp a n h a e quais vacinas serão aplicad a s/dispo nibiliza d a s nest a camp a n h a .

3.7 [RF007] Vacinação O sistem a deve monta r a ficha / cade r n e t a de vacinaç ã o de um pacient e, quan do este comp a r e c e r para receb e r vacina s, conten d o as vacinas já aplicad a s e mostr a n d o, base a d o na sua data de nascime n to e na camp a n h a , quais vacinas ele deve toma r. Após a aplicaç ão da vacina, o sistem a deve permitir que seja impresso o comprova n t e de vacina, que pode ser emitido a qualqu e r mome nto.

3.5 [RF005] Estatística de vacinas O sistem a deve gera r um relatório de vacina s aplicad a s em um dete r mi n a d o período.

4. Requisitos Não Funcionais 4.1 [RNF001] Usabilidade A naveg aç ã o deve ser simplificad a de modo a torna r o sistem a produtivo e fácil de usar. Deve utilizar a nome ncl a t u r a própria da áre a de saúde.

4.2 [RNF002] Acessibilidade O sistem a deve permitir acesso comp ut a d o r com acesso a intern e t.

de qualqu e r

local que

dispon h a

de um

4.3 [RNF003] Hardware e Software Máquin a Servidor : Requisitos de softwar e: 1. Apache 2 2. Banco de banco de dados Postgre s SQL. Requisitos de mínimos de Hard w a r e : 1. Process a d o r 800 MHZ. 2. Memória RAM de 128 mb. 3. Disco Rígido de 10 gb. Máquin a Cliente : Qualqu e r máquin a com acesso a intern e t que possu a um naveg a d o r (browse r) Intern e t Explore r, NetSc a p e ou Mozilla, mais uma impresso r a jato de tinta.

5. Casos de uso 5.1 Caso de Uso 001: Cadastrar Usuários 5.1.1 Breve descrição Este caso de uso permit e ao Administra d o r cadast r a r usuá rios.

5.1.2 Fluxo de eventos 5.1. 2 . 1 Flux o bási c o Este caso de uso inicia quan do o Administr a d o r do Sistem a clica no botão Usuá rios. O sistem a apres e n t a uma nova janela com as opções: Criar, Pesquis a r e Listar. Opção Criar : O sistem a apres e n t a um formulá rio com os campos: Nome, ende r e ç o, Bairro, Cidade, Estado, Telefone, e-Mail, CPF, RG, data de nascime n t o, sexo, grupo de usuá rios a qual ele perte n c e, login e senh a que deve ser criptog r afa d a . O ator pree n c h e os dados e subme t e o formulá rio. O sistem a validad a os dados, cadast r a o usuá rio e retor n a ao menu anterio r. Opção Pesquisa r : O sistem a apres e n t a um formulá rio solicitan do o código ou o nome do usuá rio a pesq uisa r. O ator pree n c h e um dos dados e subm et e o formulá rio. O siste m a pesq uisa o usuá rio e apres e n t a todos os dados do usuá rio (exceto a senha) em uma tela, pede confirm a ç ã o e retorn a ao menu ante rio r. Opção Listar : O siste m a apres e n t a a relaçã o de todos usuá rios com opção para

marc á- los. Após marc a r Excluir ou Mostra r.

o(s) usuá rio(s) deseja do(s) o ator escolhe Altera r,

–

Altera r : Nesta opção o sistem a apres e n t a todos os dados do usuá rio escolhido em uma tela, o ator alter a os dados desejado s e subme t e o formulá rio. O siste m a valida os dados e atualiza o cada st r o e retorn a ao menu ante rior.

–

Excluir : Nesta, e somen t e nesta opção, o ator pode ter marc a d o mais de um usuá rio antes de ter marc a d o a opção de exclusão. O sistem a solicita confirm a ç ã o, exclui o(s) usuá rio(s) do sistem a e retorn a ao menu ante rio r.

–

M ostra r : Nesta opção o sistem a apres e n t a todos os dados do usuá rio escolhido em uma tela. O sistem a solicita confirm a ç ã o e retor n a ao menu ante rio r.

5.1. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.1.3 Pré-condições Grupo s de Per m i s s õ e s Os grupos de permissõ e s previa m e n t e cada st r a d o s.

ao qual

o usuá rio

vai perte n c e r

devem

esta r

5.2 Caso de Uso 002: Cadastrar Pacientes 5.2.1 Breve descrição Este caso de uso permit e ao Usuá rio cadast r a r pacient e s.

5.2.2 Fluxo de eventos 5.2. 2 . 1 Flux o bási c o Este caso de uso inicia quan do um Usuário clica no botão Pacient e s. O sistem a apre se n t a uma nova janela com as opções: Criar, Pesquisa r e Listar. Opção Criar : O sistem a apres e n t a um formulá rio com os campos: Nome, ende r e ç o, Bairro, Cidade, Estado, Telefone, e-Mail, CPF, RG, data de nascime n t o, sexo, Certidão de Nascim e n t o(n ú m e r o, livro e págin a), filiação (nome do pai, mãe e respon s áv el). O ator pree n c h e os dados e subme t e o formulá rio. O siste m a validad a os dados e cada st r a o pacient e e retor n a ao menu ante rio r. Opção Pesquisa r : O sistem a apres e n t a um formulá rio solicitan do o código ou o nome do pacient e a pesquis a r. O ator pree n c h e um dos dados e subme t e o formulá rio. O siste m a pesq uisa o pacient e e apres e n t a todos os dados do pacient e em uma tela, pede confirm a ç ã o e retorn a ao menu ante rior. Opção Listar : O siste m a apres e n t a a relaçã o de todos pacient e s com opção para marc á- los. Após marc a r o(s) usuá rio(s) deseja do(s) o ator escolhe Altera r,

Excluir ou Mostra r. –

Altera r : Nesta opção o sistem a apres e n t a todos os dados do pacient e escolhido em uma tela, o ator alter a os dados desejado s e subme t e o formulá rio. O siste m a valida os dados e atualiza o cada st r o e retorn a ao menu ante rior.

–

Excluir : Nesta, e somen t e nesta opção, o ator pode ter marc a d o mais de um pacient e antes de ter marc a d o a opção de exclusão. O sistem a solicita confirm a ç ã o, exclui o(s) pacient e(s) do sistem a e retorn a ao menu ante rio r.

–

M ostra r : Nesta opção o sistem a apres e n t a todos os dados do pacient e escolhido em uma tela. O sistem a solicita confirm a ç ã o e retor n a ao menu ante rio r.

5.2. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.3 Caso de Uso 003: Cadastrar Vacinas 5.3.1 Breve descrição Este caso de uso permit e ao Usuá rio cadast r a r vacina s.

5.3.2 Fluxo de eventos 5.3. 2 . 1 Flux o bási c o Este caso de uso inicia quan do um Usuário clica no botão Vacinas. O siste m a apre se n t a uma nova janela com as opções: Criar, Pesquisa r e Listar. Opção Criar : O sistem a apres e n t a um Descriç ão, Faixa etária para Vacinaç ão imunida d e, Doenç as evitad a s, Quantid a d e subm et e o formulá rio. O sistem a validad a ao menu ante rior.

formulá rio com os campos: Nome, (início e fim), Tempo de duraç ã o da de Doses. O ator pree n c h e os dados e os dados, cada st r a a vacina e retor n a

Opção Pesquisa r : O sistem a apres e n t a um formulá rio solicitan do o código ou o nome da vacina a pesq uis a r. O ator pree n c h e um dos dados e subm et e o formulá rio. O siste m a pesq uisa a vacina e apre s e n t a todos os dados em uma tela, pede confirm a ç ã o e retorn a ao menu anterior. Opção Listar : O sistem a apres e n t a a relaçã o de todas vacinas com opção par a marc á- las. Após marc a r a(s) vacina(s) desejad a(s) o ator escolhe Altera r, Excluir ou Mostra r. –

Altera r : Nesta opção o sistem a apre s e n t a todos os dados da vacina escolhida em uma tela, o ator alter a os dados deseja do s e subm et e o formulá rio. O siste m a valida os dados, atualiza o cadas t ro e retor n a ao menu ante rio r.

–

Excluir : Nesta, e somen t e nesta opção, o ator pode ter marc a d o mais de uma vacina antes de marc a r a opção de exclusã o. O sistem a solicita

confirm a ç ã o, exclui a(s) vacina(s) do sistem a ante rio r. –

e retorn a

ao menu

M ostra r : Nesta opção o sistem a apre s e n t a todos os dados da vacina escolhida em uma tela. O sistem a solicita confirm a ç ã o e retorn a ao menu ante rio r.

5.3. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.4 Caso de Uso 004: Cadastrar Posto 5.4.1 Breve descrição Este caso de uso permit e ao Administra d o r do Sistem a cadast r a r os dados do Posto de Saúde.

5.4.2 Fluxo de eventos 5.4. 2 . 1 Flux o bási c o Este caso de uso inicia qua nd o um Usuá rio clica no botão Postos. O sistem a apre se n t a um formulá rio com os campos: Nome do Posto e dispõe uma relaç ão dos usuá rios para que se marq u e o usuá rio que é o Respons áv el pelo posto. O ator pree n c h e os dados e subme t e o formulá rio. O sistem a valida d a os dados e atualiza o cadast ro e retor n a ao menu anterior.

5.4. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.4.3 Pré-condições Us u ár i o s Os usuá rios que forem escolhidos como respons áv eis devem esta r previa m e n t e cada st r a d o s.

5.5 Caso de Uso 005: Cadastrar Campanhas de Vacinação 5.5.1 Breve descrição Este caso de uso permit e ao Usuá rio cadast r a r as Camp a n h a s de Vacinaç ã o.

5.5.2 Fluxo de eventos 5.5. 2 . 1 Flux o bási c o Este caso de uso inicia quan do um Usuário clica no botão Camp a n h a s . O sistem a apres e n t a uma nova janela com as opções: Criar, Pesquisa r e Listar.

Opção Criar : O sistem a apres e n t a um formulá rio com os campos: Nome, Período da Campa n h a e a relaç ão das vacinas cadast r a d a s no sistem a. O ator pree n c h e os dados, marc a as vacinas que vão compor a camp a n h a e subme t e o formulá rio. O siste m a validad a os dados, cadast r a a camp a n h a e retor n a ao menu ante rio r. Opção Pesquisa r : O sistem a apres e n t a um formulá rio solicitan do o código ou o nome da camp a n h a a pesq uisa r. O ator pree n c h e um dos dados e subm et e o formulá rio. O siste m a pesquisa a vacina e apres e n t a todos os dados (Nome, Período e relaç ão de vacina s que perte n c e m a camp a n h a ) em uma tela, pede confirm a ç ã o e retorn a ao menu ante rior. Opção Listar : O siste m a apres e n t a a relaçã o de todas camp a n h a s com opção para marc á- las. Após marc a r a(s) vacina(s) deseja d a (s) o ator escolhe Altera r, Excluir ou Mostra r. –

Altera r : Nesta opção o sistem a apre s e n t a todos os dados da camp a n h a escolhida em uma tela, o ator alter a os dados deseja do s e subm et e o formulá rio. O siste m a valida os dados, atualiza o cadas t ro e retor n a ao menu ante rio r.

–

Excluir : Nesta, e somen t e nesta opção, o ator pode ter marc a d o mais de uma camp a n h a antes de marc a r a opção de exclusão. O siste m a solicita confirma ç ã o, exclui a(s) camp a n h a ( s) do siste m a e retorn a ao menu ante rio r.

–

M ostra r : Nesta opção o sistem a apres e n t a todos os dados da camp a n h a escolhida em uma tela. O sistem a solicita confirma ç ã o e retorn a ao menu ante rio r.

5.5. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.5.3 Pré-condições Vacin a s As vacinas que vão perte n c e r previa m e n t e cada st r a d a s .

a

camp a n h a

de

vacinaç ã o

devem

esta r

5.6 Caso de Uso 006: Cadastrar Grupos de Usuários 5.6.1 Breve descrição Este caso de uso permit e ao Administra d o r cadast r a r os Grupos de Usuários e as permissõ e s que eles possue m sobre as tabelas existe nt e s no sistem a .

5.6.2 Fluxo de eventos 5. 6. 2 . 1 Flux o bá si c o Este caso de uso inicia qua nd o um Usuá rio clica no botão Grupos. O siste m a apre se n t a uma nova janela com as opções: Criar, Pesquisa r e Listar.

Opção Criar : O sistem a apres e n t a um formulá rio com os campos: Nome, Descriç ão e Tipo de Usuário. O siste m a relacion a todas tabelas do sistem a com opção par a marc a r o as permissõe s sobre cada tabela, quais sejam, alter a r, criar, excluir e busc a r. O ator pree nc h e os dados e subme t e o formulá rio. O sistem a validad a os dados, cadast r a o grupo e retorn a ao menu ante rior. Opção Pesquisa r : O sistem a apres e n t a um formulá rio solicitan do o código ou o nome do grupo a pesquisa r. O ator pree n c h e um dos dados e subme t e o formulá rio. O siste m a pesq uisa o grupo e apres e n t a todos os dados, permissõ e s inclusive, em uma tela, pede confirma ç ã o e retorn a ao menu ante rior. Opção Listar : O siste m a apres e n t a a relaçã o de todos grupos com opção para marc á- los. Após marc a r o(s) grupos(s) desejado(s) o ator escolhe Altera r, Excluir ou Mostra r. –

Altera r : Nesta opção o sistem a apre s e n t a todos dados do grupo escolhido, permissõ e s inclusive, em uma tela, o ator alter a os dados desejado s e subme t e o formulá rio. O siste m a valida os dados, atualiza o cadast ro e retor n a ao menu anterio r.

–

Excluir : Nesta, e somen t e nesta opção, o ator pode ter marc a d o mais de um grupo antes de marc a r a opção de exclusão. O siste m a solicita confirm a ç ã o, exclui o(s) grupos(s) do sistem a e retorn a ao menu ante rio r.

–

M ostra r : Nesta opção o sistem a apres e n t a todos os dados do grupo, permissõ e s inclusive, escolhida em uma tela. O sistem a solicita confirm a ç ã o e retorn a ao menu ante rior.

5. 6. 2 . 2 Flux o Alter n a t i v o Cam p o s inváli d o s Os campos devem esta r pree n c hi dos de acordo com o domínio do atributo. O ator receb e alert a s de que o(s) campo(s) não está(ão) devida m e n t e pree n c hi do(s).

5.7 Caso de Uso 007: Estatística 5.7.1 Breve descrição Este caso de uso permit e ao Usuá rio emitir estatística de vacinas aplicad a s em um dete r mi n a d o período.

5.7.2 Fluxo de eventos 5. 7. 2 . 1 Flux o bá si c o Este caso de uso inicia quan do um Usuário clica no botão Estatística s. O sistem a apres e n t a um formulá rio solicitan do o período para gera ç ã o do relatório. Logo após o siste m a execut a a pesquis a no banco de dados e gera o relatório na tela, disponibilizand o opção para impress ã o.

5.8 Caso de Uso 008: Aplicar Vacina 5.8.1 Breve descrição Este caso de uso permit e ao Usuá rio registr a r a aplicaç ão das vacinas feitas nos

pacient e s que comp a r e c e m ao posto de saúde, bem como, emitir o comprova n t e de vacinaç ão.

5.8.2 Fluxo de eventos 5. 8. 2 . 1 Flux o bá si c o Este caso de uso inicia qua nd o um Usuá rio clica no botão Vacina r. O siste m a apre se n t a um formulá rio solicitan do o código ou o nome do pacient e. Logo após o sistem a execut a a pesquis a no banco de dados e “monta a ficha” do pacient e, apre se n t a n d o as vacinas já aplicad a s (nome, data de aplicaç ão, lote e dose e data de término da imunida d e), as vacinas que ele deixou de aplica r, as que ele deve aplica r neste dia e as que ele ainda deve aplica r. O siste m a mostr a um indicado r de cor; verde vermelho, ama r elo e branco (semáforo), respe c tiva m e n t e. O usuá rio marc a as vacinas que ele vai aplicar (opção de marc a r somen t e nas vacina s que devem ser aplicad a s nesse dias - marc a ama r el a). O usuá rio subm et e o formulá rio, o siste m a solicita confirm a ç ã o, atualiza as vacinaçõe s, disponibiliza a opção par a “impre s s ã o do comprova n t e de vacinaç ão” e retorn a ao menu ante rior.

5.9 Caso de Uso 009: Imprimir comprovante de vacinação 5.9.1 Breve descrição Este caso de uso permit e ao Usuá rio imprimir o comprova n t e de vacinaç ã o.

5.9.2 Fluxo de eventos 5. 9. 2 . 1 Flux o bá si c o Este caso de uso inicia qua nd o um Usuá rio clica no botão Comprova nt e. O sistem a apres e n t a um formulá rio solicitan do o código ou o nome do pacient e, e o período para relacion a r as vacina s no comprova n t e. O siste m a execut a a pesq uis a no banco de dados, imprim e o comprova n t e e retor n a ao menu ante rio r.