CliNiv-API é uma API Rest criada inicialmente como doação para hospitais que não possuem nenhuma solução de automação no processo de prontuário. O CliNiv-API é integrado com um client baseado em Angular, o CliNiv-UI.
Atualmente encontra-se na versão 1.1.0 Swagger
- Funcionalidades da API
- Mínimo para rodar
- Configurando banco de dados
- Como rodar a API?
- Como contribuir?
- Contato
- License
- Cadastro de Pacientes
- Cadastro de Responsáveis (Enfermeiro, Médico, Técnico, etc)
- Cadastro de Eventos (Consultas, exames, prescriçoes, etc)
- Cadastro de Usuários
- Controle de Acesso
- Armazenamento de documentos (Resultado de exames, radiografia, tumografia, etc)
- Histórico de visita em forma de timeline
- Relatórios
- Paciente não identificado
- Fluxo padrão para atendimento ambulatorial
- Fluxo padrão para atendimento emergencial
- Cadastro de medicamentos e materiais
- Prescrição
- Anamnese
- Customização de relatórios
- Cadastro de operadoras de saúde
- Cadastro de procedimentos
- Cadastro de setores
Para rodar o projeto, existem alguns requisítos mínimos de configurações, são eles:
- Java 21 (Obrigatório)
- MariaDB Server 10.5+ (Obrigatório se não for rodar via docker)
- IntelliJ, Eclipse ou STS (Obrigatório)
- Docker **(Obrigatório se for rodar via script)
Para que seja possível rodar a aplicação, faz-se necessário configurar previamente as informações de conexão no
arquivo application-prod.properties
deste projeto.
Um setup inicial válido para uma base nova pode seguir os padrões abaixo:
-
URL de conexão da base
spring.datasource.url=jdbc:mariadb://[SERVIDOR]:[PORTA]
. -
No meu caso, a primeira linha do meu
application-prod.properties
ficaspring.datasource.url=jdbc:mariadb://localhost:3306
-
As duas linhas seguintes servem para você informar o usuário e a senha de conexão.
-
Não informamos o nome da base neste momento porque a aplicação possui um sistema de múltiplas bases. Isto será explicado mais abaixo.
O projeto possui um build pronto do MariaDB em Docker, neste caso não precisamos alterar nada, basta executar o
shellscript ./run-mariadb.sh
e seguir para o próximo passo.
OBS: Obrigatório ter o Docker instalado.
-
URL de conexão da base
spring.datasource.url=jdbc:mariadb://[SERVIDOR]:[PORTA]
. -
No meu caso, a primeira linha do meu
application-prod.properties
ficaspring.datasource.url=jdbc:mariadb://localhost:3306
-
As duas linhas seguintes servem para você informar o usuário e a senha de conexão.
-
Não informamos o nome da base neste momento porque a aplicação possui um sistema de múltiplas bases. Isto será explicado mais abaixo.
A base de dados deve ser criada manualmente no MariaDB em ambos os casos. A diferença entre elas é que com o Docker não há a necessidade de instalação do banco, facilitando o desenvolvimento.
- 👯 Clone este repositório na sua máquina local usando
https://github.com/niv-labs/cliniv-api.git
-
🔃 Rode o script
./startWithDocker.sh
-
OBS: Obrigatório ter o Docker instalado.
- 👯 Clone este repositório na sua máquina local usando
https://github.com/niv-labs/cliniv-api.git
- ✅ Importe o projeto na sua IDE
- 🔃 Rode a aplicação com botão direito do mouse no projeto,
run as
>Spring Boot App
. Também é possível rodar a aplicação à partir da classeApplicationMain
dentro do projeto, basca clicar com o botão direito na classe e seguir o mesmo fluxo.
- Se você estiver usando o Eclipse, pode ser uma boa ideia baixar o plugin disponibilizado pela Pitoval no marketplace,
o
Spring Tools 4 (release)
.
- A aplicação utiliza um sistema de múltiplas conexões, para que a API saiba qual base se conectar, deve-se informar o
nome da mesma via cabeçalho com a chave
CUSTOMER_ID
.
- Checar todas as properties necessárias para levantar o ambiente olhando no arquivo
application.propeties
.
- 🍴 Realize um Fork deste respositório!
- 👯 Clone este repositório na sua máquina local usando
https://github.com/niv-labs/cliniv-api.git
- 🎋 Crie sua branch de funcionalidade usando
git checkout -b minha-funcionalidade
- ✅ Realize o commit de suas alterações usando
git commit -m 'feat: Minha nova funcionalidade'
;
- 📌 Realize o push para a branch usando
git push origin minha-funcionalidade
;
- 🔃 Crie um novo pull request
Depois que seu Pull Request é aceito e o merge é realizado, você pode deletar a sua branch de funcionalidade.
Esta área especifica definições técnicas da aplicação, suas características e comportamentos.
Você pode me encontrar por aqui...
- NiV Labs :: NiV Labs
- Atendimento :: atendimento@nivlabs.com.br
- Vinícios (eu) :: viniciosrodrigues@nivlabs.com.br
Você pode baixar os manuais aqui...
- Manual do Usuário Final :: Download
Este projeto é licenciado por MIT License - Veja a licença no arquivo LICENSE para mais detalhes.