API Historische Beschikbaarheid SEH

Introductie

De API geeft ziekenhuizen toegang tot de historische openstellingdata van (SEH-)afdelingen in een JSON-format.

Hiermee kan de openstellingdata periodiek worden opgehaald bij het LPZ en zo opgenomen worden in de interne BI/DWH-processen.

Let op! Een openstelling kan gedurende de looptijd aangepast worden, een zeer recente openstelling kan in een volgende dataset dus veranderd zijn.
Openstellingen waarbij de effectieve_eind_datum afwezig is, zijn mogelijk nog aan verandering onderhevig.

Authenticatie

De API is enkel beschikbaar voor ziekenhuizen. 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]

Request URL

De API-request bestaat uit een basis-URL en een API-methode.
Optioneel kunnen hier parameters aan worden toegevoegd om een datumbereik op te geven van maximaal één week. Wanneer er geen parameters worden meegegeven dan wordt de data van de afgelopen week teruggegeven.

https://lpz.nu/api/external/statushistory

https://lpz.nu/api/external/statushistory?from=2024-01-25&to=2024-01-31

Componenten

Parameters

Het request kan worden voorzien van twee parameters om een datumbereik te selecteren.
Het maximum bereik is vooralsnog één week. Datuminvoer wordt verwacht in ISO-8601 formaat (YYYY-MM-DD zonder tijdsaanduiding).

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

Veld	Data type	Beschrijving
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. Dit betreft de einddatum zoals deze bij het afkondigen van de stop of wijziging werd opgevoerd. De daadwerkelijke afloop datum is terug te vinden in effectieve_eind_datum.
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
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 gedefinieerde openingstijden
gebruiker	String	Gebruikersnaam van gebruiker welke de beschikbaarheid heeft gewijzigd.
effectieve_eind_datum	Date-time	Feitelijke einddatum en tijdstip van de gewijzigde beschikbaarheid. De beschikbaarheid kan handmatig worden gewijzigd of beëindigd of deze loopt automatisch af na het verstrijken van de gekozen periode. Dit maakt dat de vooraf verwachtte einddatum (en tijd) niet altijd de daadwerkelijke effectieve einddatum (en tijd) is. De feitelijke einddatum en tijdstip van de gewijzigde beschikbaarheid verwijst naar het specifieke moment waarop een bepaalde status, toestand of periode van beschikbaarheid wordt afgesloten of beëindigd. Voorbeeld: `2023-01-03T13:04:33+01:00` voor 3 Januari 2023, 13:04, 1 uur voor UTC.

Voorbeeld response

[
    {
        "start_datum": "2024-02-09T12:42:15+01:00",
        "eind_datum": "2024-02-09T14:42:16+01:00",
        "status": "dreigende_stop",
        "afdeling": "seh",
        "reden": "onv_behandelcapaciteit",
        "gebruiker": "gebruiker lpz",
        "effectieve_eind_datum": "2024-02-09T12:42:48+01:00"
    },
    {
        "start_datum": "2024-02-09T12:42:48+01:00",
        "status": "open",
        "afdeling": "seh",
        "gebruiker": "gebruiker lpz",
        "effectieve_eind_datum": "2024-02-09T12:43:37+01:00"
    }  
]

Documentatie

Documentatie voor de API is beschikbaar via /api/doc.json