Two API calls.
TMP Portal, live in your EHR.

As an EHR system you enable your hospital customers to use TMP by implementing two straightforward API calls and a result webhook. Your hospitals bring their own TMP credentials; you build the integration once and every hospital on your platform benefits.

How the API integration works

If your EHR supports outbound API calls, this is the recommended integration path. It involves two calls to obtain a session and display TMP Portal, plus a webhook endpoint on your side to receive results.

01

Get test credentials

TMP credentials belong to the hospital or practice using the EHR, not to the EHR system itself. Each hospital configures their own client_id and client_secret in your EHR.

As an EHR system building the integration, you can request a set of HCP test credentials from TMP to use during development and testing. Reach out to support@transmuralplatform.eu.

02

Fetch a Bearer token via POST /auth

Before starting a session, authenticate using the credentials of the hospital or practice currently active in the EHR. The token is valid for one hour and covers all TMP API calls made within that window.

Field Details
Endpoint POST /auth
Auth HTTP Basic, base64-encoded client_id:client_secret of the hospital or practice
Response A Bearer token valid for 1 hour; include it as Authorization: Bearer <token> on all subsequent calls
03

Start a session via POST /request

When a clinician wants to start a telemonitoring session for a patient, call POST /request with the Bearer token in the Authorization header and the patient context in the request body.

Body field Description Required
patientId Your internal patient identifier. TMP stores this and returns it on every result so you can link the data back to the correct patient. Yes
Additional patient fields Name, date of birth, national number, language, and other contextual fields can be passed to pre-fill TMP Portal and enrich the session for the provider. Optional

The response contains two fields your EHR must store and use:

Response field What to do with it
telemonitoringId The unique identifier for this session. Store it against the patient record; TMP includes it in every result delivery so you can match incoming data to the right patient.
url The URL to TMP Portal for this session. Open or embed this URL in your EHR so the clinician can select the monitoring provider they want to work with.
04

Implement the result webhook

When a monitoring provider posts results to TMP, TMP forwards them to a webhook URL you configure per hospital. The payload contains the telemonitoringId (so you can identify the patient), the session status, and the result attachments.

📄

PDF report

A signed URI pointing to the session summary. Your EHR fetches the PDF and stores it in the patient record.

🧬

Structured data

Machine-readable observation data for care paths that support it, allowing your EHR to parse and display the results natively.

📊

Dashboard link

A provider-managed URI your EHR can embed or open inline for a live view of the patient's monitoring data.

The full webhook specification is available in the OpenAPI documentation ↗.

05

Test and go live

Use the HCP test credentials to run the full flow end-to-end: fetch a token, call POST /request, open the returned portal URL, and confirm that a simulated result reaches your webhook. Once validated, each hospital configures their own credentials and the integration is immediately live for their clinicians.

Optional capabilities

Beyond the core launch and result flow, TMP supports additional integration patterns for EHR systems that want to go further.

🏥

Virtual wards

TMP can integrate with virtual ward systems. Patient context is shared when a telemonitoring session is accepted, and monitoring data is shared back into the ward when TMP receives the session outcome from the provider.

🗂️

Domains and provider grouping

Providers can be grouped into domains so clinicians only see the subset of providers relevant to their specialty or department. This keeps the TMP Portal experience focused and reduces noise at rollout.

Alternative launch methods

If your EHR uses an external application launch mechanism (such as an app store or an embedded browser flow), TMP can adapt to your platform. Reach out and TMP will work with you to find the right integration pattern.

Ready to integrate your EHR with TMP?

Request HCP test credentials and get started. We will guide you through the API flow and answer any questions about your specific EHR platform.