Ysis API – Overzicht

Deze pagina geeft toelichting over het gebruik van de Ysis webservice API.
Hier worden alleen de standaard YSIS methoden toegelicht. Voor veel koppelingen worden ook vanuit Ysis aanroepen gedaan naar de API van de partner. Zie hiervoor de betreffende ontwerpdocumenten.

Omgevingen

Acceptatie 1 (https://organisatienaam.acceptatie1.ysis.nl)

Deze omgeving is bedoelt voor het ontwikkeling van koppelingen samen met Partners. Deze omgeving bevat geen productiedata, maar in plaats daarvan een fictive organisatie genaamd naar de partner. GeriMedica verstrekt toegang tot de API voor deze organisatie en een Ysis inlog account voor testdoeleinden.

Acceptatie 2 (https://organisatienaam.acceptatie2.ysis.nl)

Deze omgeving is bedoelt voor de acceptatietesten van klanten. De omgeving bevat een kopie van de productiedata met alle organisaties en dossier. Deze data wordt minimaal 4 keer per jaar ververst. Gerimedica communiceert de datums waarop dit gaat plaatsvinden tijdig naar onze contactpersonen bij de klant. Houdt dit in de gaten, want bij het verversen gaan de gegevens die direct in Acceptatie 2 zijn ingevoerd  verloren.
GeriMedica houdt zich het recht voor deze omgeving zonder overleg op andere momenten te verversen als dit voor het oplossen van ernstige storingen nodig is, hoewel wij dit natuurlijk proberen te vermijden.
GeriMedica verstrekt geen inlog aan derden tot deze omgeving, alleen aan de klant zelf.
NB: Momenteel wordt deze omgeving door veel klanten ook als training omgeving gebruikt. GeriMedica is voornemens hier op termijn een eigen omgeving voor beschikbaar te stellen.

Productie (https://organisatienaam.ysis.nl)

Feitelijke productieomgeving. Niet bedoelt voor test of training doeleinden.

Beveiliging

Toegang tot de webservices is beveiligd met client certificaten. Dit dient als autorisatie, en ook als identificatie: aan het certificaat zien wij welke organisatie de gegevens opvraagt en geven we toegang tot de juiste gegevens.
Per omgeving is een eigen certificaat nodig zodat testomgevingen niet per abuis aan productieomgevingen kunnen worden gekoppeld.
Zie voor meer informatie: Certificaten

API Interface

De Ysis webservices zijn onderverdeeld in een aantal koppelvlakken.
Alle methods die gerelateerd zijn aan een dossier vereisen een BSN nummer: dossiers zonder BSN nummer kunnen niet worden gekoppeld.
Een aantal van de webmethods gebruiken selectielijsten. Er is een vertaaltabel beschikbaar waar de bijbehorende terminologie in de Ysis applicatie word vermeld.
Deze API geeft alleen de actuele gegevens terug, geen historische of toekomstige gegevens tenzij expliciet vermeld.
NB: Let op dat bij het meesturen van datums de timezone wordt meegenomen volgens de standaarden, dus bijvoorbeeld +2:00 voor GMT, of Z voor UTC.

Administratief

Administratieve gegevens van de patiënt.
getAdminstrativeDetails
Geeft de huidige administratieve gegevens van de patient terug. Dit bevat de persoonsgegevens, adres, contactpersonen, verzekeringsgegevens en huisarts.
updateAdministrativeDetails
Hiermee kunnen de administratieve gegevens in Ysis worden aangepast.

Medisch

listAdvices
Adviezen die voor de patiënt beschikbaar zijn.
getBasicMedicalData
Geeft de medische basisgegevens van de patiënt in Ysis terug. Dit bevat de inschrijving, beleid, allergieën en medische voorgeschiedenis.
getReports
Geeft 1 of meer rapportages terug van een patiënt.
getModifiedReports
Geeft een lijst van mutaties sinds de aangegeven datum. Speciaal bedoelt voor systemen die niet kunnen reageren op notificaties die door Ysis worden verstuurd en batchgewijs hun gegevens moeten bijwerken.
icpcQuery
Geeft de lijst met ICPC codes van de patiënt.
getFinancingTypes
Geeft terug welke financieringsvormen van zorg deze patiënt ontvangt.
LabResultsQuery
Geeft de laboratorium resultaten van de patiënt die Ysis via zorgmail heeft ontvangen en verwerkt.
ActiveTreatmentPlan
Geeft het huidige actieve multidisciplinaire behandelplan van Ysis terug in de vorm van html.
getMessage
Geeft 1 specifiek bericht terug op basis van het ID
listMessages
Geeft de lijst van berichten die vanuit Ysis zijn verstuurd aan de discipline ‘Verzorgenden’

Juridisch

getBopz
Geeft de Bopz gegevens terug. Dit bevat de Juridische status, de Wilsbekwaamheid en een lijst van actuele VBM’s.

legal status (rest)
Dit bevat de Juridische status, de Wilsbekwaamheid.

legal ovz (rest)
Dit geeft de lijst van vrijheidsbeperkende maatregelen volgens de WZD wetgeving terug.

Timeline / Afspraken

Afspraken / plannings-integratie voor een patiënt.
createAppointment
Maak een timelineitem in Ysis.
updateAppointment
Wijzig een bestaande afspraak
deleteAppointment
Verwijder een afspraak

Organisation

getLocations
Geeft de lijst van groepen, locaties en afdelingen voor deze organisatie. Handig voor het synchroniseren van afdelingen en kostenplaatsen.

Notifications

Geeft hiermee aan Ysis door dat er wijzigingen in uw systeem zijn geweest voor deze patiënt. Ysis gaat vervolgens de gegevens bij u ophalen en verwerken. Ondersteuning voor uw systeem moet daarvoor wel specifiek in Ysis worden ingebouwd. Dit wordt in deze methode verder toegelicht.
notification
Met deze methode kan aan Ysis worden doorgegeven dat er gegevens zijn gewijzigd. Ysis kan hierop acteren door de betreffende gegevens op te halen bij het bronsysteem.