Integração de aplicações de terceiros com o Provet Cloud

Introdução

O sistema de gestão de clínicas veterinárias Provet Cloud pode ser integrado com aplicações de terceiros utilizando ferramentas denominadas REST API e webhooks. Este artigo descreve a utilização destas metodologias de integração.

Webhooks estão disponíveis no Provet Cloud para enviar notificações a sistemas de terceiros sobre adições ou alterações nos dados dentro do Provet Cloud. Os webhooks não transferem os dados efetivamente alterados, mas transferem a informação sobre o que foi alterado, notificando simplesmente o sistema de terceiros sobre a alteração. Os dados reais podem então ser obtidos pelo sistema de terceiros, utilizando a API REST de Provet Cloud.

REST API é um método de comunicação para aceder, editar ou adicionar aos dados que residem na Provet Cloud de forma programática por qualquer aplicação de terceiros. A API REST da Provet Cloud permite que a maior parte dos principais dados da Provet Cloud sejam lidos ou manipulados por outros sistemas.

A combinação dos webhooks de Provet Cloud & REST API cria possibilidades únicas para a criação de soluções integradas. Qualquer fornecedor de outros sistemas familiarizado com estas tecnologias pode facilmente integrar-se com os dados que residem no sistema de gestão de clínicas veterinárias Provet Cloud, utilizando estas tecnologias.

A Nordhealth oferece consultoria para ajudar na utilização da API REST & webhooks. Para mais informações, consulte o nosso sítio para programadores https://developers.provetcloud.com/ .

Exemplo de solução de integração

Caso: Se um sistema de terceiros (por exemplo, um sistema financeiro) pretender obter informações imediatas sobre uma consulta recém-criada no Provet Cloud, estas podem ser arquivadas através da combinação dos webhooks & REST API da seguinte forma, utilizando o webhook de consulta.

  1. É criada uma consulta em Provet Cloud.

  2. O Provet Cloud envia uma notificação de gancho HTTP de consulta para o URL definido nas configurações.

    • Webhook: Criação/atualização de consultas

    • Parâmetro: consultation_id=123 (foi criada uma consulta com o ID 123)

  3. O sistema de terceiros recebe o gancho e sabe que a consulta com o ID 123 foi criada no Provet Cloud.

  4. O sistema de terceiros solicita a consulta com dados ID 123 utilizando a chamada à API REST.

  5. O Provet Cloud devolve os dados da consulta com o ID 123 no formato JSON.

  6. O sistema de terceiros recebe os dados da consulta e processa-os da forma pretendida (e cria outras chamadas à API REST, se necessário).

integration-solution-scheme.png

Webhooks

Os webhooks são configurados e activados em Definições > Geral > Integrações > Webhooks.

  • Exemplo: "consulta_id=123"

  • Se a resposta for diferente de HTTP 200, a entrega da notificação será repetida

  • Na página de definições, também é possível ver uma lista actualizada dos webhooks acionados e o respetivo estado de entrega. Está disponível um registo para revisão

  • Deixar o campo de localização da clínica vazio fará com que o webhook funcione em toda a organização.

  • Certas acções em que a localização da clínica não pode ser inferida, como a atualização de clientes e pacientes através da API REST, não desencadeiam webhooks específicos da localização da clínica.

  • Os webhooks são pedidos HTTP POST para o URL definido nas definições de cada webhook

  • O pedido POST contém dados que identificam o tipo de dados actualizados e o ID do objeto

  • Os webhooks esperam receber uma resposta HTTP 200 no processo bem sucedido

  • Os webhooks podem ser configurados para serem específicos do local da clínica, caso em que só são acionados quando os itens num determinado local da clínica são actualizados, ou podem ser configurados para serem de toda a organização, caso em que são sempre acionados.

  • Podem ser definidos vários webhooks para o mesmo acionador e/ou localização da clínica, e as actualizações accionam todos os webhooks que se aplicam à situação.

  • Pode ser atribuído um nome opcional aos webhooks para ajudar a identificá-los e diferenciá-los.

  • Os webhooks que já não são necessários podem ser desactivados desmarcando a caixa de verificação Ativo.

Os seguintes eventos Webhook estão atualmente disponíveis nas configurações do Provet Cloud. Cada um dos ganchos pode ter um endereço URL diferente (ou o mesmo), para o qual o Provet Cloud envia o gancho quando acionado no evento.

  • Relatório contabilístico: parâmetro accountingreport_id

  • Nomeação: parâmetro appointment_id

  • Apagamento de compromissos: parâmetro appointment_id

  • Criar lembrete de marcação de consulta: parâmetro reminder_id

  • Atualização do lembrete de marcação de consultas: parâmetro reminder_id

  • Apagar lembrete de marcação de consulta: parâmetro reminder_id

  • Utilização da anulação do item do armário: parâmetro id do item

  • Utilização do item do armário: parâmetro id do item

  • Cliente: parâmetro client_id

  • Eliminação do cliente: parâmetro client_id

  • Preferência de comunicação do cliente: parâmetro ID da preferência de comunicação

  • Criação/atualização da consulta:: parâmetro consultation_id

  • Supressão da consulta: parâmetro consultation_id

  • Consulta finalizada: parâmetro consultation_id

  • Item de consulta: parâmetro consultationitem_id

  • Descarga de consulta em espera: parâmetro consultation_id

  • Lista de trabalho de diagnóstico por imagem: parâmetro diagnosticimagingworklist_id

  • Atualização da lista de trabalho de diagnóstico por imagem: parâmetro diagnosticimagingworklist_id

  • Eliminação da lista de trabalho de diagnóstico por imagem: parâmetro diagnosticimagingworklist_id

  • Registo de envio de correio eletrónico

  • Atualização do estado do plano de saúde

  • Pedido de indemnização de seguro: parâmetro insuranceclaim_id

  • Fatura: parâmetro ID da fatura

  • Rascunho de fatura (notifica quando um rascunho de fatura é atualizado ou quando são adicionados itens automaticamente): parâmetro id da fatura

  • Pagamento de facturas: parâmetro invoicepayment_id

  • Eliminação da linha da fatura

  • Pedido de laboratório (encaminhamento): parâmetro laboratory_referral_id

  • Notas & comunicação

  • Item do armário da organização: parâmetro item_id

  • Organização alimentar: parâmetro item_id

  • Item da organização: : parâmetro item_id

  • Organização análises laboratoriais: parâmetro item_id

  • Painel de análises laboratoriais da organização: parâmetro item_id

  • Medicina organizacional: parâmetro item_id

  • Procedimento de organização: parâmetro item_id

  • Fornecimento da organização: parâmetro item_id

  • Doente: parâmetro patient_id

  • Criação de referências de pacientes

  • Feedback de encaminhamento de pacientes enviado

  • Criar/modificar lembrete

  • Apagar lembrete

  • Eliminar modelo de lembrete

  • Registo de SMS enviados

  • Entrada de item de estoque

  • Eliminação da entrada de item de estoque

  • Ordem de stock

  • Eliminação de ordens de stock

  • Item de ordem de estoque

  • Eliminação de item de ordem de estoque

  • Plano de tratamento

  • Supressão do plano de tratamento

  • Item do plano de tratamento

  • Suprimir item do plano de tratamento

  • Pagamento não atribuído: parâmetro unallocatedpayment_id

  • Utilizador, parâmetro ID do utilizador

Nota

Esta lista foi actualizada em agosto de 2024. Estão constantemente a ser desenvolvidos ganchos adicionais com base nos pedidos dos nossos utilizadores.

API REST

A Provet Cloud fornece a API REST para permitir o acesso aos dados armazenados na Provet Cloud. A API utiliza a autenticação OAuth 2.0. Os dados são devolvidos no formato JSON.

  • Para aceder à API REST, é necessário pedir ao suporte Provet Cloud que lhe gere um modelo de integração

    • A API do Provet Cloud suporta dois tipos de concessão: Código de autorização e Credenciais de cliente.

      • O Código de Autorização é utilizado para autenticar interfaces de utilizador e casos em que os utilizadores acedem à API como se fossem eles próprios. O PKCE é suportado e altamente recomendado. Os clientes públicos DEVEM utilizar o PKCE.

      • As credenciais de cliente são utilizadas para a conetividade de backend, em que os serviços comunicam diretamente com outros sem quaisquer acções do utilizador.

  • A API REST pode ser acedida através de um URL compilado da seguinte forma: https://<provet_environment>/<provet_id>/api/0.1/

    • <provet_environment> O URL difere um pouco para cada ambiente. Pode ser, por exemplo

      • provetcloud.com para o ambiente da UE

      • us.provetcloud.com para o ambiente dos EUA

    • No URL <provet_id> é o ID único da instância Provet Cloud para a sua empresa

    • O URL completo é sempre apresentado nas definições da API em Provet Cloud Definições > Integrações > Acesso à API aberta.

A API REST do Provet Cloud é navegável, o que deve permitir aos programadores avaliar as possibilidades de transferência de dados.

Catálogo de integração em Provet Cloud

Uma vez criado o modelo, a integração pode ser vista no catálogo de integrações em Provet Cloud: Configurações > Integrações > Acesso à API aberta > Adicionar aplicação. O catálogo lista as integrações disponíveis e apresenta uma breve descrição do que cada integração faz. Se a integração tiver mais instruções de configuração, estas também são apresentadas no catálogo.

9947060702108-mceclip0.png

As integrações podem ter uma visibilidade restrita: podem ser limitadas apenas a determinados locatários do Provet Cloud ou em determinados países. O terceiro que fornece a integração pode escolher em que medida a integração deve ser visível nos locatários. Quando existem restrições, a aplicação é apresentada no Catálogo de integração apenas nos locatários/países em que é permitida.

Opções no registo de um novo cliente

Sempre que um novo cliente se regista para utilizar uma integração, ou seja, escolhe-a no catálogo de integração no Provet Cloud (Adicionar aplicação), são enviadas credenciais de cliente únicas para o fornecedor da integração. Existem duas opções para notificar o registo de um novo cliente que podem ser escolhidas ao criar um modelo de integração:

  • correio eletrónico

  • URL de engate

Quando a integração é utilizada apenas numa instância do Provet Cloud, o e-mail é uma boa escolha: a pessoa que recebe o e-mail pode configurar os detalhes de autenticação para a integração e começar a utilizá-la. Por outro lado, quando a integração é amplamente utilizada, recomenda-se a utilização do URL de ligação e a automatização da adição de um novo cliente.

O URL de ligação está à escuta de quaisquer notificações automáticas de novos clientes. Quando um novo cliente adiciona a integração no Provet Cloud, a ferramenta de orquestração envia automaticamente uma mensagem JSON para esse URL. Não é necessária qualquer interação humana, uma vez que a integração analisa automaticamente o novo cliente a partir da mensagem JSON e adiciona as suas credenciais à sua tabela de clientes.

Esquema JSON para os dados enviados para novos registos de integração:

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
     "provet_id",
     "client_id",
     "client_secret",
     "algorithm",
     "authorization_grant_type",
     "client_type",
     "redirect_uris",
     "token_url",
     "authorize_url",
     "openid_autodiscovery_url"
],
"properties": {
     "provet_id": {
          "type": "number",
          "description": "Provet ID of the tenant who added this integration."
     },
     "client_id": {
          "type": "string"
     },
     "client_secret": {
          "type": ["null", "string"]
     },
     "algorithm": {
           "type": ["null", "string"],
           "description": "Signing algorithm used.",
           "examples": [null, "HS256", "RS256"]
     },
     "authorization_grant_type": {
           "type": "string",
           "description": "Authorization flow used.",
           "examples": ["authorization-code", "client-credentials"]
     },
     "client_type": {
           "type": "string",
           "description": "Client type.",
           "examples": ["confidential", "public"]
     },
     "redirect_uris": {
           "type": "string",
           "description": "Space-separated list of callback URIs.",
           "examples": ["https://example.com/callback"]
     },
     "token_url": {
            "type": "string",
            "description": "OAuth2.0 token endpoint URL."
     },
     "authorize_url": {
            "type": "string",
            "description": "OAuth2.0 authorize endpoint URL."
     },
     "openid_autodiscovery_url": {
            "type": ["null", "string"],
             "description": "OpenID autodiscovery URL. Null if integration does not use OpenID."
     }
 }
}

Dados disponíveis através da API REST

A API REST pode ser utilizada para ler a maior parte dos dados e criar/atualizar algumas partes selecionadas dos dados. A primeira página da API navegável lista todos os objectos que podem ser acedidos. Eis a lista dos objectos mais comuns.

Genéricos

Nome

C

U

D

Descrição

Ponto final

Campo personalizado

Campos personalizados definidos nas definições; podem ser utilizados em doentes e clientes, por exemplo

campos_personalizados

Valor do campo personalizado

Se forem utilizados campos personalizados num doente X, estes gerarão uma linha aqui

valores_de_campo_personalizados

Nota

Notas que constam da secção "Notas & Comunicação" na página do doente/cliente

nota

noteadmin

Tarefa

Tarefas dos veterinários

tarefa

Lembrete

Lembretes para os doentes

lembrete

Modelo de lembrete

Modelo para criar lembretes

modelo de lembrete

Cliente & Doente

Nome

C

U

D

Descrição

Ponto final

Cliente

Cliente para paciente

cliente

Doente

Doente

paciente

Número de telefone

Números de telefone dos clientes

número de telefone

História importada

Permite a importação do historial dos doentes de sistemas antigos num formato específico

história importada

Faturação

Nome

C

U

D

Descrição

Ponto final

Fatura

Facturas para clientes

fatura

Linha da fatura

Linhas de facturas de facturas

faturação

Pagamento de facturas

Pagamentos de facturas

pagamento de facturas

Pré-pagamento

Pré-pagamento (também conhecido como pagamentos não afectados) de clientes. Pode ser utilizado para pagar uma fatura futura

pagamento não afetado

Método de pagamento

Métodos de pagamento disponíveis no sistema

método de pagamento

Pedido de indemnização

Pedidos de indemnização dos doentes

pedido de seguro

Cliente de sinistro de seguro

Cliente fictício copiado dos dados do cliente para um pedido de indemnização de seguro

seguro-reclamação-cliente

Paciente com pedido de seguro

Doente fictício copiado dos dados do doente para o pedido de indemnização do seguro

seguro-hospitalar

Organização

Nome

C

U

D

Descrição

Ponto final

Localização da clínica

Localização das clínicas

localização da clínica

Grupo de localização da clínica

Grupo de locais de clínicas

localização da clínicagrupo

Utilizador

Conta de utilizador da nuvem provet

utilizador

Detalhes do utilizador

Informações adicionais sobre o utilizador

dados do utilizador

Grupo de utilizadores

Grupo de trabalho dos utilizadores, relacionado com o acesso dos utilizadores

grupo de utilizadores

Lista de artigos

A lista de artigos contém um número X de artigos. As clínicas são subscritoras de uma lista de artigos e utilizam-na nas consultas e balcões de venda

lista de itens

Item

Itens em configurações. Um modelo geral extensível para todos os itens. Contém subtipos: Procedimento, Medicamento, Fornecimento, Alimentação, Análise laboratorial, Painel de análise laboratorial

Item

procedimento

medicina

fornecimento

alimentos

análise laboratorial

painel de análise laboratorial

Grupo de itens

Também conhecido como grupo de facturas. Os itens podem ser agrupados por informações de subgrupo que podem ser filtradas em algumas pesquisas

itensubgrupo

grupo de facturas

Grupo do IVA

Grupos de IVA da organização

grupo vat

Modelo de texto

Modelos de texto personalizados para serem utilizados no ProvetCloud, por exemplo, notas de consulta e instruções de alta

modelo_de_texto

Modelo de item

Modelos de itens nas definições, que descrevem um conjunto de itens

modelo de item

Modelo de item item

Um item, ou modelo de item no modelo de item das definições

itemtemplateitem

Preços alternativos

Opções de preços alternativas para o artigo, por exemplo, permitir a venda a granel mais barata para um determinado montante

preços alternativos

Listas

Listas personalizadas nas definições para, por exemplo, espécies e raças

lista

Listar itens

Um item de lista em listas personalizadas nas definições

item de lista

Codelistas

Forma mais cómoda de visualizar os itens da lista. Contém apenas os itens activos da lista, mas pode listar códigos que não provêm da base de dados, como os códigos VeNom, por exemplo

lista de códigos

Número do local de retenção

Relativamente às caraterísticas dos animais de produção; uma informação numérica para o local de detenção do doente

números de posição

Estoque

Nome

C

U

D

Descrição

Ponto final

Nível

Todos os artigos em stock e respectivos níveis

estoque/item

nível do stock

Localização

Local onde o stock é detido

stock/localização

Lote

Lotes de estoque para itens de estoque

stock/lote

Entrada

Entradas em estoque (utilizações) para itens de estoque

stock/entrada

Grossista

Grossistas para fazer encomendas

grossista

Encomendar

Encomenda de produtos ao grossista

ordem

Item de encomenda

Item na ordem do produto

item de ordem

Diagnóstico por imagem

Nome

C

U

D

Descrição

Ponto final

Lista de trabalho

Entradas na lista de trabalho para encaminhamentos de diagnóstico por imagem

lista de trabalho de diagnóstico por imagem

Modalidade

Modalidade de diagnóstico por imagem

modalidade

Categoria

Categoria de diagnóstico por imagem

categoria de imagem

Subcategoria

Subcategoria para categorias de diagnóstico por imagem

imagemsubcategoria

Área-alvo

Área-alvo para a modalidade

área-alvo

Recursos

Recurso para diagnóstico por imagem

recurso

Consulta

Nome

C

U

D

Descrição

Ponto final

Consulta

Consulta do cliente e do(s) doente(s)

consulta

Item

Item de base para itens adicionados à consulta. Contém subtipos: Procedimento, Medicamento, Fornecimento, Alimentação, Análise laboratorial

item de consulta

itens_de_consulta/procedimento

itens_de_consulta/medicina

consulta_itens/fornecimento

itens_de_consulta/alimentos

itens_de_consulta/análise

Plano de tratamento

Plano de tratamento que contém informações sobre os elementos a utilizar no futuro

plano de tratamento

Item do plano de tratamento

Item do plano de tratamento.

plano de tratamentoprocedimento

plano de tratamentomedicina

fornecimento de planos de tratamento

plano de tratamentoalimentos

Estimativa

Estimativa para consulta

estimativa

Item de estimativa

Item adicionado para estimativa de consulta

item de estimativa

Modelo de item

Modelos de itens (também conhecidos como pacotes de consulta) que foram adicionados a uma consulta

modelo de consulta

Encaminhamento para laboratório

Encaminhamento (também conhecido como pedido) de consulta

consulta_laboratorial_referência

Amostra de laboratório

Uma amostra com análises de consulta e painéis de consulta

amostra_de_consulta

Encaminhamento para diagnóstico por imagem

Encaminhamento (também conhecido como pedido) de consulta

diagnóstico de imagem_referência

Área alvo de diagnóstico por imagem

Área-alvo utilizada durante a consulta

área_alvo da consulta

Programação

Nome

C

U

D

Descrição

Ponto final

Nomeação

Marcações de consultas para pacientes. Também conhecido como evento de agendamento

nomeação

Deslocação

Mudanças para os utilizadores

deslocação

Tipo de turno

Tipos de turnos definidos nas configurações

tipo de turno

Motivo

Motivo da nomeação

razão

Grupo de motivos

Os grupos de motivos podem ser específicos do local da clínica. Utilizado para agrupar motivos em pesquisas

grupo_de_razões

Motivo do cancelamento

motivo de cancelamento

Triagem

Uma instância que contém informações sobre eventos de triagem

triagem

Categoria de triagem

Categorias para triagem em contextos

categoria_triagem

Entrada de triagem

Um evento na triagem

entrada_triagem

Disponibilidade de veterinários

Apresenta os turnos disponíveis para veterinários num determinado período de tempo

veterinários_disponibilidade

Cliente de reservas em linha

Cliente fictício criado para marcação de consultas em linha

cliente de reservas online

Paciente com reserva em linha

Paciente fictício criado para marcação de consulta em linha

onlinebookingpaciente

Permissões

Quando uma nova aplicação de integração é adicionada ao Provet Cloud, é automaticamente criado um utilizador virtual para essa integração. O utilizador virtual chama-se Integração <Nome da integração> e pode ser encontrado nas definições do utilizador da Provet Cloud no separador Virtual. Por defeito, o utilizador virtual é atribuído ao grupo de permissões Utilizadores.

Se a integração necessitar de permissões diferentes (alguns pontos finais são negados ou pretende restringir as permissões), recomendamos que crie um novo grupo de permissões apenas para esse utilizador virtual:

  1. Copie um grupo de permissões existente ou crie um novo grupo e dê-lhe um nome descritivo, por exemplo, o mesmo nome da integração.

  2. Conceda ao grupo as permissões necessárias. Verifique em o esquema da API Provet Cloud, quais as permissões necessárias para cada ponto final. Consulte também Gerir as permissões e os grupos de utilizadores.

  3. Edite o utilizador virtual e adicione-o ao novo grupo de permissões (campo Default Permission Group). O utilizador também não tem uma função de trabalho , pelo que também tem de a escolher. Técnico é a função destinada a utilizadores virtuais como o utilizador da integração.

Exemplo de utilização

Para obter informações sobre uma consulta com o número de ID 338, seria enviado um pedido HTTP GET com os parâmetros de autenticação para o seguinte URL: https://provetcloud.com/<provet_id>/api/0.1/consultation/338/

Exemplo de resposta:

{
    "url": "https://provetcloud.com/<provet_id>/api/0.1/consultation/338/",
    "client": "https://provetcloud.com/<provet_id>/api/0.1/client/1/",
    "patients": [
        "https://provetcloud.com/<provet_id>/api/0.1/patient/1/"
    ],
    "complaint": "Test consultation",
    "admitted_time": "2017-05-18T10:35:00Z",
    "first_entry": null,
    "started": "2017-05-18T10:35:00Z",
    "finished": null,
    "ended": null,
    "status": 8,
    "type": 0,
    "invoice": "https://provetcloud.com/api/<provet_id>/0.1/invoice/609/",
    "supervising_veterinarian": "https://provetcloud.com/api/<provet_id>/0.1/user/1/",
    "clinic location": "https://provetcloud.com/<provet_id>/api/0.1/clinic location/1/",
    "consultation_items": [
        "https://provetcloud.com/<provet_id>/api/0.1/consultationitem/4558/",
        "https://provetcloud.com/<provet_id>/api/0.1/consultationitem/4559/",
        "https://provetcloud.com/<provet_id>/api/0.1/consultationitem/4560/"
    ],
    "reporting_dimension_1": null,
    "reporting_dimension_2": null
}

A partir da resposta, é possível encontrar o ID da fatura relacionada com esta consulta, bem como todas as outras entidades relacionadas com esta consulta. Estas podem ser obtidas através de outras chamadas à API REST.

Filtros

Alguns endpoints têm campos que podem ser utilizados para filtrar os resultados. Os campos filtráveis podem ser vistos no topo da página do seu ponto de extremidade da API REST de Provet Cloud (por exemplo, https://provetcloud.com/<provet_id>/api/0.1/consultation/) se o ponto de extremidade tiver campos filtráveis.

Os seguintes métodos estão disponíveis para filtragem (os sinónimos são separados por vírgulas):

  • é, eq (igual)

  • is_not, not_eq, neq (não igual)

  • lt (menos de)

  • lte (inferior ou igual)

  • gt (maior que)

  • gte (maior ou igual)

  • intervalo (valores entre, precisa de dois valores na ordem [de, até])

  • not_in_range (acima invertido)

  • contains (o texto contém o texto procurado, sensível a maiúsculas e minúsculas)

  • contains_not (acima invertido)

  • icontains (texto contém o texto procurado, sem distinção entre maiúsculas e minúsculas)

  • icontains_not (acima invertido)

  • in (o item é encontrado na lista dada [valor1,valor2,valor3])

  • not_in (acima invertido)

  • is_null (verdadeiro ou falso)

Os métodos de filtragem podem ser utilizados com parâmetros de consulta utilizando as seguintes sintaxes:

[field]__[method]=value (por exemplo, client__is=10 que utiliza o id do cliente para a pesquisa)

[campo].[propriedade]__[método]=valor (por exemplo, cliente.id__is=10)

Note-se que as datas devem ser indicadas para os parâmetros de consulta no formato YYYY-MM-DD hh:mm+[TimeZone]hh:mm (por exemplo, 2017-12-24 15:30+00:00) .

Se precisarmos de encontrar todas as consultas com as condições

  • a queixa contém a palavra "vacc" (não faz distinção entre maiúsculas e minúsculas)

  • o admitted_time está entre 2017-12-01 00:00+00:00 (maior ou igual) e 2018-01-01 00:00+00:00 (menor que)

  • o id do local da clínica é 1

  • o id do cliente é 10

  • a identificação de um dos pacientes na consulta é 20

utilizaríamos o seguinte url:

https://provetcloud.com/<provet_id>/api/0.1/consultation/?complaint__icontains=vacc&admitted_time__gte=2017-12-01 00:00%2B00:00&admitted_time__lt=2018-01-01 00:00%2B00:00&clinic location__is=1&client__is=10&patients__is=20

Note-se que os sinais "+" são codificados por URL (%2B) no exemplo acima para que o URL funcione.

Se precisarmos de encontrar todas as consultas em que

  • o primeiro nome do cliente é João e

  • o apelido do cliente é Doe

utilizaríamos o seguinte URL:

https://provetcloud.com/ <provet_id>/api/0.1/consultation/?client.firstname__is=John&client.lastname__is=Doe

Expor

Alguns endpoints têm campos que podem ser expostos, o que mostrará alguns dos campos internos do objeto exposto. Os campos expostos podem ser vistos no topo da página do ponto final da API REST do Provet Cloud (por exemplo, https://provetcloud.com/<provet_id>/api/0.1/invoicerow/) se o ponto final tiver campos expostos. Para expor um campo, pode adicionar ?expose_<field_name> no URL, tal como os filtros são utilizados.

Liberação de uma integração

Quando tiver desenvolvido e testado a sua integração e pretender disponibilizá-la ao público, contacte o suporte da Provet Cloud para tornar o seu modelo de integração visível para todas as instâncias da Provet Cloud. Se a sua integração não for específica do cliente e se destinar a ser utilizada em muitas instâncias da Provet Cloud por muitos utilizadores, existem alguns requisitos que devem ser cumpridos antes de ser lançada. Estes requisitos destinam-se a facilitar a integração e a fornecer as informações necessárias ao apoio da Provet Cloud.

  1. Crie um pequeno vídeo sobre a sua integração: como utilizá-la e o que faz.

  2. Crie uma instrução de integração que contenha todos os passos manuais necessários para que o utilizador do Provet Cloud possa utilizar a sua integração. Os passos podem incluir também as acções necessárias no seu sistema.

  3. Forneça-nos o vídeo e o guia de integração e diga-nos em que mercados/países deve a sua integração ser visível.

Atualizado

Este artigo foi útil?

Utilizadores que acharam útil: 1 de 1

Tem mais dúvidas? Submeter um pedido

Comentários

0 comentário

Por favor, entrar para comentar.