De API geeft Regionale Ambulancevoorzieningen (RAV) en Meldkamers (MKA) toegang tot de huidige openstellingdata van (SEH-)afdelingen in een JSON-format.
Op de acceptatieomgeving een tweetal test ziekenhuizen welke, voor testdoeleinden, met hoge regelmaat stops aankondigen. |
De API is enkel beschikbaar voor RAV’s/MKA’s. Een organisatiebeheerder van deze organisaties kan en API-account aanmaken via het Gebruikersbeheer.
Vervolgens kan er via het Gebruikersbeheer een token worden aangevraagd door de organisatiebeheerder. Dit kan gedaan worden door op het sleutel-icoon achter het API account te klikken.
Er wordt een token gegenereerd die 30 seconden zichtbaar is. Kopieer deze dmv het kopieer-icoon.
De combinatie API-account en de gegenereerde token zijn de Key-values die nodig zijn om de openstelling-status op te halen van de request URL.
Key | X-AUTH-TOKEN |
Value | [api-user]:[token] |
Via het API-account, dat ook wordt gebruikt voor het aanleveren van capaciteits- en procesgegevens, kan een GET-request worden verstuurd om de interne status van de SEH en andere afdelingen op te halen.
Let op: Dit betreft de actuele status van de SEH en andere afdelingen. |
De API-request bestaat uit een basis-URL en een API-methode. Het is mogelijk om een HTTPS-verzoek te doen naar onze API.
Request-URL voor RAV en MKA:
https://www.lpz.nu/api/external/organization/status
Request-URL voor ziekenhuizen:
https://www.lpz.nu/api/external/status
Veld | Data type | Beschrijving | |
oid | String | Locatie-specifiek LPZ-OID. Zie Locatie-specifieke LPZ object identifier .
| |
locatie | String | Locatie (display) naam | |
beschikbaarheid | Array | Beschikbaarheid van (Spoedeisende Hulp) afdelingen. |
Veld | Data type | Beschrijving |
status [verplicht] | String | Actuele beschikbaarheid van de (SEH-)afdeling.
|
afdeling [verplicht] | String | Identificeert een (Spoedeisende Hulp) afdeling.
|
start_datum [verplicht] | Date-time | Startdatum en tijdstip van de gewijzigde beschikbaarheid van de afdeling, in UTC (ISO 8601) formaat. Voorbeeld: |
eind_datum | Date-time | Einddatum en tijdstip van de gewijzigde beschikbaarheid van de afdeling, in UTC (ISO 8601) formaat. Wordt verstrekt bij een beschikbaarheid met status anders dan Voorbeeld: |
wijziging_datum [verplicht] | Date-time | Datum en tijdstip waarop de beschikbaarheid van de afdeling voor het laatst is bijgewerkt, in UTC (ISO 8601) formaat. Voorbeeld: . |
Voorbeeld response
{ "oid": "123.123.456", "locatie":"Testziekenhuis locatie A", "beschikbaarheid": [{ "status": "open", "afdeling": "seh", "start_datum": "2023-06-19T19:43:44+01:00", "wijziging_datum": "2023-06-19T19:43:44+01:00" }, { "status": "gesloten", "afdeling": "ccu", "start_datum": "2023-06-24T10:50:18+01:00", "eind_datum": "2023-06-24T12:51:41+01:00", "wijziging_datum": "2023-06-24T10:50:44+01:00" } ] } |
Voor individuele organisaties is ook de Reden beschikbaar:
Veld | Data type | Beschrijving |
---|---|---|
Reden | String | Specificeert de reden van de gewijzigde beschikbaarheid. Wordt verstrekt bij een beschikbaarheid met status anders dan `
|
Voorbeeld response
{ "oid": "123.123.456", "locatie":"Testziekenhuis locatie A", "beschikbaarheid": [{ "status": "volledige_stop", "reden": "stagnatie_uitstroom", "afdeling": "seh", "start_datum": "2023-06-24T10:50:18+01:00", "eind_datum": "2023-06-24T12:51:41+01:00", "wijziging_datum": "2023-06-24T10:50:44+01:00" } ] } |
Documentatie voor de API is beschikbaar via /api/doc.json
en hieronder als download.