HysioConnect v4.2.0

Connect Docsv4.2.0

Koppel Hysio aan jouw systeem

Hysio maakt het verslag, je dossiersysteem koppelt het aan het zorgcontact en de zorgprofessional controleert.

Direct naar de bron: OpenAPI-contract (YAML)Integratiegids (PDF)

Wie doet wat

Bij een API-koppeling werken Hysio, het dossiersysteem en de zorgprofessional samen. Wil je eerst zien wat de zorgprofessional ziet? Kies een fictieve demo: API Connect in het dossier, Browser Connect naast het dossier of Powered Connect onder eigen merk.

Hysio

Hysio maakt een Markdown-verslag van spraak of tekst en levert JSON als de werkstroom dat ondersteunt.

Bekijk de uitvoer

Jouw dossiersysteem

Je server start de sessie, bewaart de referentie en koppelt het resultaat aan het juiste zorgcontact.

Bekijk hoe je start

De zorgprofessional

De zorgprofessional leest het verslag, past het aan en bepaalt wat in het dossier komt.

Bekijk de controle

Kies je route

Twee routes zijn live in API v1 en geven hetzelfde soort resultaat; de audioroute is in voorbereiding.

Live in API v1

Gehoste sessie (Route 2A)

De zorgprofessional spreekt of typt in Hysio en je server ontvangt het resultaat via een ondertekende postback.

Bekijk de gehoste start

Live in API v1

Directe tekstverwerking (/run)

Je stuurt alle invoer als tekst vanuit je eigen interface en krijgt het verslag direct terug.

Bekijk de directe start

In voorbereiding · op aanvraag

Directe audio (Route 2B)

Je dossiersysteem neemt zelf audio op en levert die via je server aan Hysio.

Bekijk Route 2B

Gehoste sessie: stappen en voorwaarden

Je systeem start een sessie en opent de link die Hysio teruggeeft. De zorgprofessional spreekt of typt daar het gesprek in. Het resultaat komt als ondertekende postback naar je server. De aanbevolen eerste koppeling, vaak binnen dagen werkend.

  • Start: POST /workflows/{workflow}/hosted-session
  • Uitvoer: postback met Markdown en, waar ingesteld, JSON
  • Jij bouwt: een HTTPS-endpoint dat de handtekening controleert en het resultaat aan het zorgcontact koppelt

Directe tekstverwerking: stappen en voorwaarden

Je houdt de invoer in je eigen interface en stuurt de tekst voor alle werkstroomstappen in één aanvraag. Het verslag staat in de respons.

  • Start: POST /workflows/{workflow}/run
  • Uitvoer: Markdown in de respons; JSON kan nog in voorbereiding zijn
  • Jij bouwt: de invoer per werkstroomstap, time-outs en veilige herhaling

Directe audio: beschikbaarheid

Wil je in je dossiersysteem een opnameknop bouwen die audio via je server doorzet? Die route staat nog niet in het API-contract. Bespreek Route 2B tijdens de technische intake via Contact & Toegang. Wat al vastligt, lees je bij Route 2B in de API-referentie.

Vergelijk de twee live routes

Welke route past bij jouw systeem?

VraagGehoste sessieDirecte tekstverwerking
Waar ontstaat de invoer?In een tijdelijke Hysio-pagina, als spraak of tekstIn je eigen interface, als tekst
Hoe komt het resultaat terug?Postback naar je server, daarna ook op te halenDirect in de respons van dezelfde aanvraag
Wat bouw je zelf?Postback-endpoint met handtekeningcontroleInvoerscherm per stap, time-outs en herhaling
Wat bewaar je?Sessie-ID, je eigen referentie en het postbackgeheimSessie-ID en je eigen referentie
Wanneer kies je deze route?Je wilt het gesprek laten inspreken zonder eigen opname te bouwenJe hebt de tekst al in je eigen systeem

Beschikbaarheid. Beide live routes staan in het actuele API-contract. Welke werkstromen je kunt gebruiken, hangt af van je account en inrichting. Test met je eigen testaccount voordat je een koppeling in gebruik neemt.

Bouw je geen eigen koppeling? Met Hysio Browser Connect werkt de zorgprofessional naast een dossiersysteem in de browser. Wil je Hysio onder je eigen merk aanbieden, lees dan Hysio Powered Connect. Hysio voor dossiersystemen staat op hysio.nl/connect.

Een volledig eigen interface met losse stappen?

Het contract bevat ook een interactieve sessie met /start, /answers, /input, /draft en /cancel. Die route is geen aanbevolen eerste koppeling. Stem haar eerst af en test haar met jouw werkstroom. De operaties staan in de API-referentie.

Technische bronnen

Deze gids legt uit en ordent. Het contract zelf staat in de originele technische bronnen; die blijven leidend.

Gecontroleerd op 3 oktober 2026. Staging en productie publiceren hetzelfde contract, OpenAPI 3.1 versie 1.0.0. De integratiegids gebruikt in zijn voorbeelden productie-URL's; test altijd op staging. Bekijk staging en productie naast elkaar.

Demo-dossier en Playground

Bekijk een fictieve casus in het Demo-dossier of test je eigen dossierindeling in de besloten Playground.

Wat kun je in elke omgeving doen?

In het Demo-dossier zie je met een fictieve casus hoe een verslag in losse dossiervelden landt en hoe de zorgprofessional het daarna zelf opslaat. Wil je live tekst of spraak verwerken of je eigen dossierindeling testen, dan gebruik je de besloten Playground met een persoonlijke toegangscode. Geen van beide schrijft naar een echt dossiersysteem; het is geen productie-integratie.

Een toegangscode voor de Playground is geen API-key. Gebruik er alleen fictieve gegevens.

Open het Demo-dossier Playground met toegangscode

Lees de afspraken over gegevensverwerking in het TrustCentre.