Inhoud van deze pagina
Terug: Technische documentatie

eHealthBox RSS

Algemene informatie

Download het informatieblad

De dienst eHealthBox van eHealth-platform is een beveiligde elektronische brievenbus, die specifiek ontwikkeld werd voor de zorgverleners en instellingen. De bedoeling is om een beveiligde elektronische mededeling van de nodige vertrouwelijke en medische gegevens tussen de Belgische actoren in de gezondheidszorg mogelijk te maken.

De dienst eHealthBox is beschikbaar als webservice (toegankelijk via een medisch softwarepakket) en als webtoepassing (toegankelijk via een pc en een eID/itsme of TOTP).

Welke functionaliteiten biedt de dienst eHealthBox?

De dienst eHealthBox biedt de volgende functionaliteiten:

  • als webtoepassing, een pakket dat het volgende omvat:
    • een dienst voor de raadpleging van berichten,
    • een dienst voor de publicatie van berichten,
    • de dienst ‘eHealth update info’, een toepassing die toelaat om via een e-mailadres (bv. een webmailadres gekozen door de zorgverlener) verwittigd te worden als er nieuwe berichten binnenkomen in de eHealthBox,
    • een dienst voor de raadpleging van algemene informatie over de capaciteit van de mailbox (huidig volume, maximaal toegelaten volume, aantal niet-ontvangen berichten als de mailbox vol zit ...),
    • een notificatiedienst die een overzicht biedt van de status van de berichten (ontvangen en/of gelezen),
    • de mogelijkheid om de berichten te organiseren en te verplaatsen tussen de verschillende dossiers.
  • als webservice, eenpublicatiedienst voor het verzenden van berichten, die het volgende omvat:
    • een out-of-officedienst die toelaat te verwijzen naar een vervangende zorgverlener:
      • een functionaliteit voor gegroepeerde mailverzending op basis waarvan een of meerdere berichten naar een groep zorgverleners verzonden kunnen worden (bijvoorbeeld een bericht ter attentie van het verplegend personeel van een ziekenhuis),
      • een versleutelingsdienst om de integriteit van de meegedeelde gegevens te waarborgen,
      • de mogelijkheid om bijlagen te verzenden (het volume van de berichten mag niet groter zijn dan 10 MB),
      • de mogelijkheid om berichten van het type 'news' te verzenden, dat zijn berichten die men ongelimiteerd kan actualiseren.
    • een dienst voor de raadpleging van de berichten die het volgende omvat:
      • een dienst voor de raadpleging van algemene informatie over de capaciteit van de mailbox (huidig volume, maximaal toegelaten volume, aantal niet-ontvangen berichten als de mailbox vol zit ...),
      • een notificatiedienst die een overzicht biedt van de status van de berichten (ontvangen en/of gelezen),
      • een dienst voor de raadpleging van een samenvatting van de berichten (geordend op datum),
      • de mogelijkheid om gelijktijdig verschillende mailboxen te raadplegen (bijvoorbeeld de mailbox van een zorgverlener in zijn hoedanigheid van individuele zorgverlener en zijn mailbox in de hoedanigheid van zorgverlener binnen een ziekenhuis),
      • de mogelijkheid om de berichten te organiseren en te verplaatsen tussen de verschillende dossiers.
    • een dienst genaamd 'eHealth Addressbook' die:
      • toelaat een zorgverlener op te zoeken op basis van:
        • het rijksregisternummer (en optioneel zijn beroep),
        • het RIZIV-nummer (en optioneel zijn beroep)
        • het beroep en de naam (en optioneel zijn voornaam)
        • het beroep en de postcode
        • het beroep en de gemeente
        • het e-mailadres
      • toelaat een zorginstelling op te zoeken op basis van:
        • het EHP-nummer (en optioneel het type instelling),
        • het RIZIV-nummer (en optioneel het type instelling),
        • het KBO-nummer (en optioneel het type instelling),
        • de naam en het type instelling,
        • het type instelling en de postcode,
        • het type instelling en de gemeente,
      • toelaat de meest recente contactgegevens van een zorgverlener of een zorginstelling te raadplegen (opgenomen in de authentieke bronnen):
        • voor een actor in de gezondheidszorg: rijksregisternummer / naam / voornamen / taal / geslacht / geboortedatum / eventuele datum van overlijden / adres / contactgegevens / RIZIV-nummer / beroep / beroepscode / specialisatie / specialisatiecode / professioneel adres / eHealthBox,
        • voor een zorginstelling: identificatienummer (met type EHP/CBE/NIHII) van de instelling / beschrijving van de instelling / type instelling / benaming / adressen / andere contactgegevens / eHealthBox,
        • de teruggestuurde eHealthBox-gegevens omvatten: identificatienummer van de box en typenummer (INSZ, NIHII, CBE), eventueel het subtype (bijvoorbeeld ziekenhuis), de hoedanigheid van de actor in de gezondheidszorg of de instelling.

In de praktijk

Afhankelijkheden, aanbevelingen en waarschuwingen

De dienst eHealthBox werd ontwikkeld voor zorginstellingen en de zorgverleners die over een RIZIV-nummer beschikken.

Om de eHealthBox als webtoepassing te gebruiken moet de zorgverlener zich aanmelden via een pc aan de hand van een eID, itsme of een TOTP. Het is ook belangrijk om een webbrowser te gebruiken die getest werd door eHealth-platform. Raadpleeg daarvoor de informatie over toegang tot webtoepassingen op eGezondheid.

Om de eHealthBox als webservice te gebruiken dient te zorgverlener te beschikken over een medisch softwarepakket dat deze dienst geïntegreerd heeft (dit is het geval voor alle softwarepakketten die geregistreerd werden door eHealth-platform).

Wat zijn de voorwaarden voor de integratie van de dienst eHealthBox van het eHealth-platform?

  • Neem contact op met Wolf Wauters, de verantwoordelijke projectleider binnen het eHealth-platform, via het e-mailadres Wolf.Wauters@ehealth.fgov.be. Beschrijf de context en de doelstelling van uw project en geef een raming op het vlak van volume.
  • Indien akkoord, dient u te beschikken over een eHealth-certificaat en te voorzien in de integratie van een versleutelingsdienst.

Om de integratie van de webservice voor publicatie en raadpleging van de eHealthBox te vergemakkelijken, stelt het eHealth-platform connectoren ter beschikking van de actoren in de gezondheidszorg.

Meer informatie via support@ehealth.fgov.be.

Cookbook

eHealthBox v.3 Consultation WS - Cookbook

Functionele en technische informatie over de integratie van de webservice voor het raadplegen van eHealthBox. Deze versie integreert onder andere het gebruik van de functie Out Of Office.

eHealthBox v.3 Consultation WS - Cookbook Versie 3.12 (26/07/23) - 2.89 MB
Dit document is in het Engels

eHealthBox MetaData Standard Use - Cookbook

Het doel van het gebruik van de CustomMeta in eHealthBox berichten is om extra (optioneel) routingmogelijkheden te bieden aan grotere organisaties (zoals ziekenhuizen).

eHealthBox MetaData Standard Use - Cookbook Versie 2.1 (30/04/18) - 348.4 KB
Dit document is in het Engels

eHealth AddressBook REST v1

De eHealth AddressBook REST Consultation is een REST-implementatie van de AddressBook SOAP Consultation en maakt het voor een gebruiker mogelijk om de contactgegevens van gezondheidszorgverleners op te zoeken en op te halen. 

eHealth AddressBook REST v1 Versie 1.0 (10/04/24) - 734.6 KB
Dit document is in het Engels

eHealthBox REST v.1

De webservice eHealthBox REST v.1 (voorheen eHealthBox v.4 genoemd) is een REST-service waarmee een geauthenticeerde gebruiker (mogelijk gecodeerde) eHealthBox berichten voor verschillende geadresseerden kan raadplegen en publiceren met optionele elementen zoals bijlagen en metagegevens. Dit document bevat de nodige informatie om een organisatie in staat te stellen deze dienst te integreren in haar eigen aangepaste applicatie.

eHealthBox REST v.1 Versie 1.12 (03/04/23) - 2.14 MB
Dit document is in het Engels

eHealthBox v.3 Publication WS - Cookbook

Functionele en technische informatie over de integratie van de webservice publicatie eHealthBox v3.0. Deze versie integreert onder andere het gebruik van de functie Out Of Office.

eHealthBox v.3 Publication WS - Cookbook Versie 3.13 (27/07/23) - 924.38 KB
Dit document is in het Engels

eHealth Address book Consultation WS - Cookbook

De Address Book WS is opgezet voor de Belgische gezondheidssector als antwoord op de basisbehoefte om te beschikken over de meest nauwkeurige, up-to-date en nuttige contactinformatie voor gezondheidswerkers en –organisaties. Het systeem combineert informatie afkomstig van verschillende betrouwbare authentieke bronnen en fungeert als extra tussenlaag. De gebruiker kan deze dienst gebruiken om contactgegevens op te halen van verschillende personen of organisaties in de gezondheidszorg.

eHealth Address book Consultation WS - Cookbook Versie 1.11 (31/08/23) - 2.43 MB
Dit document is in het Engels

eH2eBox - Cookbook

Dit cookbook biedt functionele en technische informatie over deze toepassing. Het stelt een organisatie in staat de eH2eBox van het eHealth-platform te integreren en te gebruiken.
Opgelet: deze dienst is momenteel alleen beschikbaar voor het Mult-eMediatt-project en eAttest.

eH2eBox - Cookbook Versie 1.10 (22/08/24) - 623.08 KB
Dit document is in het Engels

Informatief document

SOA – Error Guide

Alle diensten gebruiken uniform gedefinieerde foutcodes om systeemfouten te melden. In dit document vindt u een overzicht van mogelijke foutmeldingen en hun oplossing.

SOA – Error Guide Versie 1.0 (10/06/21) - 668.68 KB
Dit document is in het Engels

API JSON Swagger

Dit bestand is de API JSON/Swagger die de interface van de REST-service beschrijft.

API JSON Swagger Versie 1.0 (11/02/20) - 69 KB
Dit document is in het Engels

eHealthBox – Supported Qualities

List of the allowed combinations “Type – Quality” in eHealthBox

eHealthBox – Supported Qualities Versie 1.4 (22/12/21) - 652.39 KB
Dit document is in het Engels

eHealthBox v.1 REST – Richtlijnen gebruik

Richtlijnen voor de gebruikers van de eHealthBox v.1 REST

eHealthBox v.1 REST – Richtlijnen gebruik Versie 1.3 (26/10/22) - 1.02 MB
Dit document is in het Nederlands

eHealthBox v.3 SOAP – Richtlijnen gebruik

Richtlijnen voor de gebruikers van de eHealthBox v.3 SOAP

eHealthBox v.3 SOAP – Richtlijnen gebruik Versie 1.4 (26/10/22) - 957.54 KB
Dit document is in het Nederlands

Service Level agreement/SLA

eHealthBox SLA

Het doel van dit document is het bepalen van het “Service Level Agreement” voor de het geheel van de diensten die zijn opgenomen in de eHealtBox WS toepassing zoals deze voorgesteld wordt door het eHealth-platform.

eHealthBox SLA Versie 2.1 (24/07/18) - 656.56 KB
Dit document is in het Engels

AddressBook - SLA

Het doel van dit document is het bepalen van het “Service Level Agreement” voor de het geheel van de diensten die zijn opgenomen in de “AddressBook” toepassing zoals deze voorgesteld wordt door het eHealth-platform.

AddressBook - SLA Versie 2.1.3 (24/07/18) - 681 KB
Dit document is in het Engels

eH2eBox - SLA

Het doel van dit document is het bepalen van het “Service Level Agreement” voor de het geheel van de diensten die zijn opgenomen in de eH2eBox toepassing zoals deze voorgesteld wordt door het eHealth-platform.

eH2eBox - SLA Versie 1.0 (06/04/20) - 1.11 MB
Dit document is in het Engels

Specification SSO

AddressBook – SSO

Dit document geeft een volledig overzicht van het profiel en de stapsgewijze implementatie voor de configuratie van de beveiliging van een nieuwe toepassing met de SSO@eHealth.

AddressBook – SSO Versie 1.3 (22/04/20) - 793.41 KB
Dit document is in het Engels

eHealth platform SSO eHealthBox

Dit document geeft een volledig overzicht van het profiel en de stapsgewijze implementatie voor de configuratie van de beveiliging van een nieuwe toepassing met de SSO@eHealth.

eHealth platform SSO eHealthBox Versie 1.2 (22/04/20) - 808.35 KB
Dit document is in het Engels

Handleiding

Beveiligde elektronische brievenbus (eHealthBox) - Handleiding

De eHealthBox is een beveiligde elektronische brievenbus die ervoor zorgt dat de gebruiker via een beveiligde ruimte gegevens kan overbrengen naar een andere gebruiker. Dit document toont stapsgewijs hoe deze tool te aan te wenden.

Beveiligde elektronische brievenbus (eHealthBox) - Handleiding Versie 3.1 (05/07/21) - 1.01 MB
Dit document is in het Nederlands

Procedure

Onboarding IAM Connect eHealthBox - Addressbook

Voor het gebruik van de eHealthBox en het Addressbook als  REST diensten, is het noodzakelijk om de integratie ervan te vragen via de procedure uitgelegd in dit document.

Onboarding IAM Connect eHealthBox - Addressbook Versie 2.0 (29/05/24) - 402.4 KB
Dit document is in het Engels

Gebruikersregels

eHealthBox Reglement

In de praktijk gebruikers toegang geven tot het gebruik van het systeem eHealthBox.

eHealthBox Reglement Versie 3.0 (20/06/19) - 239.87 KB
Dit document is in het Nederlands

Contact

Ons formulier wordt geladen. Als deze melding zichtbaar blijft en er geen formulier verschijnt, controleer dan of Javascript in uw browser is geactiveerd, accepteer de betreffende cookies en probeer deze pagina opnieuw te laden.

API Catalog

De portal 'API Catalog' is de catalogus van de webservices die aangeboden worden door het eHealth-platform en zijn partners via de API Gateway, die onder meer instaat voor het beheer van het gebruik van de webservices.

Het betreft:

  • technische informatie: URL, versie, formeel contract (WSDL+XSD voor de SOAP-diensten of Swagger voor de REST-diensten
  • functionele informatie: link naar de beschikbare documentatie, beschrijving van de online diensten.
Toegang tot de API Catalog

FAQ

Wijzig de taal van uw eHealthBox als u dat wenst via het icoon ‘Configuratie’.


Klik op het icoon en kies dan ‘Een periode toevoegen’.
Geef de start- en einddatum van uw onbeschikbaarheid in.
Voer de gegevens van uw eventuele vervanger in. Klik daarna op de knop ‘Toevoegen’.


Klik op het kruisje rechts om een periode van onbeschikbaarheid te verwijderen.


U kunt per e-mail een melding ontvangen als:

  • u een nieuw bericht hebt in uw eHealthBox;
  • een bericht op het punt staat te vervallen;
  • uw eHealthBox bijna vol is.

Hoe activeert of deactiveert u e-mailmeldingen?

  • Klik op het icoon ‘Configuratie’,
  • Klik op het tabblad ‘E-mailmeldingen’,
  • Klik op de knop 'Activeer/Deactiveer',
  • Voer uw e-mailadres in,
  • Bevestig uw e-mailadres,
  • Klik op de knop ‘Opslaan’.
     

  • Het INSZ-nummer (nummer van 11 cijfers op de achterzijde van de identiteitskaart)
  • Het NIHII (RIZIV-nummer: 8 cijfers of 11 cijfers)
  • Het KBO-nummer (ondernemingsnummer: 10 cijfers)
  • Het EHP-nummer (nummer van de instelling: 10 cijfers)

Als uw eHealthBox vol is, dan komen nieuwe berichten in een wachtrij te staan. Maak plaats, bijvoorbeeld door oude berichten te verwijderen.


Raadpleeg het document eHealthBox - Supported Qualities (in het Engels) om na te gaan welke individuele zorgverleners (artsen, apothekers…) of organisaties toegang hebben tot eHealthBox.


Om versleutelde berichten te versturen, moet u eerst de veiligheidsparameters configureren:

  • Klik op het tabblad 'Veiligheidscertificaten configureren';
  • De pagina 'Certificaat toevoegen‘ opent;
  • Voeg de keystore toe via de knop 'Browse';
  • Geef het wachtwoord van de keystore in;
  • Klik op de knop 'Toevoegen'.