Hop til hovedindhold

Instrument Integrations API

Note

This API is used exclusively for integrations from instrument vendors, such as ECG and spirometry.

Vena's instrument integrations API enables instrument vendors to build integrations that send measurement results into Vena. It is also possible to fetch a list of patients with appointments within a given time range, so they can be shown in the instrument software and the clinician can easily perform a measurement on the correct patient.

Contact Vena for more information.

Base URL:

  • Production: https://api.vena.dk
  • Demo/Test: https://api.venademo.dk

Authentication​

POST /api/v1/integrationAuth​

Authenticate with your client credentials to obtain an access token.

Request​

POST /api/v1/integrationAuth
Content-Type: application/json

{
  "clientID": "string",
  "clientSecret": "string"
}

Response​

{
  "data": {
    "accessToken": "string"
  }
}

Notes​

  • accessToken is valid for 10 minutes
  • The token must be included in all subsequent requests via the header: Authorization: <accessToken>

Fetch patients and appointments​

GET /api/v1/instrumentPatients​

Returns patients with appointments within a given time interval.

Query parameters​

NameTypeRequiredDescription
fromISO8601 datetime✅Start of interval
toISO8601 datetime✅End of interval

Example​

GET /api/v1/instrumentPatients?from=2025-01-01T00:00:00Z&to=2025-08-01T23:59:59Z
Authorization: <accessToken>

Response​

{
  "data": [
    {
      "patientID": "uuid",
      "appointmentStart": "2025-06-30T07:00:00.000Z",
      "calendarName": "string",
      "employeeName": "string",
      "appointmentTypeName": "Consultation",
      "cpr": "string",
      "firstName": "string",
      "lastName": "string",
      "birthdate": "YYYY-MM-DD",
      "gender": "string"
    }
  ]
}

Submit measurement results​

To submit measurement results, use the following API endpoint.

A list of measurement results can be submitted, for example with NPU codes and their values.

Files can also be attached - these must be base64 encoded.

POST /api/v1/instrumentResults​

Submit measurements for a patient.

Request​

POST /api/v1/instrumentResults
Content-Type: application/json
Authorization: <accessToken>

{
  "patientID": "uuid",
  "measurementType": "string",
  "measuredAt": "ISO8601 datetime",
  "results": [
    {
      "code": "string",
      "value": "string"
    }
  ],
  "files": [
    {
      "filename": "string",
      "data": "base64"
    }
  ]
}