Kolmannen osapuolen sovellusten integrointi Provet Cloudiin

Johdanto

Provet Cloud -eläinlääkärin vastaanotonhallintajärjestelmä voidaan integroida kolmannen osapuolen sovelluksiin REST API ja webhooks -työkalujen avulla. Tässä artikkelissa kuvataan näiden integrointimenetelmien käyttöä.

Webhooks on käytettävissä Provet Cloudissa, jotta voit lähettää ilmoituksia kolmansien osapuolten järjestelmiin Provet Cloudin sisällä oleviin tietoihin tehdyistä lisäyksistä tai muutoksista. Webhookit eivät siirrä varsinaisia muuttuneita tietoja, vaan ne siirtävät tietoa siitä, mikä on muuttunut, yksinkertaisesti ilmoittamalla muutoksesta kolmannen osapuolen järjestelmälle. Kolmannen osapuolen järjestelmä voi sitten hakea varsinaiset tiedot Provet Cloudin REST API:n avulla.

REST API on viestintämenetelmä, jolla kolmannen osapuolen sovellukset voivat käyttää, muokata tai lisätä Provet Cloudissa olevia tietoja ohjelmallisesti. Provet Cloudin REST API tarjoaa suurimman osan Provet Cloudin keskeisistä tiedoista muiden järjestelmien luettavaksi tai käsiteltäväksi.

Provet Cloud -verkkokoukkujen yhdistelmä & REST API luo ainutlaatuisia mahdollisuuksia integroitujen ratkaisujen rakentamiseen. Kaikki muiden järjestelmien toimittajat, jotka tuntevat nämä tekniikat, voivat helposti integroida Provet Cloud -eläinlääkärin vastaanotonhallintajärjestelmässä olevia tietoja hyödyntämällä näitä tekniikoita.

Nordhealth tarjoaa neuvontaa REST API:n & webhooksin käytössä. Lisätietoja on kehittäjäsivustollamme.

Integrointiratkaisun esimerkki

Tapaus: Jos kolmannen osapuolen järjestelmä (esim. rahoitusjärjestelmä) haluaisi saada välittömästi tietoa juuri luodusta konsultaatiosta Provet Cloudissa, tämä voitaisiin arkistoida yhdistämällä webhookit & REST API seuraavasti käyttämällä konsultaatio webhookia.

  1. Konsultaatio luodaan Provet Cloudissa.

  2. Provet Cloud lähettää HTTP-koukkuilmoituksen asetuksissa määritettyyn URL-osoitteeseen.

    • Webhook: Konsultointi luo/päivittää

    • Parametri: consultation_id=123 (on luotu konsultaatio, jonka ID on 123).

  3. Kolmannen osapuolen järjestelmä vastaanottaa koukun ja tietää, että Provet Cloudissa on luotu konsultaatio tunnuksella 123.

  4. Kolmannen osapuolen järjestelmä pyytää konsultaatiota ID 123 -tiedoilla REST API -kutsun avulla.

  5. Provet Cloud palauttaa JSON-muodossa tiedot konsultaatiosta, jonka tunnus on 123.

  6. Kolmannen osapuolen järjestelmä vastaanottaa konsultoinnin tiedot ja käsittelee ne halutulla tavalla (ja luo tarvittaessa uusia REST API -kutsuja).

integration-solution-scheme.png

Verkkokoukut

Verkkokoukut määritetään ja otetaan käyttöön kohdassa Asetukset > Yleistä > Integraatiot > Verkkokoukut.

  • Esimerkki: "consultation_id=123"

  • Jos vastaus on muu kuin HTTP 200, ilmoituksen toimittamista yritetään uudelleen.

  • Asetukset-sivulla näet myös ajantasaisen luettelon käynnistetyistä verkkokoukuista ja niiden toimitustilanteesta. Tarkistusta varten on käytettävissä loki

  • Jos klinikan sijainti -kenttä jätetään tyhjäksi, webhook toimii koko organisaatiossa.

  • Tietyt toiminnot, joista ei voida päätellä klinikan sijaintia, kuten asiakkaiden ja potilaiden päivittäminen REST API:n kautta, eivät käynnistä klinikan sijaintikohtaisia verkkokoukkuja.

  • Verkkokoukut ovat HTTP POST -pyyntöjä URL-osoitteeseen, joka on määritelty kunkin verkkokoukun asetuksissa.

  • POST-pyynnössä on tietoja, jotka yksilöivät, minkä tyyppisiä tietoja päivitettiin, sekä objektin ID.

  • Webhooks odottaa saavansa HTTP 200 -vastauksen onnistuneesta prosessista.

  • Verkkokoukut voidaan määrittää klinikkakohtaisiksi, jolloin ne käynnistyvät vain, kun tietyn klinikkakohteen kohteita päivitetään, tai koko organisaation laajuisiksi, jolloin ne käynnistyvät aina.

  • Samalle laukaisijalle ja/tai klinikan sijainnille voidaan asettaa useita verkkokoukkuja, ja päivitykset käynnistävät kaikki tilanteeseen liittyvät verkkokoukut.

  • Verkkokoukuille voidaan antaa valinnainen nimi niiden tunnistamisen ja erottamisen helpottamiseksi.

  • Enää tarpeettomat verkkokoukut voidaan poistaa käytöstä poistamalla Aktiivinen-valintaruudun valinta.

Seuraavat Webhook-tapahtumat ovat tällä hetkellä käytettävissä Provet Cloudin asetuksissa. Jokaisella koukulla voi olla eri (tai sama) URL-osoite, johon Provet Cloud lähettää koukun tapahtuman lauetessa.

  • Kirjanpitoraportti: parametri accountingreport_id

  • Nimitys: parametri appointment_id

  • Nimityksen poistaminen: parametri appointment_id

  • Ajanvarauksen muistutuksen luominen: parametri reminder_id

  • Ajanvarauksen muistutuksen päivitys: parametri reminder_id

  • Ajanvarauksen muistutus poistaa: parametri reminder_id

  • Kaapin kohteen peruuttaminen käyttö: parametri item id

  • Kaapin kohteen käyttö: parametri item id

  • Asiakas: parametri client_id

  • Asiakas poistetaan: parametri client_id

  • Asiakasviestinnän etusija: parametri communication preference id (Viestinnän etusija id)

  • Konsultaation luominen/päivittäminen:: parametri consultation_id

  • Konsultaatio poistetaan: parametri consultation_id

  • Kuuleminen saatettu päätökseen: parametri consultation_id

  • Konsultointikohde: parametri consultationitem_id

  • Kuulemista odottava vastuuvapaus: parametri consultation_id

  • Diagnostisen kuvantamisen työlista: parametri diagnosticimagingworklist_id

  • Diagnostisen kuvantamisen työlistan päivitys: parametri diagnosticimagingworklist_id

  • Diagnostisen kuvantamisen työlistan poisto: parametri diagnosticimagingworklist_id

  • Lähetetyn sähköpostin loki

  • Terveyssuunnitelman tilapäivitys

  • Vakuutushakemus: parametri insuranceclaim_id

  • Lasku: parametri invoice id

  • Laskuluonnos (ilmoittaa, kun laskuluonnos päivitetään tai eriä lisätään automaattisesti): parametri invoice id (laskun id).

  • Laskun maksaminen: parametri invoicepayment_id

  • Laskurivin poisto

  • Laboratoriopyyntö (lähete): parametri laboratory_referral_id

  • Huomautukset & viestintä

  • Organisaatiokaapin kohde: parametri item_id

  • Organisaation ruoka: parametri item_id

  • Organisaatioerä: : parametri item_id

  • Organisaation laboratorioanalyysi: parametri item_id

  • Organisaation laboratorioanalyysipaneeli: parametri item_id

  • Organisaation lääkkeet: parametri item_id

  • Organisaatiomenettely: parametri item_id

  • Organisaation tarjonta: parametri item_id

  • Potilas: parametri patient_id

  • Potilaan lähete luo

  • Potilaan lähetteestä lähetetty palaute

  • Muistutuksen luominen/muuttaminen

  • Muistutus poistaa

  • Muistutusmallin poistaminen

  • Lähetettyjen tekstiviestien loki

  • Varastokappaleen syöttö

  • Varastokappaleen merkintä poistaa

  • Varastotilaus

  • Varastotilauksen poisto

  • Varastotilauserä

  • Varastotilauserän poisto

  • Hoitosuunnitelma

  • Hoitosuunnitelma Poistetaan

  • Hoitosuunnitelman kohta

  • Hoitosuunnitelman kohta poistetaan

  • Kohdistamaton maksu: parametri unallocatedpayment_id

  • Käyttäjä, parametri user id

Huomaa

Tämä luettelo päivitettiin elokuussa 2024. Uusia koukkuja kehitetään jatkuvasti käyttäjien pyyntöjen perusteella.

REST API

Provet Cloud tarjoaa REST API:n, jonka avulla voidaan käyttää Provet Cloudiin tallennettuja tietoja. API käyttää OAuth 2.0 -todennusta. Tiedot palautetaan JSON -muodossa.

  • Jotta voit käyttää REST APIa, sinun on pyydettävä Provet Cloud Supportia luomaan sinulle integraatiomalli.

    • Provet Cloud API tukee kahta apurahatyyppiä: Valtuutuskoodi ja Client Credentials.

      • Valtuutuskoodia käytetään käyttöliittymien todentamiseen ja tapauksissa, joissa käyttäjät käyttävät sovellusrajapintaa omana itsenään. PKCE on tuettu ja erittäin suositeltava. Julkisten asiakkaiden PITÄÄ käyttää PKCE:tä.

      • Client Credentials -tunnuksia käytetään backend-yhteyksissä, joissa palvelut kommunikoivat suoraan toistensa kanssa ilman käyttäjän toimenpiteitä.

  • REST API:ta voidaan käyttää käyttämällä URL-osoitetta, joka on koottu seuraavasti: https://<provet_environment>/<provet_id>/api/0.1/

    • <provet_environment> URL-osoite vaihtelee hieman kussakin ympäristössä. Se voi olla esimerkiksi

      • provetcloud.com EU-ympäristöä varten

      • us.provetcloud.com USA:n ympäristöön

    • URL-osoitteessa <provet_id> on yrityksesi Provet Cloud -instanssin yksilöllinen tunnus.

    • Koko URL-osoite näkyy aina Provet Cloudin API-asetuksissa Asetukset > Integraatiot > Avoin API-yhteys.

Provet Cloud REST API on selattavissa, minkä pitäisi antaa kehittäjille hyvät mahdollisuudet arvioida tiedonsiirtomahdollisuuksia.

Integrointiluettelo Provet Cloudissa

Kun malli on luotu, integraatio näkyy Provet Cloudin integraatioluettelossa: Asetukset > Integraatiot > Open API access > Add Application. Luettelossa luetellaan käytettävissä olevat integraatiot ja siinä on lyhyt kuvaus siitä, mitä kukin integraatio tekee. Jos integraatiolla on lisäasennusohjeita, myös ne näkyvät luettelossa.

9947060702108-mceclip0.png

Integraatioilla voi olla rajoitettu näkyvyys: ne voidaan rajoittaa koskemaan vain tiettyjä Provet Cloud -vuokralaisia tai tiettyjä maita. Integraation tarjoava kolmas osapuoli voi valita, kuinka laajasti integraation on oltava näkyvissä vuokralaisille. Kun rajoituksia on, sovellus näkyy integraatioluettelossa vain niissä vuokralaisissa / niissä maissa, joissa se on sallittu.

Uuden asiakkaan rekisteröinnin vaihtoehdot

Aina kun uusi asiakas rekisteröityy käyttämään integraatiota eli valitsee sen Provet Cloudin integraatioluettelosta (Lisää sovellus), integraation tarjoajalle lähetetään asiakkaan yksilölliset tunnistetiedot. Uuden asiakkaan rekisteröinnistä ilmoittamiseen on kaksi vaihtoehtoa, jotka voidaan valita integraatiomallia luotaessa:

  • sähköpostiosoite

  • kytkennät URL

Kun integraatiota käytetään vain yhdessä Provet Cloud -instanssissa, sähköposti on hyvä valinta: silloin sähköpostin vastaanottaja voi määrittää tunnistautumistiedot integraatiolle ja aloittaa sen käytön. Toisaalta, kun integraatiota käytetään laajasti, suositellaan kytkentä-URL:ää ja uuden asiakkaan lisäämisen automatisointia.

Hookup URL kuuntelee automaattisia ilmoituksia uusista asiakkaista. Kun uusi asiakas lisää integraation Provet Cloudiin, orkestrointityökalu lähettää automaattisesti JSON-viestin kyseiseen URL-osoitteeseen. Mitään inhimillistä vuorovaikutusta ei tarvita, kun integraatio jäsentää uuden asiakkaan automaattisesti JSON-viestistä ja lisää hänen tunnistetietonsa asiakastaulukkoonsa.

JSON-skeema uusien integraatiorekisteröintien yhteydessä lähetettäville tiedoille:

{
"$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."
     }
 }
}

REST API:n kautta saatavilla olevat tiedot

REST API:n avulla voidaan lukea suurin osa tiedoista ja luoda/päivittää joitakin valittuja osia tiedoista. Selattavan API:n ensimmäisellä sivulla luetellaan kaikki kohteet, joita voidaan käyttää. Tässä on luettelo yleisimmistä objekteista.

Yleinen

Nimi

C

U

D

Kuvaus

Loppupiste

Mukautettu kenttä

Asetuksissa määritellyt mukautetut kentät; niitä voidaan käyttää esimerkiksi potilailla ja asiakkailla.

custom_fields

Mukautetun kentän arvo

Jos potilaan X kohdalla käytetään mukautettuja kenttiä, ne luovat rivin tänne.

custom_field_values

Huomautus

Potilaan/asiakkaan sivulla kohdassa "Notes & Communication" olevat muistiinpanot.

Huomautus

noteadmin

Tehtävä

Eläinlääkäreiden tehtävät

tehtävä

Muistutus

Muistutukset potilaille

muistutus

Muistutusmalli

Malli muistutusten luomista varten

remindertemplate

Asiakas & Potilas

Nimi

C

U

D

Kuvaus

Loppupiste

Asiakas

Asiakas potilaan puolesta

asiakas

Potilas

Potilas

potilas

Puhelinnumero

Asiakkaiden puhelinnumerot

puhelinnumero

Tuontihistoria

Mahdollistaa potilashistorian tuonnin vanhoista järjestelmistä tietyssä muodossa.

tuontihistoria

Laskutus

Nimi

C

U

D

Kuvaus

Loppupiste

Lasku

Laskut asiakkaille

lasku

Laskurivi

Laskujen laskurivit

invoicerow

Laskun maksu

Laskujen maksut

laskunmaksu

Ennakkomaksu

Asiakkaiden ennakkomaksut (tunnetaan myös nimellä kohdentamattomat maksut). Voidaan käyttää tulevan laskun maksamiseen

kohdentamaton maksu

Maksutapa

Järjestelmässä käytettävissä olevat maksutavat

maksutapa

Vakuutusvaatimus

Potilaiden vakuutushakemukset

vakuutusvaatimus

Vakuutuskorvausasiakas

Vakuutushakemusta varten asiakastiedoista kopioitu valeasiakas.

vakuutusvaatimusasiakas

Vakuutusvaatimuspotilas

Vakuutushakemusta varten potilastiedoista kopioitu valepotilas.

vakuutusvaatimus

Organisaatio

Nimi

C

U

D

Kuvaus

Loppupiste

Klinikan sijainti

Klinikan sijainnit

klinikan sijainti

Klinikan sijaintiryhmä

Klinikoiden sijaintien ryhmä

klinikan sijaintiryhmä

Käyttäjä

Käyttäjätili provet cloud

käyttäjä

Käyttäjän tiedot

Lisätietoja käyttäjästä

userdetails

Käyttäjäryhmä

Käyttäjät-työryhmä, liittyy käyttäjien käyttöoikeuksiin

käyttäjäryhmä

Tavaraluettelo

Nimikeluettelo sisältää X määrää nimikkeitä. Klinikoiden toimipisteet ovat tilanneet yhden nimikeluettelon, ja ne käyttävät sitä konsultaatioissa ja vastamyynnissä.

itemlist

Kohde

Asetusten kohteet. Yleinen laajennettava malli kaikille kohteille. Sisältää alatyyppejä: Elintarvikkeet, Laboratorioanalyysi, Laboratorioanalyysipaneeli.

Kohde

menettely

lääke

toimitus

ruoka

laboratorioanalyysi

laboratorioanalyysipaneeli

Kohderyhmä

Tunnetaan myös nimellä laskuryhmä. Erät voidaan ryhmitellä alaryhmän tietojen mukaan, jotka ovat suodatettavissa joissakin hauissa.

itemsubgroup

invoicegroup

ALV-ryhmä

Organisaation alv-ryhmät

vatgroup

Tekstimalli

ProvetCloudin ympärillä käytettävät mukautetut tekstimallit, esimerkiksi konsultaatiomuistiot ja kotiutusohjeet.

text_template

Kohteen malli

Kohteen mallit asetuksissa.Kuvaa joukon kohteita.

itemtemplate

Kohteen mallin kohde

Kohde tai kohteen malli asetusten kohdemallissa.

itemtemplateitem

Vaihtoehtoinen hinnoittelu

Vaihtoehtoisia hinnoitteluvaihtoehtoja tuotteelle, esimerkiksi halvemman irtomyynnin salliminen tietystä määrästä.

vaihtoehtoinen hinnoittelu

Luettelot

Mukautetut luettelot asetuksissa esimerkiksi lajeille ja roduille.

lista

Luettelo kohteita

Luetteloasetusten mukautettujen luetteloiden luettelokohta

listitem

Koodilistat

Kätevämpi tapa tarkastella luettelon kohteita. Sisältää vain aktiiviset luettelokohdat, mutta voi luetella koodit, jotka eivät tule tietokannasta, kuten esimerkiksi VeNom-koodit.

koodiluettelo

Pitopaikan numero

Tuotantoeläinten ominaisuuksiin liittyvät; potilaan pitopaikan numerotiedot

holdingplacenumerot

Varasto

Nimi

C

U

D

Kuvaus

Loppupiste

Taso

Kaikki varastotuotteet ja niiden tasot

varasto/kappale

stocklevel

Sijainti

Osakkeen sijaintipaikka

varasto/sijainti

Erä

Varastoerät varastotuotteita varten

varasto/erä

Sisäänkirjautuminen

Varastokirjaukset (käyttö) varastotavaroita varten

varasto/merkintä

Tukkukauppias

Tukkukauppiaat tilausten tekemistä varten

tukkukauppias

Tilaa

Tuotetilaus tukkukauppiaalle

tilaus

Tilaa tuote

Kohde tuotejärjestyksessä

orderitem

Diagnostinen kuvantaminen

Nimi

C

U

D

Kuvaus

Loppupiste

Työlista

Työlistamerkinnät diagnostisia kuvantamislähetteitä varten

diagnosticimaging_worklist

Modaliteetti

Diagnostisen kuvantamisen menetelmä

modaliteetti

Luokka

Diagnostisen kuvantamisen luokka

kuvantamisluokka

Alaluokka

Diagnostisen kuvantamisen luokkien alaluokka

imagingsubcategory

Kohdealue

Toimintatavan kohdealue

kohdealue

Resurssit

Diagnostisen kuvantamisen resurssi

resurssi

Konsultointi

Nimi

C

U

D

Kuvaus

Loppupiste

Konsultointi

Asiakkaan ja potilaan (potilaiden) konsultointi

kuuleminen

Kohde

Peruskohde kuulemiseen lisättäviä kohteita varten. Sisältää alatyyppejä: Elintarvikkeet, laboratorioanalyysi.

consultationitem

consultation_items/procedure

consultation_items/medicine

konsultointi_erät/tarvikkeet

consultation_items/food

consultation_items/analyysi

Hoitosuunnitelma

Hoitosuunnitelma, joka sisältää tietoja tulevaisuudessa käytettävistä kohteista.

hoitosuunnitelma

Hoitosuunnitelman kohta

Hoitosuunnitelman kohta.

hoitosuunnitelmamenettely

treatmentplanmedicine

hoitosuunnitelmatoimitus

treatmentplanfood

Arvio

Arvio kuulemista varten

arvio

Arvio erä

Kohde lisätty kuulemisarviota varten

estimateitem

Kohteen malli

Konsultaatioon lisätyt kohdemallit (tunnetaan myös nimellä konsultaatiokokonaisuudet).

consultationitemtemplate

Laboratorion lähete

Konsultaatiota koskeva lähete (tunnetaan myös nimellä pyyntö)

konsultaatio_laboratorio_lähete

Laboratorionäyte

Kuulemisanalyysejä ja kuulemispaneeleita sisältävä otos

konsultaatio_näyte

Diagnostisen kuvantamisen lähete

Konsultaatiota koskeva lähete (tunnetaan myös nimellä pyyntö)

diagnosticimaging_referral

Diagnostisen kuvantamisen kohdealue

Kuulemisessa käytetty kohdealue

konsultointi_kohdealue

Aikataulutus

Nimi

C

U

D

Kuvaus

Loppupiste

Nimitys

Potilaiden ajanvaraus. Tunnetaan myös nimellä aikataulutapahtuma

tapaaminen

Vuoro

Käyttäjien vuorot

shift

Vuoron tyyppi

Asetuksissa määritellyt työvuorotyypit

shifttype

Syy

Nimityksen syy

syy

Syyryhmä

Syyryhmät voivat olla klinikkakohtaisia. Käytetään syiden ryhmittelyyn hauissa

reason_group

Peruutuksen syy

peruutussyy

Triage

Instanssi, joka sisältää tietoja triage-tapahtumista

triage

Triage-luokka

Asetusten triage-luokat

triage_category

Triage-merkintä

Yksi tapahtuma triagessa

triage_entry

Eläinlääkärien saatavuus

Palauttaa eläinlääkäreiden käytettävissä olevat työvuorot tiettynä ajanjaksona.

eläinlääkärien_saatavuus

Online-varausasiakas

Dummy-asiakas luotu online-ajanvarausta varten

onlinebookingclient

On-line varaus potilas

Dummy-potilas luotu online-varausajanvarausta varten

onlinebookingpotilas

Luvat

Kun uusi integraatiosovellus lisätään Provet Cloudiin, kyseiselle integraatiolle luodaan automaattisesti virtuaalikäyttäjä. Virtuaalikäyttäjän nimi on Integraatio <Integraation nimi>, ja se löytyy Provet Cloudin käyttäjäasetuksista Virtual -välilehdeltä. Virtuaalikäyttäjä on oletusarvoisesti määritetty luparyhmään Users.

Jos integraatio tarvitsee erilaisia oikeuksia (jotkin päätepisteet on kielletty tai haluat rajoittaa oikeuksia), suosittelemme luomaan uuden luparyhmän vain kyseiselle virtuaalikäyttäjälle:

  1. Kopioi olemassa oleva käyttöoikeusryhmä tai luo uusi ja nimeä se uudelleen kuvaavalla nimellä, esimerkiksi samalla nimellä kuin integraatio.

  2. Anna ryhmälle tarvittavat oikeudet. Tarkista Provet Cloud API -kaaviosta, mitä oikeuksia kukin päätepiste tarvitsee. Tarkista myös Käyttäjien oikeuksien ja ryhmien hallinta.

  3. Muokkaa virtuaalikäyttäjää ja lisää käyttäjä uuteen luparyhmään (kenttä Default Permission Group). Käyttäjällä ei ole myöskään Työroolia, joten sekin on valittava. Tekninen on rooli, joka on tarkoitettu virtuaalikäyttäjille, kuten integraation käyttäjälle.

Käyttöesimerkki

Saadaksesi tietoja konsultaatiosta, jonka ID-numero on 338, HTTP GET-pyyntö, jossa on tunnistusparametrit, lähetetään seuraavaan URL-osoitteeseen: https://provetcloud.com/<provet_id>/api/0.1/consultation/338/.

Vastausesimerkki:

{
    "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
}

Vastauksesta on mahdollista selvittää edelleen tähän kuulemiseen liittyvän laskun tunnus sekä kaikki muut tähän kuulemiseen liittyvät yksiköt. Nämä voidaan sitten hankkia REST API -kutsuilla.

Suodattimet

Joissakin päätepisteissä on kenttiä, joita voidaan käyttää tulosten suodattamiseen. Suodatettavat kentät näkyvät Provet Cloud REST API -päätepistesivun yläosassa (esim. https://provetcloud.com/<provet_id>/api/0.1/consultation/), jos päätepisteessä on suodatettavia kenttiä.

Suodatukseen on käytettävissä seuraavat menetelmät (synonyymit erotetaan pilkulla):

  • on, eq (yhtä suuri)

  • is_not, not_eq, neq (ei yhtä suuri)

  • lt (alle)

  • lte (pienempi tai yhtä suuri)

  • gt (suurempi kuin)

  • gte (suurempi tai yhtä suuri)

  • range (väliset arvot, tarvitsee kaksi arvoa järjestyksessä [from,to])

  • not_in_range (edellä käänteinen)

  • contains (teksti sisältää etsityn tekstin, isojen ja pienten kirjainten erottelu)

  • contains_not (edellä käänteinen)

  • icontains (teksti sisältää etsityn tekstin, isojen ja pienten kirjainten erottelematta)

  • icontains_not (edellä käänteinen)

  • in (kohde löytyy annetusta listasta [arvo1,arvo2,arvo3])

  • not_in (edellä käänteinen)

  • is_null (tosi tai epätosi)

Suodatusmenetelmiä voidaan käyttää kyselyparametrien kanssa käyttämällä seuraavia syntaksia:

[field]__[method]=value (esim. client__is=10, joka käyttää asiakkaan id:tä hakua varten).

[field].[property]__[method]=value (esim. client.id__is=10)

Huomaa, että päivämäärät on annettava kyselyparametreille muodossa VVVV-KK-PVKK hh:mm+[aikavyöhyke]hh:mm (esim. 2017-12-24 15:30+00:00) .

Jos meidän on löydettävä kaikki kuulemiset, joissa on seuraavat ehdot

  • valitus sisältää sanan "vacc" (isot ja pienet kirjaimet erotetaan toisistaan)

  • admitted_time on välillä 2017-12-01 00:00+00:00 (suurempi tai yhtä suuri kuin) ja 2018-01-01 00:00+00:00 (pienempi kuin).

  • klinikan sijainnin id on 1

  • asiakastunnus on 10

  • yhden potilaan id konsultaatiossa on 20 %.

käytämme seuraavaa url-osoitetta:

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

Huomaa, että "+"-merkit on URL-koodattu (%2B) yllä olevassa esimerkissä, jotta URL-osoite toimisi.

Jos meidän on löydettävä kaikki kuulemiset, joissa

  • asiakkaan etunimi on John ja

  • asiakkaan sukunimi on Doe

käytämme seuraavaa URL-osoitetta:

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

Paljasta

Joillakin päätepisteillä on kenttiä, jotka voidaan paljastaa, jolloin näkyviin tulee joitakin paljastetun objektin sisäisiä kenttiä. Paljastettavat kentät näkyvät Provet Cloud REST API -päätepistesivun yläosassa (esim. https://provetcloud.com/<provet_id>/api/0.1/invoicerow/), jos päätepisteessä on paljastettavia kenttiä. Voit paljastaa kentän lisäämällä URL-osoitteeseen ?expose_<field_name>, aivan kuten suodattimia käytetään.

Integraation vapauttaminen

Kun olet kehittänyt ja testannut integraatiosi ja haluat vapauttaa sen julkiseen käyttöön, ota yhteyttä Provet Cloudin tukeen, jotta integraatiomallisi saadaan näkyviin kaikkiin Provet Cloud -instansseihin. Jos integraatiosi ei ole asiakaskohtainen ja sitä on tarkoitus käyttää monissa Provet Cloud -instansseissa monien käyttäjien toimesta, on joitakin vaatimuksia, jotka on täytettävä ennen käyttöönottoa. Näiden vaatimusten tarkoituksena on helpottaa integraation käyttöönottoa ja antaa tarvittavat tiedot Provet Cloudin tuelle.

  1. Luo lyhyt video integraatiostasi: miten sitä käytetään ja mitä se tekee.

  2. Luo käyttöönotto-ohje, joka sisältää kaikki manuaaliset vaiheet, joita Provet Cloud -käyttäjä tarvitsee integraatiosi käyttöönotossa. Vaiheet voivat sisältää myös järjestelmässäsi tarvittavat toimenpiteet.

  3. Toimita meille sekä video että käyttöönotto-opas ja kerro meille, millä markkinoilla / missä maissa integraatiosi pitäisi näkyä.

Päivitetty

Oliko tämä artikkeli hyödyllinen?

1/1 koki tästä olevan apua

Lisäkysymyksiä? Lähetä pyyntö

Kommentit

0 kommenttia

Kirjaudu sisään jättääksesi kommentin.