In het zorgproces kan er behoefte zijn aan een aanvullende softwaredienst vanuit een externe softwareontwikkelaar. Via een API-koppeling kan deze softwaredienst met Ons communiceren. De externe applicatie kan hiermee specifieke gegevens ophalen, plaatsen en updaten door het aanroepen van opengestelde API endpoints. Bijvoorbeeld door het ophalen van cliënt- of medewerkernummers of het bijwerken van een contactpersoon in Ons vanuit de externe applicatie. Deze gegevensuitwisseling kan pas plaatsvinden nadat een koppeling door ons is goedgekeurd en de zorginstelling goedkeuring heeft gegeven om de koppeling tot stand te brengen.
Meer technische informatie hierover vind je op www.ons-api.nl.
Wil je weten met welke partijen Ons kan koppelen, bekijk dan: Koppelen met Ons.
API-koppelingen aanvragen, activeren, gebruiken en opheffen
Bestaande, goedgekeurde koppelingen aanvragen, activeren en gebruiken:
Indien een API koppeling via Ons Podium kan worden aangevraagd, dan geldt hier een ander proces voor. Zie de handleiding over Ons Podium voor meer informatie hierover.
Voor het aanvragen van bestaande goedgekeurde koppelingen moeten de volgende stappen worden doorlopen:
- Neem contact op met de externe softwareleverancier. Zij moeten het technische deel van de koppelingsaanvraag bij Nedap indienen. Geef hun de volgende gegevens door:
Klantcode van de Ons-omgeving. Deze vind je via .
Contactpersoon van jouw organisatie. Dit moet iemand zijn die tickets in kan dienen via het supportportaal.
De externe softwareleverancier neemt vervolgens contact op met Nedap via een ticket in supportportaal, de contactpersoon van jouw organisatie wordt daaraan toegevoegd.
Geef als zorgorganisatie in het support-ticket toestemming voor de koppeling.
Nedap controleert de aanvraag en stuurt een ondertekend certificaat via het ticket naar de externe softwareleverancier en zorgorganisatie.
De externe softwareleverancier brengt met dit certificaat de koppeling tot stand.
Let op: Het certificaat is slechts één jaar geldig en moet jaarlijks vernieuwd worden. Dit moet door de externe leverancier worden bijgehouden.
Flowchart gegevensuitwisseling met Nedap Ons
Opheffen van een gebruikte API-koppeling
Wanneer je een reeds ingeschakelde API-koppeling wilt opheffen, dan dient dit ook aangegeven te worden bij de externe partij. Zij kunnen vervolgens het gebruikte certificaat deactiveren.
Let op! Na deze handeling blijft de koppeling nog wel zichtbaar in het overzicht van koppelingen in Ons Diensten. Hiervoor moet de door de zorgaanbieder gegeven toestemming om te koppelen worden ingetrokken. Dit kun je doen door een ticket aan te maken bij Healthcare Support.
Indien de koppeling nog gebruikt wordt, maar de toestemming wordt ingetrokken, dan wordt ook de algehele koppeling stopgezet. Dit gebeurt dan echter zonder dat de externe partij geïnformeerd wordt.
Nog niet bestaande, nog niet goedgekeurde koppelingen aanvragen
Wil je een koppeling met Ons realiseren voor jullie zorgorganisatie? Vraag dan je leverancier om een koppeling met Ons te maken. Het is voor alle leveranciers van applicaties mogelijk om een koppeling met Nedap Ons op te zetten.
Ben je als leverancier geïnteresseerd om een nieuwe koppeling te realiseren? Ga dan voor meer informatie naar www.ons-api.nl of meld je direct aan via https://api-dashboard.ons.io/intake.
Wij bieden ook een mogelijkheid om gegevens te importeren via XML-importbestanden. Het kan zijn dat een leverancier geen koppeling op basis van de Ons-API heeft, maar wel via de XML-import. Zie voor meer informatie: Gegevens importeren via XML-bestanden
Problemen met API-koppelingen oplossen
Het kan gebeuren dat het niet lukt om een koppeling tot stand te brengen, of dat er fouten met de koppeling optreden. Hieraan kunnen verschillende oorzaken ten grondslag liggen. Een aantal voorbeelden zijn:
Gegevens komen niet, of onjuist over via de koppeling.
Het certificaat is niet aangevraagd, of is verlopen en moet aangevraagd of vernieuwd worden.
Een oudere versie van een koppeling wordt gebruikt.
We adviseren om bij dergelijke situaties, of bij vragen over de algehele werking van een koppeling, altijd eerst de ontwikkelaar van deze koppeling te benaderen. Zij kunnen de werking van deze koppeling nalopen en indien nodig Support benaderen met technische aanvullingen.
