Categorieën bekijken

nCare API: Ontsluit data uit nCare

5 min leestijd

Inhoudsopgave

Met onze nieuwe API kun je eenvoudig data ontsluiten en integreren met jouw favoriete BI-oplossingen. De API biedt uitgebreide mogelijkheden om data te analyseren en visualiseren, zodat er binnen jouw organisatie meer inzicht ontstaat in het medicatieproces. Dit draagt bij aan het verbeteren van de medicatieveiligheid binnen de zorg.

Wil je deze functionaliteit gebruiken?
Log in op het klantportaal en doe een Servicemanagement-aanvraag om de API-functionaliteit aan te vragen. Via die route geef je akkoord om de data te ontsluiten. Je ontvangt dan meer informatie over de kosten.

Authenticatie #

De koppeling werkt via OAuth 2.0. We maken een unieke client ID en client secret aan voor jullie organisatie. De sessie token kan o.b.v. de verstrekte gegevens worden opgehaald via login.ncare.nl (https://login.ncare.nl/.well-known/openid-configuration).
Let op: het aansluiten van het BI-systeem op het endpoint is de verantwoordelijkheid van de organisatie of de IT-beheerder. Wij leveren de benodigde gegevens aan, maar bieden geen ondersteuning op de inrichting van BI-tools of de authenticatie-instellingen. Controleer dus vooraf goed of jullie BI-systeem met deze authenticatiemethode overweg kan.

Heb je hierbij extra ondersteuning nodig? Geef dit dan aan in de Servicemanagement-aanvraag. Onze partner Esculine, die deze koppeling samen met ons heeft ontwikkeld, kan ondersteunen bij de inrichting en technische implementatie.

Limieten #

Om de performance van nCare tijdens piekmomenten te waarborgen, is het API-endpoint niet beschikbaar tijdens de volgende tijdvakken:

  • 07:00 – 10:00 uur

  • 16:00 – 18:30 uur

Bevragingen binnen deze tijdvakken worden geblokkeerd. Zorg ervoor dat het BI-systeem alleen buiten deze tijden data opvraagt.

Mapping FHIR #

Hieronder wordt de mapping beschreven van de database tabellen van nCare naar het FHIR endpoint MedicationAdministration.

1= onbekend
2= baxter
3= los
4 = zonodig

nCare

MedicationAdministration

Toediening.id

id

td.EchteTijdToediening

AdministeredOn

td.GeplandeToediening

AgreedDateTime

td.ControleUitgevoerd

DoubleCheckPerformed

td.Commentaar (geen dc uitgevoerd omdat:

DoubleCheckComment

td.ControleType

DoubleCheckType

td.Klaargezet

IsPrepared

td.ArtikelAdministered

MedicationReference

td.Tehuispatient

subject

verblijfplaats client

Context

td.EchteTijdToediening of KlaargezetteTijdToediening

EffectiveDateTime

td.Toediener

Performer/actor

td.Commentaar

Note

td.Geplande Hoeveelheid

Dosage-plannedamount

td. Echte hoeveelheid

Dose

toedienmedicatie.Verstrekkingstype

ext-MedicationAdministration2-DispensingType

IsVerouderd

IsObsolete

IsVervangen

IsReplaced

Reden van Afwijken

Administration-Divergent-Reasons

KlaargezetteTijdToediening

PreparedOn

Query mogelijkheden #

Hieronder vind je een overzicht van de benodigde includes om alle benodigde informatie te ontvangen.
{{ServerUrl}}/MedicationAdministration
  • _include=MedicationAdministration:medication
  • _include=MedicationAdministration:patient
  • _include=MedicationAdministration:performer
  • _include=MedicationAdministration:context

            • In de encounter zitten een OrganizationalUnit, dit is de locatie. De OrgnizationalSubunit is de afdeling.

Incrementeel ophalen toedieningen #

Er is geen mogelijkheid om incrementeel toedieningen op te halen. Toedieningen kunnen alleen op dezelfde dag worden aangepast. Het is mogelijk om op agreedDateTime de toedieningen op te halen:
  • MedicationAdministration?agreedDateTime=geyyyy-mm-dd
    • Bij start alle toedieningen van de afgelopen 2 jaar ophalen
    • Iedere nacht (na 00:00 uur) de toedieningen van de vorige dag ophalen

Overzichten mogelijk in BI-tool #

Hieronder volgt een opsomming van de overzichten die gemaakt kunnen worden in een BI-tool. Eerst wordt beschreven wat het overzicht toont. Daaronder vind je de selectie van de toedieningen die nodig is om tot het overzicht te komen.
In alle gevallen geldt:
  • Via Context/encounter kan er een selectie gemaakt worden per afdeling waarop de toediening is gedaan
  • Via Subject kan er een selectie gemaakt worden per cliënt
  • Via Performer kan een selectie gemaakt worden per medewerker
  • IsReplaced = False  (Alles met true negeren)

Overzicht wel/niet/afwijkend toegediend/klaargezet etc #

Gegevens zichtbaar in overzichten
  • Overzicht van totaal aantallen/percentages per onderdeel van totale zorginstelling
  • Overzicht verder uitsplitsen naar aantallen/percentages per locatie/afdeling
  • Op afdelingsniveau doorklikken naar welke cliënten dit betreft
  • Overzicht per medewerker
Benodigde toedieningen:
  • Hoeveelheid afgetekend volgens planning:
    • Dose = Dosage-planned
    • AdministerdOn is not Null (is aanwezig in MedicationAdministration)
  • Medicatie afgetekend met meer dan de geplande hoeveelheid:
    • Dose> Dosage-planned
    • EffectiveDateTime is not Null (is aanwezig in MedicationAdministration)
  • Medicatie afgetekend met minder dan de geplande hoeveelheid:
    • Dose < Dosage-planned
    • Dose !=0
    • EffectiveDateTime is not Null (is aanwezig in MedicationAdministration)
  • Hoeveelheid klaargezette medicatie:
    • IsPrepared = true
    • EffectiveDateTime is Null  (is afwezig in MedicationAdministration)
      • Bij alsnog toedienen wordt klaarzetten overschreven
  • Niet afgetekende medicatie zonder opgaaf van reden:
    • EffectiveDateTime is Null (is afwezig in MedicationAdministration)
    • IsObsolete = false
    • AgreedDateTime < datum opvragen nCare
    • IsPrepared = false
    • IsPatientResponsibilit = false
    • HandedOver = false
  • Medicatie afgetekend met een hoeveelheid van 0 met opgaaf van reden:
    • EffectiveDateTime is not Null (is aanwezig in MedicationAdministration)
    • Dose = 0
    • Administration-Divergent-Reasons
  • Medicatie afgetekend zonder geplande hoeveelheid:
    • EffectiveDateTime is not Null (is aanwezig in MedicationAdministration)
    • Dose != 0
    • Dosage-planned = 0
  • Klaargezette medicatie:
    • PreparedOn is not NULL
    • Prepared = true
  • Eigen Beheer:
    • IsPatientResponsibility = true
    • IsObsolete = false
    • IsReplaced = false
  • Aangereikt:
    • IsHandedOver = true
    • IsObsolete= false
    • IsReplaced = false
  • Totaal van alle toedieningen:
    • (IsObsolete = true EN EffectiveDateTime is not Null) OR IsObsolete = false
    • IsReplaced = false
    • AgreedDateTime < datum opvragen nCare

Overzicht DubbelControle #

Gegevens zichtbaar in overzichten:
  • Overzicht van totaal aantallen/percentages per onderdeel van totale zorginstelling
  • Overzicht verder uitsplitsen naar aantallen/percentages per locatie/afdeling
  • Op afdelingsniveau doorklikken naar welke cliënten dit betreft
  • Bij Niet uitgevoerd (9):
    • Niet uitgevoerd ook een overzicht geven van de redenen van niet controleren
      • DoubleCheckComment ‘geen dubbele controle uitgevoerd omdat: ……’
        • Alleen de tekst op de puntjes is anders, de rest is standaard. Bij enkel vrije tekst, gaat het om commentaar van de controleur.
    • Overzicht per medewerker van niet uitgevoerde dubbelcontrole.
Benodigde toedieningen:
  • Double-Check-Types
    • 0: niet vereist
    • 1 : Op huidige locatie door gebruiker
    • 2: Door niet gebruiker
    • 3: Op andere locatie door gebruiker
    • 4: Extern systeem
    • 5: Zorgcentrale
    • 6: Klaargezet
    • 9: Niet uitgevoerd

Overzicht in GDS (Geneesmiddeldistributiesysteem) #

Gegevens zichtbaar in overzichten:
  • Overzicht van medicatie die wel en niet in de GDS zat
    • Los en zonodig zit beide niet in GDS –> wel onderscheid maken tussen los en zonodig.
    • Overzicht verder uitsplitsen naar aantallen/percentages per locatie/afdeling
Benodigde toedieningen:
  • dispensingType
    • 1: onbekend
    • 2: GDS (Baxter/in zakje)
    • 3: Los
    • 4: Zonodig