Especificação técnica para integração com o Easyvet X SGV

Owned by Renan Mitsuo Oka
Last updated: dez. 14, 2023
11 min read

Manual ilustrativo para sistemas terceiros se comunicarem com o Easyvet via JSON.

Versão

Proprietário

Nota

Data

Versão

Proprietário

Nota

Data

1.0

@Renan Mitsuo Oka

Criação de documento

10/12/2020

 1.1

@Renan Mitsuo Oka

 Inclusão do campo ficha e alteração do desenho fluxo de trabalho

11/12/2020

1.2

@Renan Mitsuo Oka

Inclusão de URL API e alteração de ex. Json

26/01/2021

1.3

@Renan Mitsuo Oka

Inclusão dos testes via postman

27/01/2021

1.4

@Renan Mitsuo Oka

Inclusão de URL de visualização de laudo

28/01/2021

1.5

@Renan Mitsuo Oka

Inclusão de requisitos

01/02/2021

1.6

@Renan Mitsuo Oka

Alteração de URL

03/02/2021

1.7

@Renan Mitsuo Oka

Inclusão do retorno de cod. barras no json retorno.

09/02/2021

1.8

@Renan Mitsuo Oka

Inclusão de campo na rotina de retorno da etiqueta de cod. de barras, alteração do desenho de fluxo de trabalho

10/02/2021

1.9

@Renan Mitsuo Oka

Correção do json de envio inclusão e alteração incluido campo ficha

24/02/2021

2.0

@Renan Mitsuo Oka

Inclusao da regra de ficha + convenio

26/02/2021

2.1

@Renan Mitsuo Oka

Inclusão do campo nomevet

08/03/2021

2.2

@Renan Mitsuo Oka

Inclusão de novos tubos

09/03/2021

2.3

@Renan Mitsuo Oka

Inclusão de campo obs_grupo1, campo deverá conter o material a ser enviado ao selecionar OUTROS.

11/03/2021

2.4

@Renan Mitsuo Oka

Inclusão de mensagens de retorno

17/05/2021

2.5

@Renan Mitsuo Oka

Inclusão de URL envia SGV

09/11/2022

2.6

@Renan Mitsuo Oka

Inclusão de campo empresa_id

07/06/2023

URL DE API Produção e Homologação

Produção
https://portal4.softeasy.com.br/api/recebeRequisicaoVet

Homologação
http://portal4.softeasy.com.br/api/recebeRequisicaoVet

Requisitos de integração

Deverá ser mapeado o De/para de cad. clinica no SGV (Cada unidade terá seu código de cadastro de clinica).

Deverá ser mapeado o De/para de raça e especie.

Deverá ser mapeado o De/para de exames.

 

TERMO DE CONFIDENCIALIDADE

Este documento é de propriedade da SOFTEASY. As informações aqui contidas são confidenciais e têm caráter técnico e informativo.

O mesmo não poderão ser copiadas ou reproduzidas sem a autorização da Softeasy.

Instrução

O uso da tecnologia json permite a comunicação indireta entre o sistema de gestão veterinária e os diversos sistemas utilizados pelos laboratórios de apoio ou terceirizados, tornando o processo de envio de exames e recebimento de resultados mais ágil, rápido e seguro.

 Pré-requisitos do sistema de laboratório para integração

  • O sistema o laboratório de apoio ou terceiro deverá disponibilizar um json que fará a comunicação com o Easyvet.

  • Para criação deste json, foi disponibilizado o manual Processo de envio, alteração e exclusão de solicitação de exames.

  • O sistema do laboratório de apoio ou terceiro deverá ser capaz de enviar e receber os dados do tutor, exames, materiais, conforme cadastrados no sistema de gestão veterinária Easyvet.

Desenho de fluxo de dados

Dados a serem trafegados no processo

Os dados a serem integrados, envolvem dados de solicitação de exames, conforme modelos abaixo:

Requisição de solicitação

O método a ser criado no json do sistema do laboratório terceiro deverá ser capaz de enviar os seguintes dados:

Solicitação de inclusão

Parâmetros

Formato

Obrigatório

Descrição

nome

String(50)

SIM

Nome do animal

proprietario

String(50)

SIM

Nome do proprietário(Tutor)

anos

string(3)

SIM

Idade de vida do animal

meses

string(2)

NÃO

Meses de vida do animal

dias

string(2)

NÃO

Dias de vida do animal

crmvet

string(10)

SIM

CRMV do médico veterinário

ufcrmvet

string(2)

SIM

UF do CRMV

obs

string(200)

NÃO

Observação do animal

dataenvio

Date

SIM

Data de envio

horaenvio

String(5)

SIM

Hora de envio

sexo

numeric(1)

SIM

Sexo do animal(1- Macho e 2- Fêmea)

tampaverde

numeric(1)

SIM

Recipiente\Material de envio

medulaossea

numeric(1)

SIM

Recipiente\Material de envio

sanguetotal

numeric(1)

SIM

Recipiente\Material de envio

soro

numeric(1)

SIM

Recipiente\Material de envio

sangueedta

numeric(1)

SIM

Recipiente\Material de envio

swabnasa

numeric(1)

SIM

Recipiente\Material de envio

swaborofaringeo

numeric(1)

SIM

Recipiente\Material de envio

swabocular

numeric(1)

SIM

Recipiente\Material de envio

swabouvido

numeric(1)

SIM

Recipiente\Material de envio

swabpele

numeric(1)

SIM

Recipiente\Material de envio

liquidocavitario

numeric(1)

SIM

Recipiente\Material de envio

liquor

numeric(1)

SIM

Recipiente\Material de envio

urina

numeric(1)

SIM

Recipiente\Material de envio

fezes

numeric(1)

SIM

Recipiente\Material de envio

liquidoascitico

numeric(1)

SIM

Recipiente\Material de envio

outros

numeric(1)

SIM

Recipiente\Material de envio

emailvet

string(100)

NÃO

E-mail do medico veterinário

foneprop

String(15)

NÃO

Telefone do proprietário(Tutor)

emailprop

String(100)

NÂO

E-mail do proprietário(Tutor)

clinica_id

INT

SIM

ID da clinica no easyvet

solicitante_id

INT

NÃO

ID da clinica solicitante no easyvet

urgente

Numeric(1)

NÃO

Informa se o exame é urgente

historico

Text

NÃO

Envia histórico do animal

suspeitaclinica

string(30)

NÂO

Suspeita de doença do animal

cpf

string(19)

NÃO

CPF do proprietário(Tutor)

dtcoleta

date

SIM

Data de coleta do material

exameid

INT

SIM

ID do exame no easyvet

descexa

string(100)

SIM

Descrição do exame

urgente

Numeric(1)

SIM

Informa se o exame é urgente

ficha

string(20)

SIM

Cod. atendimento SVG

nomevet

string(100)

SIM

Nome Veterinario

tamparoxa

numeric(1)

SIM

Recipiente\Material de envio

frascoformol

numeric(1)

SIM

Recipiente\Material de envio

tampavermelha

numeric(1)

SIM

Recipiente\Material de envio

laminas

numeric(1)

SIM

Recipiente\Material de envio

tampacinza

numeric(1)

SIM

Recipiente\Material de envio

parasitologico

numeric(1)

SIM

Recipiente\Material de envio

SWAB

numeric(1)

SIM

Recipiente\Material de envio

obs_grupo1

string(600)

NÃO

Outros Materiais

empresa_id

INT

SIM

ID da empresa cadastrada no tecsa

Exemplo de estrutura de como deverá ser enviado o Json para inserção de dados.

Formato JSON para cadastro na Cadonline e Cadonline1 Passar parametros: JSON, cliente_id { "nome":"Toto", "proprietario":"Joao da Silva Teste", "anos":"053", "meses":"10", "dias":"11", "racaid":1, "especieid":1, "crmvet":"1234", "ufcrmvet":"SP", "nomevet":"Renan Mitsuo", "obs":"- A coleta foi realizada no periodo da manha ate as 12 horas.\n- Jejum obrigatorio de 8 a 14 horas ou conforme orientacao medica.\n- Animais de ate 2 anos dispensa periodos longos de jejum e a coleta e realizada o mais proximo possivel da alimentacao. \n", "dataenvio":"2020-12-09", "horaenvio":"12:00", "sexo":1, "tampaverde":0, "medulaossea":0, "sanguetotal":0, "soro":1, "sangueedta":1, "swabnasa":0, "swaborofaringeo":0, "swabocular":0, "swabouvido":0, "swabpele":0, "tamparoxa":0, "FrascoFormol":0, "tampavermelha":0, "laminas":0, "TampaCinza":0, "Parasitologico":0, "SWAB":0, "liquidocavitario":0, "liquor":0, "urina":0, "fezes":0, "liquidoascitico":0, "outros":0, "obs_grupo1" :"pele", "emailvet":"vet@teste.com", "foneprop":"(11)98765-4321", "emailprop":"prop@teste.com", "clinica_id":1, "solicitante_id":1, "urgente":0, "historico":"TESTE DE HISTORICO", "suspeita":"TESTE DE SUSPEITA", "cpf":"43456278004", "dtcoleta":"2020-12-08", "ficha":"1515151515", "empresa_id": 1, "exames":[ { "exameid":39, "descexa":"Hemograma", "urgente":0 }, { "exameid":105, "descexa":"Glicose", "urgente":0 } ] }

Após ser realizado a inclusão será retornado o posto e amostro do atendimento enviado.

Caso já exista a ficha e o convenio cadastrado no sistema será retornado o posto e amostra.

Exemplo de Retorno

Parâmetros

Formato

Obrigatório

Descrição

posto

string(3)

SIM

Posto de coleta

amostra

string(6)

SIM

Numero do atendimento

dateentra

date

SIM

Data de entrada

horaentra

string(5)

SIM

Hora de entrada

urgente

numeric(1)

SIM

Urgente (Sim) (Não)

tubo

numeric(15)

SIM

Numero do tubo de coleta

nomeani

string(50)

SIM

Nome do aninal

desc_recip

string(100)

SIM

Descrição do recipiente

exame

string(250)

SIM

Descrição do exame

Proprietario

string(100)

SIM

Nome do tutor

idade

string(3)

SIM

Idade do animal

mes

string(2)

SIM

Meses do animal

dia

string(2)

SIM

Dias do animal

especie

string(100)

SIM

Espécie do animal

Exemplo de estrutura de retorno com a separação das etiquetas de cod. barras.

Retorno postman

{ "posto": "001", "amostra": "091549", "status": "Sucesso", "Codbar": [ { "posto": "001", "amostra": "091549", "dataentra": "19/10/2020", "horaentra": "15:54", "urgente": "NÃO", "tubo": "0109154901", "nomeani": "TESTE OBS", "desc_recip": "TUBO SECO TAMPA AMARELA COM GEL ", "exames": "ANAP ", "proprietario": "TESTE OBS", "idade": "1", "mes": "2", "dia": "3", "especie": "CARAMUJO GIGANTE AFRICANO " }, { "posto": "001", "amostra": "091549", "dataentra": "19/10/2020", "horaentra": "15:54", "urgente": "NÃO", "tubo": "0109154907", "nomeani": "TESTE OBS", "desc_recip": "TUBO SECO TAMPA AMARELA COM GEL PROTEGIDO DA LUZ ", "exames": "ACFO ", "proprietario": "TESTE OBS", "idade": "1", "mes": "2", "dia": "3", "especie": "CARAMUJO GIGANTE AFRICANO " }, { "posto": "001", "amostra": "091549", "dataentra": "19/10/2020", "horaentra": "15:54", "urgente": "NÃO", "tubo": "0109154907", "nomeani": "TESTE OBS", "desc_recip": "TUBO SECO TAMPA AMARELA COM GEL PROTEGIDO DA LUZ ", "exames": "ACFO ", "proprietario": "TESTE OBS", "idade": "1", "mes": "2", "dia": "3", "especie": "CARAMUJO GIGANTE AFRICANO " } ] }

Solicitação de alteração

Parâmetros

Formato

Obrigatório

Descrição

Posto

String(3)

SIM

Numero do posto no easyvet

amostra

String(6)

SIM

Numero de amostra do easyvet

tampaverde

numeric(1)

SIM

Recipiente\Material de envio

medulaossea

numeric(1)

SIM

Recipiente\Material de envio

sanguetotal

numeric(1)

SIM

Recipiente\Material de envio

soro

numeric(1)

SIM

Recipiente\Material de envio

sangueedta

numeric(1)

SIM

Recipiente\Material de envio

swabnasa

numeric(1)

SIM

Recipiente\Material de envio

swaborofaringeo

numeric(1)

SIM

Recipiente\Material de envio

swabocular

numeric(1)

SIM

Recipiente\Material de envio

swabouvido

numeric(1)

SIM

Recipiente\Material de envio

swabpele

numeric(1)

SIM

Recipiente\Material de envio

liquidocavitario

numeric(1)

SIM

Recipiente\Material de envio

liquor

numeric(1)

SIM

Recipiente\Material de envio

urina

numeric(1)

SIM

Recipiente\Material de envio

fezes

numeric(1)

SIM

Recipiente\Material de envio

liquidoascitico

numeric(1)

SIM

Recipiente\Material de envio

exameid

INT

SIM

ID do exame no easyvet

descexa

string(100)

SIM

Descrição do exame

urgente

Numeric(1)

SIM

Informa se o exame é urgente

Exemplo de estrutura de como deverá ser enviado o Json para inclusão de exame.

Formato JSON para atualização na Cadonline e inclusão de exames na Cadonline1 Passar parametros: JSON, cliente_id, incluiExame = true { "posto":"001", "amostra":"123456", "tampaverde":0, "medulaossea":0, "sanguetotal":0, "soro":1, "sangueedta":1, "swabnasa":0, "swaborofaringeo":0, "swabocular":0, "swabouvido":0, "swabpele":0, "liquidocavitario":0, "liquor":0, "urina":0, "fezes":0, "liquidoascitico":0, "outros":0, "obs_grupo1" :"pele", "ficha" :"123456789", "empresa_id": 1, "exames":[ { "exameid":39, "descexa":"Hemograma", "urgente":0 }, { "exameid":105, "descexa":"Glicose", "urgente":0 } ] }

Solicitação de Exclusão

Parâmetros

Formato

Obrigatório

Descrição

Posto

String(3)

SIM

Numero do posto no easyvet

amostra

String(6)

SIM

Numero de amostra do easyvet

tampaverde

numeric(1)

SIM

Recipiente\Material de envio

medulaossea

numeric(1)

SIM

Recipiente\Material de envio

sanguetotal

numeric(1)

SIM

Recipiente\Material de envio

soro

numeric(1)

SIM

Recipiente\Material de envio

sangueedta

numeric(1)

SIM

Recipiente\Material de envio

swabnasa

numeric(1)

SIM

Recipiente\Material de envio

swaborofaringeo

numeric(1)

SIM

Recipiente\Material de envio

swabocular

numeric(1)

SIM

Recipiente\Material de envio

swabouvido

numeric(1)

SIM

Recipiente\Material de envio

swabpele

numeric(1)

SIM

Recipiente\Material de envio

liquidocavitario

numeric(1)

SIM

Recipiente\Material de envio

liquor

numeric(1)

SIM

Recipiente\Material de envio

urina

numeric(1)

SIM

Recipiente\Material de envio

fezes

numeric(1)

SIM

Recipiente\Material de envio

liquidoascitico

numeric(1)

SIM

Recipiente\Material de envio

exameid

INT

SIM

ID do exame no easyvet

descexa

string(100)

SIM

Descrição do exame

urgente

Numeric(1)

SIM

Informa se o exame é urgente

Exemplo de estrutura de como deverá ser enviado o Json para exclusão.

Para teste via postman para inclusão de exame

https://portal4.softeasy.com.br/api/recebeRequisicaoVet?Content-Type=application/json&cliente_id=5

Mensagens de retorno via API.

  • Ocorreu um erro na comunicação com banco de dados, tente novamente.

  • Não foi possível realizar a integração porque o valor informado no campo 'racaid' não existe.

  • Não foi possível realizar a integração porque o valor informado no campo 'especieid' não existe.

  • Não foi possível realizar a integração porque o valor informado no campo 'clinica_id' não existe.

  • Não foi possível realizar a integração porque os exames informados não existem, realize o cadastro e tente novamente.

  • Não foi possível realizar a integração porque o veterinário informado nos campos 'crmvet' e 'ufcrmvet' não existem, realize o cadastro e tente novamente.

  • Não foi possível realizar a integração porque a ficha informada já existe, tente novamente com outra ficha.

  • Ocorreu um erro no cadastro dos exames, tente novamente.

  • A integração foi realizada com sucesso, com exceção dos exames: ()

  • A integração foi realizada com sucesso.

URL para remover exame

https://portal4.softeasy.com.br/api/recebeRequisicaoVet?Content-Type=application/json&cliente_id=5&removeExame=true

Mensagens de retorno via API

  • Ocorreu um erro na comunicação com banco de dados, tente novamente.

  • O cadastro com o POSTO e AMOSTRA informado não foi encontrado.

  • O exame id: XX não foi encontrado, verifique e tente novamente.

  • Exame já recebido, favor entrar em contato com o Tecsa

  • A alteração foi realizada com sucesso.

URL para alteração de exames

https://portal4.softeasy.com.br/api/recebeRequisicaoVet?Content-Type=application/json&cliente_id=5&incluiExame=true

Caso houver erro será retornado a imagem abaixo.

Caso o convenio e ficha já existirem no sistema será retornado o posto e amostra

Caso a integração tenha sido realizado com sucesso será retornado o posto e amostra

Para alteração

Puxe um atalho do interfacevet e coloque o parametro "SGV" "ROBOSGV"

Exemplo: O caminho do robô de interface deverá ficar assim no atalho.