API Actuele Beschikbaarheid SEH

Introductie

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.
Zie Test-fase API.

Authenticatie

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]

Authenticatie voor individuele organisaties

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.

Request URL

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

Componenten

Schema: Organisaties

Veld	Data type	Beschrijving
oid	String	Locatie-specifiek LPZ-OID. Zie Locatie-specifieke LPZ object identifier . Eerder werd gekeken naar het gebruik van HL7 OID, helaas is de inrichting hiervan nog niet robuust genoeg voor deze koppeling.
locatie	String	Locatie (display) naam
beschikbaarheid	Array	Beschikbaarheid van (Spoedeisende Hulp) afdelingen.

Schema: Beschikbaarheid - Beschikbaarheid van een (Spoedeisende Hulp) afdeling.

Veld	Data type	Beschrijving
status [verplicht]	String	Actuele beschikbaarheid van de (SEH-)afdeling. `open` - De (SEH-)afdeling is open. Er is geen capaciteitsprobleem op de (SEH-)afdeling. `dreigende_stop` - De SEH is open, maar er dreigt een presentatiestop voor de SEH vanwege een capaciteitsprobleem op de SEH-afdeling. `volledige_stop` - De (SEH-)afdeling moet worden ontzien conform geldende regionale werkafspraken vanwege een capaciteitsprobleem op de (SEH-)afdeling. `gesloten` - De SEH-afdeling is gesloten, vanwege een calamiteit zoals ICT-uitval of brand. `onbekend` - De status van de (SEH)-afdeling is onbekend.
afdeling [verplicht]	String	Identificeert een (Spoedeisende Hulp) afdeling. `seh` - Spoedeisende Hulp afdeling `ccu` - Cardiac Care Unit `cttr` - CT Trombolyse `shock` - Traumakamer / Shockroom `seh_kind` - Kinder Spoedeisende Hulp afdeling `pci` - Percutane Coronaire Interventie `verlos` - Verloskunde afdeling (NB, deze afdeling wordt niet getoond op het spoeddashboard maar enkel op het geboortezorg dashboard. `ic` - Intensive Care `ehh` - Eerste Hart Hulp `ehlh` - Eerste Hart Long Hulp
start_datum [verplicht]	Date-time	Startdatum en tijdstip van de gewijzigde beschikbaarheid van de afdeling, in UTC (ISO 8601) formaat. Voorbeeld: `2023-01-03T13:04:33+01:00` voor 3 Januari 2023, 13:04, 1 uur voor UTC.
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 `open`. Voorbeeld: `2023-01-03T14:04:33+01:00` voor 3 Januari 2023, 14:04, 1 uur voor UTC.
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: `2023-01-03T13:04:33+01:00` voor 3 Januari 2023, 13:04, 1 uur voor UTC. .

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

Veld

Data type

Beschrijving

Reden

String

Specificeert de reden van de gewijzigde beschikbaarheid. Wordt verstrekt bij een beschikbaarheid met status anders dan `open`.

piek_aanbod - Een piek in het totale aantal patiënten vraagt dermate veel personele capaciteit dat er geen optimale zorg voor nieuwe patiënten gegarandeerd kan worden.
piek_zorgzwaarte - Een piek in het aanbod van patiënten met een hoge zorgzwaarte vraagt dermate veel personele capaciteit dat er geen optimale zorg voor nieuwe patiënten gegarandeerd kan worden.\n
onv_behandelcapaciteit - Door onvoldoende capaciteit (behandelplekken/kamers/apparatuur) kan benodigde zorg niet geleverd worden.
stagnatie_uitstroom - De doorstroom van patiënten naar afdelingen/ketenpartners stagneert.
interne_calamiteit - Een incident/technisch probleem waardoor het ziekenhuis tijdelijk niet in staat is de gevraagde zorg te verlenen.
rooster - De afdeling is gesloten volgens een dienstrooster.
scheduled - De afdeling is gesloten volgens de gedefiniëerde openingstijden

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

Documentatie voor de API is beschikbaar via /api/doc.json en hieronder als download.