HysioConnect v4.2.0

Connect Docsv4.2.0

Koppel Hysio aan jouw systeem.

Hysio verwerkt een gesprek tot een verslag. Jouw systeem koppelt het aan het juiste zorgcontact en de zorgprofessional controleert.

Begin met de QuickstartSwagger API-referentie

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

Wie doet wat

Een koppeling met Hysio verdeelt het werk over drie partijen. Die verdeling blijft in elke route gelijk.

1

Hysio verwerkt

Hysio maakt van spraak of tekst een verslag met de gekozen werkstroom. Het resultaat is Markdown, plus JSON als die voor de werkstroom is ingesteld.

2

Jouw systeem koppelt

Je start de sessie vanaf je server, bewaart de sessiereferentie en zet het resultaat bij het juiste zorgcontact.

3

De zorgprofessional controleert

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

Kies je route

Versie 1 van de API kent twee live routes voor een eerste koppeling. Ze leveren hetzelfde soort resultaat; het verschil zit in waar de invoer ontstaat. Een derde route, met audio rechtstreeks vanaf jouw server, is in voorbereiding.

Live in API v1

Gehoste sessie (Route 2A)

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

Bekijk de gehoste start

Live in API v1

Directe tekstverwerking (/run)

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

Bekijk de directe start

In voorbereiding · op aanvraag

Direct server-to-server met audio (Route 2B)

Wil jouw EPD een eigen opnameknop in het eigen scherm bouwen en audio direct vanaf je server doorzetten? 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.

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.

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.

Begin hierAPI-referentie Alle operaties met schema's, parameters, voorbeelden en foutresponsen.Interactieve HTML-referentieMachineleesbaarOpenAPI-contract Het volledige contract, om te controleren of een client te genereren.YAML, OpenAPI 3.1, versie 1.0.0HandleidingIntegratiegids Technische uitleg van de eerste aanroep tot het resultaat. Let op: de voorbeelden gebruiken productie-URL's.PDF, 10 pagina'sPraktische startKoppelingsgids Eén pagina: staging openen, een beperkte API-key maken, de sleutel veilig bewaren en testen.PDF, 1 pagina, via de Playground

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.

Ervaar het eerst in de Demo-EPD en de Playground

Hysio Demo-EPD en Playground

In de Demo-EPD 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 de Demo-EPD Playground met toegangscode

Lees de afspraken over gegevensverwerking in het TrustCentre.