Hier vindt u alle informatie voor ontwikkelaars
Algemene uitleg
Basis concepten
Een voorbeeld toepassing
APIs
Authenticatie
Een toepassing ontwikkelen
Change log
Algemene uitleg
Basis concepten
Een voorbeeld toepassing
APIs
Authenticatie
Een toepassing ontwikkelen
Change log
Welkom bij het Developerplatform voor digitale zorg. In onderstaande kopjes kunt u lezen hoe u als applicatie of organisatie kan verbinden met HiX en gegevens kunt uitwisselen. Er wordt onder andere uitgelegd welke technische concepten erbij komen kijken en er wordt toelichting gegeven op de te gebruiken API’s voor de verbinding.
Zoals in de aansluitvoorwaarden ook staat omschreven sluiten we applicaties graag aan op verzoek van de zorginstelling. Het is dan ook belangrijk dat de zorginstelling afspraken maakt met u en met ChipSoft over de precieze invulling van de aansluiting. Zie de pagina ‘Contact’ als u nog aanvullende vragen heeft’ over dit proces en/of onderstaande informatie.
Zorgplatform ‘Digitale Zorg’ ondersteunt het gebruik van digitale toepassingen in de zorg aan patiënten. Denk hierbij aan het gebruik van bijvoorbeeld sensoren, apps en bots bij diagnostiek, behandeling en verpleging van patiënten. Zorgplatform Digitale Zorg creëert een veilig communicatiekanaal tussen het zorginformatiesysteem (XIS) van de zorginstelling en de door die zorginstelling expliciet vertrouwde digitale toepassingen.
Basis concepten
In-house store
Voorschrijven van digitale toepassingen
Uitwisselen van gegevens
Basis concepten
In-house store
Voorschrijven van digitale toepassingen
Uitwisselen van gegevens
Een aantal eenvoudige concepten liggen ten grondslag aan integratie op basis van Zorgplatform Digitale Zorg.
In-house store
Digitale toepassingen die op Zorgplatform aangesloten zijn, kunnen door een zorginstelling (zorgaanbieder) als ‘vertrouwd’ worden aangemerkt. Vertrouwde toepassingen worden in een voor de zorginstelling specifieke ‘in-house store’ opgenomen. Alleen digitale toepassingen uit de in-house store kunnen door zorgverleners van de zorginstelling worden gebruikt en kunnen communiceren met het XIS van die zorginstelling.
Digitale toepassingen uit de in-house store kunnen bijvoorbeeld:
- Door zorgverleners worden ‘voorgeschreven’ vanuit het XIS van de zorginstelling
- Gegevens uitwisselen met het XIS van de zorginstelling op basis van een geldig voorschrift
- Gebruik maken van de Zorgplatform Single sign-on voorziening
Voorschrijven van digitale toepassingen
Vertrouwde digitale toepassingen uit de in-house store kunnen worden voorgeschreven aan een patiënt, net zoals medicatie of een ander traditioneel medisch hulpmiddel wordt voorgeschreven aan een patiënt. Hierbij geldt:
- Een voorschrift is geldig zolang het niet is beëindigd
- Een voorschrift wordt automatisch beëindigd indien vooraf een termijn is ingesteld
- Een voorschrift kan daarnaast op ieder moment door de zorgverlener of de patiënt zelf worden beëindigd
De digitale toepassing kan gegevens van een specifieke patiënt uitwisselen zolang het voorschrift geldig is.
Voorschrijven van een digitale toepassing kan worden geïntegreerd binnen het XIS van de zorginstelling, net zoals het voorschrijven van medicatie (meestal) is geïntegreerd binnen het XIS van de zorginstelling.
Voorbeelden van het voorschrijven van digitale toepassingen zijn:
- Een orthopeed schrijft een PROM (Patient Reported Outcome Measures) app voor
- Een cardioloog schrijft een app voor thuismonitoring voor
- Een kinderarts schrijft een ‘bot’ voor ten behoeve van vroegtijdige onderkenning van complicaties na een operatie
- Een oncoloog schrijft een digitale keuzehulp voor
- Een transferverpleegkundige schrijft een app voor waarmee de overdracht naar een verzorgingshuis kan worden geautomatiseerd
Uitwisselen van gegevens
Zorgplatform biedt 'gegevensdiensten' ten behoeve van het uitwisselen van gegevens met het XIS van zorginstellingen. Iedere gegevensdienst biedt een API. Een digitale toepassing krijgt toegang tot de gegevensdiensten op basis van de volgende regels:
- Toegang voor zover gemachtigd; machtigingen worden aangevraagd bij integratie van de toepassing met Zorgplatform
- De toepassing is opgenomen in de in-house store van de XIS van de zorgaanbieder
- De toepassing heeft alleen toegang tot gegevens van patiënten waarvoor een geldig voorschrift bestaat
- Sommige gegevensdiensten zijn alleen toegankelijk als er ook expliciete patiëntentoestemming is
- Zorgplatform gegevensdiensten kunnen uitsluitend worden aangeroepen met een geldig Zorgplatform token
In-house store
Voorschrijven van digitale toepassingen
Uitwisselen van gegevens
Een aantal eenvoudige concepten liggen ten grondslag aan integratie op basis van Zorgplatform Digitale Zorg.
Digitale toepassingen die op Zorgplatform aangesloten zijn, kunnen door een zorginstelling (zorgaanbieder) als ‘vertrouwd’ worden aangemerkt. Vertrouwde toepassingen worden in een voor de zorginstelling specifieke ‘in-house store’ opgenomen. Alleen digitale toepassingen uit de in-house store kunnen door zorgverleners van de zorginstelling worden gebruikt en kunnen communiceren met het XIS van die zorginstelling.
Digitale toepassingen uit de in-house store kunnen bijvoorbeeld:
- Door zorgverleners worden ‘voorgeschreven’ vanuit het XIS van de zorginstelling
- Gegevens uitwisselen met het XIS van de zorginstelling op basis van een geldig voorschrift
- Gebruik maken van de Zorgplatform Single sign-on voorziening
Vertrouwde digitale toepassingen uit de in-house store kunnen worden voorgeschreven aan een patiënt, net zoals medicatie of een ander traditioneel medisch hulpmiddel wordt voorgeschreven aan een patiënt. Hierbij geldt:
- Een voorschrift is geldig zolang het niet is beëindigd
- Een voorschrift wordt automatisch beëindigd indien vooraf een termijn is ingesteld
- Een voorschrift kan daarnaast op ieder moment door de zorgverlener of de patiënt zelf worden beëindigd
De digitale toepassing kan gegevens van een specifieke patiënt uitwisselen zolang het voorschrift geldig is. Voorschrijven van een digitale toepassing kan worden geïntegreerd binnen het XIS van de zorginstelling, net zoals het voorschrijven van medicatie (meestal) is geïntegreerd binnen het XIS van de zorginstelling.
Voorbeelden van het voorschrijven van digitale toepassingen zijn:
- Een orthopeed schrijft een PROM (Patient Reported Outcome Measures) app voor
- Een cardioloog schrijft een app voor thuismonitoring voor
- Een kinderarts schrijft een ‘bot’ voor ten behoeve van vroegtijdige onderkenning van complicaties na een operatie
- Een oncoloog schrijft een digitale keuzehulp voor
- Een transferverpleegkundige schrijft een app voor waarmee de overdracht naar een verzorgingshuis kan worden geautomatiseerd
Zorgplatform biedt 'gegevensdiensten' ten behoeve van het uitwisselen van gegevens met het XIS van zorginstellingen. Iedere gegevensdienst biedt een API. Een digitale toepassing krijgt toegang tot de gegevensdiensten op basis van de volgende regels:
- Toegang voor zover gemachtigd; machtigingen worden aangevraagd bij integratie van de toepassing met Zorgplatform
- De toepassing is opgenomen in de in-house store van de XIS van de zorgaanbieder
- De toepassing heeft alleen toegang tot gegevens van patiënten waarvoor een geldig voorschrift bestaat
- Sommige gegevensdiensten zijn alleen toegankelijk als er ook expliciete patiëntentoestemming is
- Zorgplatform gegevensdiensten kunnen uitsluitend worden aangeroepen met een geldig Zorgplatform token
Een voorbeeld toepassing
Een voorbeeld toepassing
Als voorbeeld omschrijven we een aantal use cases van een toepassing voor thuismonitoring. Meer use cases en de relaties tussen use cases worden omschreven op de pagina 'Use cases'.
- Een zorgverlener schrijft thuismonitoring voor aan een patiënt gewoon vanuit ‘zijn eigen XIS’ door een toepassing te selecteren uit de in-house store. Het gewenste monitoringprotocol en alarmgrenzen worden door de zorgverlener in de toepassing ingesteld zonder dat hij daarvoor in de toepassing hoeft in te loggen of een patiënt hoeft te selecteren
- De toepassing voor thuismonitoring authenticeert zich om toegang te krijgen tot de Zorgplatform Home monitoring service. De toepassing gebruikt die gegevensdienst om alerts naar het XIS van de zorginstelling te versturen wanneer dat nodig is.
- Zorgverleners worden direct in eigen XIS op de hoogte gesteld van een alert, en kunnen die daar direct openen om de details te bekijken en erop te handelen
Als voorbeeld omschrijven we een aantal use cases van een toepassing voor thuismonitoring. Meer use cases en de relaties tussen use cases worden omschreven op de pagina 'Use cases'.
- Een zorgverlener schrijft thuismonitoring voor aan een patiënt gewoon vanuit ‘zijn eigen XIS’ door een toepassing te selecteren uit de in-house store. Het gewenste monitoringprotocol en alarmgrenzen worden door de zorgverlener in de toepassing ingesteld zonder dat hij daarvoor in de toepassing hoeft in te loggen of een patiënt hoeft te selecteren
- De toepassing voor thuismonitoring authenticeert zich om toegang te krijgen tot de Zorgplatform Home monitoring service. De toepassing gebruikt die gegevensdienst om alerts naar het XIS van de zorginstelling te versturen wanneer dat nodig is.
- Zorgverleners worden direct in eigen XIS op de hoogte gesteld van een alert, en kunnen die daar direct openen om de details te bekijken en erop te handelen
APIs
APIs
Zorgplatform biedt API's voor gegevensdiensten. Voorbeelden van gegevensdiensten zijn:
- Zorgplatform Workflow Service: FHIR Workflow API
- Zorgplatform Document Service: FHIR Documents API
- Zorgplatform Administration Service: FHIR Administration API
- Zorgplatform Home Monitoring Service: FHIR Monitoring API
- Zorgplatform BgZ Service: FHIR BgZ API
- Zorgplatform Notification Service: FHIR Notification API, in ontwikkeling
De API's zijn gebaseerd op FHIR. Het overzicht van alle FHIR Resources die Zorgplatform momenteel uitwisselt, staat beschreven op de pagina 'FHIR specificaties'. Of ga direct naar de Swagger documentatie (momenteel enkel nog beschikbaar voor BgZ API).
Zorgplatform biedt API's voor gegevensdiensten. Voorbeelden van gegevensdiensten zijn:
- Zorgplatform Workflow Service: FHIR Workflow API
- Zorgplatform Document Service: FHIR Documents API
- Zorgplatform Administration Service: FHIR Administration API
- Zorgplatform Home Monitoring Service: FHIR Monitoring API
- Zorgplatform BgZ Service: FHIR BgZ API
- Zorgplatform Notification Service: FHIR Notification API, in ontwikkeling
De API's zijn gebaseerd op FHIR. Het overzicht van alle FHIR Resources die Zorgplatform momenteel uitwisselt, staat beschreven op de pagina 'FHIR specificaties'. Of ga direct naar de Swagger documentatie (momenteel enkel nog beschikbaar voor BgZ API).
Authenticatie
Authenticatie
De Zorgplatform Security Token Service (STS) geeft tokens uit aan vertrouwde applicaties, zoals omschreven op de pagina 'Authenticatie'. Deze tokens worden door vertrouwde applicaties gebruikt om:
- Zorgplatform operaties (service calls) aan te roepen. Zowel SOAP gebaseerde operaties als RESTful (FHIR) operaties
- Ten behoeve van Single sign-on scenario’s
De Zorgplatform Security Token Service (STS) geeft tokens uit aan vertrouwde applicaties, zoals omschreven op de pagina 'Authenticatie'. Deze tokens worden door vertrouwde applicaties gebruikt om:
- Zorgplatform operaties (service calls) aan te roepen. Zowel SOAP gebaseerde operaties als RESTful (FHIR) operaties
- Ten behoeve van Single sign-on scenario’s
Een toepassing ontwikkelen
Een toepassing ontwikkelen
Om een nieuwe of bestaande Digitale zorgtoepassing aan te sluiten op Zorgplatform zijn een aantal stappen nodig. Deze stappen staan omschreven op de pagina 'Aansluiten'.
- Aanvragen van een aansluiting voor de toepassing
- Ontwikkelen en testen van de app aansluiting
- De app beschikbaar stellen
Om een nieuwe of bestaande Digitale zorgtoepassing aan te sluiten op Zorgplatform zijn een aantal stappen nodig. Deze stappen staan omschreven op de pagina 'Aansluiten'.
- Aanvragen van een aansluiting voor de toepassing
- Ontwikkelen en testen van de app aansluiting
- De app beschikbaar stellen
Change log
Change log
Zorgplatform wordt continu doorontwikkeld. Nieuwe functionaliteiten worden opgenomen in de documentatie nadat deze met minstens één digitale zorgapplicatie beproefd zijn. Voor een overzicht van de aanpassingen aan de ontwikkelaarswebsite, zie 'Change log'
Zorgplatform wordt continu doorontwikkeld. Nieuwe functionaliteiten worden opgenomen in de documentatie nadat deze met minstens één digitale zorgapplicatie beproefd zijn. Voor een overzicht van de aanpassingen aan de ontwikkelaarswebsite, zie 'Change log'