For developers
Your medical record system remains the workplace. Start processing with Hysio, receive the result and have the care professional review it before adding it to the record.
Contact us directly samenwerking@hysio.nl
Let Hysio handle data entry or use your own interface. In both routes, you decide how to process the result in your medical record system.
Start a session through the API and open the Hysio link in the response. The care professional records a conversation or enters text there, then completes the session.
Keep text entry in your own interface. Send the text to Hysio and receive the result through the API.
Your medical record system maintains the link between the care professional, the care encounter and the record. Hysio supports the documentation.
Choose an available AI assistant. Store the session reference against the appropriate care encounter in your own system.
Open the hosted session or send text through the API. Hysio processes the input into a draft report.
Receive a postback at your own endpoint or retrieve the result. Match the session reference to the care encounter.
Show the draft to the care professional. Have them review the content and make any necessary changes.
Place the reviewed text in the appropriate record fields. Match your fields and mapping to the output of the selected AI assistant.
Retrieve the available AI assistants, then start a test session. Replace the example placeholders with the base URL, an available id and your API key. Also replace the fictional postback address with your own endpoint.
https://api.staging.server03.hysio.nl/api/v1The PDF also contains production examples. Use the staging address above for your test.
POST {base_url}/workflows/{workflow_id}/hosted-session
Authorization: Bearer {api_key}
Accept: application/json
Content-Type: application/json
Idempotency-Key: partner-test-voorbeeld-001
{
"postback_url": "https://dossiersysteem.example/hysio/webhook",
"collect_answers": true
}A successful request returns HTTP 201, including session_id, redirect_url and postback_secret. Open redirect_url unchanged, including its fragment, to use the hosted session.
{
"session_id": 1841,
"idempotency_key": "partner-test-voorbeeld-001",
"status": "completed",
"output": "## Subjective\nFictional example text from the conversation.",
"output_json": {
"subjectief": "Fictional example text from the conversation."
},
"output_json_status": "ready"
}Shortened, fictional webhook example. The fields inside output_json depend on the selected AI assistant. A completed session does not necessarily mean structured JSON is available.
Call GET /workflows with your API key. Use the id of the selected AI assistant as workflow_id in the example; access is associated with your account.
Verify X-Hysio-Signature: sha256= followed by the HMAC-SHA256 of the unchanged request body using the returned postback_secret. Reject an invalid signature. Keep this secret on your server.
Check output_json_status before processing JSON. A pending status means conversion is not complete. A not_configured status means JSON output has not been configured. Also handle processing errors.
Reuse the same Idempotency-Key when resending the same session creation request. Use a new value for a new session.
Hysio Playground
See how a session starts and the result returns in a fictional medical record system. Explore how it works before building an integration yourself.
Open the playground with an access code. If you do not have one yet, request test access below. An access code is not an API key.
Use fictional data only. The playground is a test environment and does not write to a real medical record system.
To test independently, use a Hysio test account and your own API key. We will arrange access with you.
Tell us which medical record system you develop for and what you would like to test. We will help you get the appropriate access and documentation.
Contact us to arrange test access. We will help you get a test account and the appropriate API access. The API key needs the workflows:read, sessions:create and sessions:read permissions.
Use the staging URL, retrieve the available AI assistants and complete a session. Check error responses and how the result is delivered too.
An API key acts on behalf of your Hysio account. The complete key is shown only when you create it. Keep the key on your server and out of frontend code, logs and public examples.
Share your technical question or request playground access. We will help you explore the route that fits your medical record system.
Prefer to email us directly?
samenwerking@hysio.nl
Would you like to know what is possible for your practice? Tell us which medical record system you use so we can discuss the current options.
Contact us