eHealth platform services connectors

Alles over deze dienst

De “eHealth platform services connectors” zijn lokale (en lichte) bibliotheken met de bedoeling om de ontwikkelaars van software voor individuele zorgverleners en apotheken te helpen bij de integratie van de basisdiensten van het eHealth-platform die worden aangeboden via “web service”-interfaces. Deze bibliotheken dienen meer algemeen eveneens ter ondersteuning van de verbindingen met de diensten met toegevoegde waarde die via het eHealth-platform beschikbaar zijn of die gebruik maken van de ICT-standaarden die door het eHealth platform werden vastgesteld (zoals de "hubs" bijvoorbeeld). De ontwikkeling van deze bibliotheken kadert dus in de standaardisering en de ondersteuning bij het gebruik van de basisdiensten van het eHealth-platform.

Deze connectoren zijn opgebouwd uit twee "lagen".

  • De eerste laag of “technische connector” biedt een algemene API ter ondersteuning van het gebruik van louter technische basisdiensten (hoofdzakelijk in het domein van de beveiliging: authenticatie, vercijfering, …)
  • De tweede laag of “businessconnector” maakt gebruik van de technische connector om de verbinding met een reeks diensten voor een bepaalde doelgroep binnen éénzelfde sessie te vergemakkelijken.

De connectoren zijn uiteraard afhankelijk van de interfaces van de diensten die zij integreren. De updates van de connectoren ingevolge de wijzigingen aan deze interfaces worden in de mate van het mogelijke ter beschikking gesteld via deze webpagina..

Deze connectoren zijn beschikbaar in JAVA en .NET, maar worden uitsluitend ontwikkeld in JAVA. De .NET-code is dus geen ‘native code’. Deze connectoren worden gegenereerd aan de hand van een versie van de tool  IKVM ( wcag.label.externalLink)  die licht werd aangepast aan onze behoeften. Als u van plan bent om vanuit dezelfde filosofie uw eigen library’s te ontwikkelen op basis van de onze, raden we u aan om diezelfde versie van de tool te gebruiken en de richtlijnen voor de integratie ervan na te leven.
De connectoren zijn bibliotheken die verdeeld worden onder vrije licentie. Ze zijn beschikbaar voor iedereen die ze wil gebruiken. Voor ondersteuning bij het gebruik van deze bibliotheken dient er op voorhand een aanvraag te worden ingediend bij het eHealth-platform via het e-mailadres info@ehealth.fgov.be ( wcag.label.externalLink) (met als onderwerp "eHealth platform service connectors").

Wijziging van september 2023 ten opzichte van de vorige versies

De volgende functionaliteiten werden gewijzigd op de business-connector :

Release 4.4.0

BUSINESSCONNECTOR

  • Business-connector MyCareNet / ChapterIV: de validatie van de timestamp is nu compatibel met Timestamping V2. De timestamp wordt eerst gevalideerd ten opzichte van Timestamping V1 en vervolgens, indien dit mislukt, wordt de timestamp gevalideerd ten opzichte van Timestamping V2. Dit heeft een impact op de interface van de connector:

    • De volgende methode: public TimeStampResponse getTimeStampResponse()
    • werd vervangen door deze: public TimeStampToken getTimeStampToken()  
  • Business-connector intrahub V3: er werden twee configuratieparameters toegevoegd om oproepen met een CBE-auteur toe te laten:

    • hubv3.session.is-cbe :
      heeft default de waarde « false ». De waarde moet true zijn als de sessie een STS-token met een CBE-nummer heeft.
    • hubv3.request.create-author :
      heeft default de waarde « true ». De waarde veranderen in false laat toe om zelf de auteur toe te voegen (be.fgov.ehealth.standards.kmehr.schema.v1.AuthorType) aan de request (be.fgov.ehealth.hubservices.core.v1.RequestType). Deze optie moet worden gebuikt indien de connector er niet in slaagt de auteur correct te genereren voor een doelgroep die niet voorzien is door de connector (bv. een organisatie).

Op analoge wijze kunnen voor de business-connector intrahub (V1) de configuratieparameters hub.session.is-cbe et hub.request.create-author worden gebruikt.

TECHNISCHE CONNECTOR

  • Update van de eID software-library’s om toegang te kunnen krijgen tot alle types identiteitskaarten, in het bijzonder voor « Foreigner A », « Foreigner K » en « Foreigner L » .

Opmerking : deze versie 4.4.0 kan worden beschouwd als een experimentele release voor de .NET-gebruikers, ze wordt geacht de performantie te verbeteren ten opzichte van de vorige 4.x-versies. Voor de productie-omgeving en om performantieredenen is het echter nog steeds aanbevolen om voor de .NET-applicaties gebruik te maken van de versies 3.x van de connector. De functionaliteiten van de voormelde versie 4.x werden toegepast op de versie 3.25.0 van de business-connector & technische connector.

Diensten die gedekt worden op het niveau van de “business”-lagen

Compatibiliteit van de technische connector

  • De compatibiliteit van de technische connector versie 4.4.0 met de Recip-e-connectoren is gevalideerd.

Download

De java-connectoren en een archief-bestand met de “.net”-connectoren zijn beschikbaar via een maven repository ( wcag.label.externalLink) . De volgende lijst bevat links naar de business connectoren van de diverse beroepsgroepen en de technische connector.

Connector v4: Inleidende gids

Dit is een technisch overzicht over het gebruik van de eHealth connector (versie 4). Het doel is om een ontwikkelaar van een softwareapplicatie voor eindgebruikers te begeleiden bij het gebruik, de configuratie, de uitbreiding en de integratie van zijn applicatie met de eHealth-connector.

Versie 1.9 (13/10/2021) - 1.39 MB Bestand PDF (Dit document is in het Engels)

Nieuwe connector “Release 4.3.0” is beschikbaar

Alle informatie over de wijzigingen in de functionaliteiten vindt u via deze link.

De “API portal” 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.

 

U vindt de laatste versie van de .jks-bestanden telkens in de nieuwste connectorversie die u via de Maven-repository kan downloaden. Raadpleeg een voorbeeld in de Index of maven2. De .jks bestanden zitten in de map ‘config/P12’.

U vindt de verschillende keystores ook bij het onderdeel ‘Keystore’ onder eHealth-certificaten.
 

U vindt voorbeeldcodes in de generische connector van de repository. Ze bevat voorbeelden voor zowel java als net. Download het package, en bekijk de voorbeelden in het mapje ‘examples’.

De connector vindt u in de Index of maven2.
 

Vanaf oktober 2023 is de minimaal ondersteunde versie 4.1.2.
Gelieve over te schakelen naar een nieuwe versie mocht dit nog niet het geval zijn.

Voorlopig wordt alleen Java 1.8 volledig ondersteund. Recentere versies van Java zullen minstens verschillende klassen missen die in JRE 1.8 zijn opgenomen.
Het is de bedoeling dat in de toekomst ten minste Java 11 wordt ondersteund, maar de planning staat nog niet vast.

Sinds oktober 2023 is het gebruik van SHA256 verplicht. De minimaal ondersteunde connectorversie is 4.1.2.
De nodige aanpassingen zijn afhankelijk van de gebruikte connectorversie.

Versie 4.1.2 en versie 4.2.x

Volgende eigenschappen dienen aangepast/toegevoegd te worden:

Versie 4.3.x

Deze versie maakt standaard gebruik van SHA256.

Voor alle versies

Indien u gebruik maakt van de IntraHub Services dient volgende eigenschap toegevoegd te worden: intrahubv3.sha1feature.enabled=false

Meer informatie over de werking kan u vinden op de pagina Beveiliging van webservices van deze website.
 

De STS service Saml11TokenService wordt sinds oktober 2023 niet meer gebruikt.

U kan volgende eigenschap toevoegen om naar de nieuwe SecurityTokenService over te schakelen: endpoint.sts=$uddi{uddi:ehealth-fgov-be:business:iamsecuritytokenservice:v1}

of afhankelijk van de omgeving:

  • endpoint.sts=https://services-acpt.ehealth.fgov.be/IAM/SecurityTokenService/v1;
  • endpoint.sts=https://services.ehealth.fgov.be/IAM/SecurityTokenService/v1.

Meer informatie over de werking kan u vinden op de pagina’s Beveiliging van webservices en Identity & Access Management van deze website.
 

Een mogelijke oorzaak is een verouderde waarde bij de eigenschap 'endpoint.sts', bijvoorbeeld:

  • endpoint.sts=$uddi{uddi:ehealth-fgov-be:business:iamsaml11tokenservice:v1}, of
  • endpoint.sts=https://services-acpt.ehealth.fgov.be/IAM/Saml11TokenService/v1.

Zie FAQ 'Hoe pas ik de connector aan naar de nieuwe SecurityTokenService?' voor de juiste waarde.
 

U kan de headers 'User-Agent' en 'From' configureren a.d.h.v. volgende connectoreigenschappen:

  • be.ehealth.technicalconnector.handler.mimeheaders.user-agent.prefix=<content>;
  • be.ehealth.technicalconnector.handler.mime-headers.from.value=<emergency email adress>.

Hou er rekening mee dat vanaf connectorversie 4.3.x deze verplicht zijn.

Meer uitleg over de verwachte waarde is te vinden in de webservice cookbooks (bijvoorbeeld in Consent Cookbook punt 5.1.4).