Från underlag till godkänd plan
Varje steg har ett tydligt ansvar. Att ta emot underlag är inte samma sak som att publicera en plan eller tillämpa den i ett annat system.
Källdata
Planeringsunderlag från ett anslutet system eller en stödd fil.
Connect
Kontroll av källa, enhet och tillåtet datautbyte.
Granska och acceptera
Behörig användare granskar underlaget innan det används.
Planera och optimera
CAIRE skapar och jämför förslag inom verksamhetens ramar.
Godkänn och publicera
Planeraren väljer vilken plan som får användas.
Hämta och kvittera
En behörig partner kan läsa planen och lämna ett tillämpningskvitto.
Publiceringen startar den operativa dagen
Planeraren publicerar först den valda besöksplanen. Sjukfrånvaro, avbokningar, förseningar och utförande påverkar sedan den aktuella operativa planen. Godkända bemanningsändringar och tillåten justering av tider eller ordning skapar en ny revision med basversion och kvitto.
Ändringarna håller sig inom tillåtna tidsfönster och skyddar utfört arbete och medarbetarens nästa besök. Ändringar utanför gränserna går till planeraren. Ett beräknat alternativ tillämpas genom den aktuella planens revisionsregler; berörda anslutna appar får den uppdaterade rutten i realtid.
Klienten kan begära avbokning i appen när funktionen är aktiverad. Kontakta kontoret för annan tid eller ett framtida uppehåll vid exempelvis resa eller sjukhusvistelse. Medarbetare kan lämna frånvaro- och bemanningsönskemål i sin app. Telefon, SMS och e-post följer verksamhetens kontaktvägar; behörig personal registrerar den relevanta planeringsändringen i CAIRE. Framtida klientuppehåll är daterade källändringar för utkastveckor och hör till nattens uppdateringsflöde. Realtidsrevisioner gäller separat för den publicerade aktuella planen.
Se datalagren, publiceringen och optimeringsflödetVad använder ni CAIRE Connect till?
CAIRE Connect (beta) kopplar CAIRE till era andra system. Ett anslutet system kan läsa enheter, brukare, personal, besök och publicerade planer, läsa analyser och skicka begäranden som en planerare sedan beslutar om. Ni bestämmer vilka enheter och vilka uppgifter varje koppling får nå.
En partnerbegäran ändrar inte i sig planen. Planeraren granskar avbokningar och önskemål om ny tid. Första publiceringen görs av planeraren; tillämpade operativa ändringar följer reglerna för kontrollerade revisioner.
Gemensam referens för gränssnitt
Utvecklarsidan är den gemensamma förteckningen över Connect-anrop, webhook-händelser och MCP-verktyg. Där framgår gränssnitt, behörighet, godkännande och resultat för varje funktion. Swagger beskriver de publicerade API-fälten, svaren och felkoderna. Den här guiden visar hur ni ansluter, granskar och följer upp.
Tre vägar med olika syften
- Partner-API: ert eller er leverantörs system anropar CAIRE med en egen API-nyckel och de behörigheter ni har valt. Det används för läsningar mellan system och för begäranden som en planerare beslutar om.
- Verksamhetssystem: där en koppling till ert nuvarande verksamhetssystem är uppsatt hämtar CAIRE planeringsunderlag därifrån. Läsanslutningen är enkelriktad och ändrar ingenting i det andra systemet. Annat datautbyte kräver ett separat konfigurerat och verifierat flöde. Planeraren granskar underlaget innan det används. Journalansvaret väljs uttryckligen: inbyggd social Journal eller externt system.
- MCP: en person ansluter ett AI-verktyg med sin egen CAIRE-inloggning. Verktyget når bara det som personen själv har behörighet till. MCP är inte samma sak som en API-nyckel.
Vad kan ni göra i Connect?
Partner-API:t måste vara aktiverat för er organisation. En administratör skapar API-nycklar under Inställningar → Integrationer och väljer vilka enheter och behörigheter varje nyckel får.
- Connect ger system åtkomst till överenskomna planeringsdata och publicerade planer samt ett granskat flöde för underlag och operativa begäranden. Utvecklarsidans gemensamma förteckning visar exakt vilka funktioner respektive gränssnitt erbjuder.
Lämna och granska planeringsunderlag
En ansluten partner med rätt behörighet kan lämna ett planeringsunderlag till Connect och följa dess status. Underlaget väntar på granskning; ett mottaget underlag startar ingen optimering och publicerar ingen plan.
En behörig planerare granskar källa, enhet, besök, personal och planeringsregler innan underlaget accepteras. Därefter skapas och optimeras en daterad plan i CAIREs vanliga planeringsflöde.
Tillgängliga uppgifter och eventuell återföring fastställs för varje anslutning. Partner-API:ts stöd för publicerade planer och kvitton innebär inte att ett källsystem automatiskt kan ta emot ändringar.
Begäranden och vad planeraren gör
En begäran om avbokning, ny tid eller frånvaro hamnar hos planeraren som väntande. En avbokning eller ny tid genomförs inte förrän en planerare har godkänt begäran. Ert system följer statusen genom att läsa begäran eller genom en webhook-händelse, och kan återkalla en begäran som fortfarande väntar.
- Avbokning: går inte att begära för ett besök som redan har börjat eller vars tidsfönster har börjat. Organisationens inställning för avbokningar gäller också.
- Ny tid: ert system anger ett önskat tidsfönster framåt i tiden. När planeraren har godkänt önskemålet flyttar planeraren besöket själv. Inget nytt schema skapas och ingenting publiceras automatiskt.
- Frånvaro: anmälan blir en väntande sjukanmälan och visar direkt luckor i bemanningen på publicerade dagar. En orsak skickas inte med. Återkallas anmälan stängs luckorna igen.
Kvitton och borttagningar
Kvitto: när ert system har tagit emot en publicerad plan kan det lämna ett kvitto med utfallet tillämpad, delvis tillämpad eller avvisad, och ett skäl för varje besök som inte kunde tillämpas. Kvittot ändrar inte planen. Ett kvitto kan bara lämnas för den plan som är publicerad just nu. Ni kan läsa era egna kvitton för en plan.
Borttagningar: listan över borttagningar för en enhet visar id och typ för poster som har raderats permanent, till exempel brukare, medarbetare, besök eller planer. Ni ser bara poster som nyckeln har behörighet att läsa. En arkiverad brukare räknas inte som raderad utan finns kvar i läsningen med status arkiverad. Använd listan för att ta bort samma uppgifter i ert system.
Kom igång: administratör och utvecklare
- 1. Öppna Inställningar → Integrationer och kontrollera att Partner-API:t är påslaget för organisationen.
- 2. Skapa en API-nyckel. Välj de enheter den får använda, minsta möjliga behörigheter och bara de dataklasser som behövs.
- 3. Spara hemligheten när den visas. CAIRE visar den bara en gång. Lägg den inte i ärenden, chattar eller källkod.
- 4. Hämta en åtkomsttoken från tokenadressen med klient-id och hemlighet. Token gäller i högst en timme.
- 5. Gör en första läsning, till exempel av de enheter nyckeln får använda. Listor läses sida för sida, och med updatedSince hämtar ni bara det som ändrats.
- 6. Begäranden, frånvaroanmälningar och kvitton kräver en idempotensnyckel, det vill säga rubriken Idempotency-Key med ett unikt värde per anrop. Samma nyckel med samma innehåll ger samma svar igen.
- 7. Pröva också nekad åtkomst, upprepade anrop, en återkallad nyckel och leverans av händelser innan integrationen används i verksamheten.
Följ upp, felsök och återkalla
Spara resursernas id, anrops-id, status och kvitton i er integration. Ett lyckat anrop betyder bara att just det anropet lyckades. Kontrollera separat om en begäran har godkänts och om en plan har publicerats.
Vid nekad åtkomst kontrollerar administratören nyckelns status, vem den är kopplad till, behörigheter och enheter. Vid problem med händelser kontrollerar utvecklaren adressen, signaturen och leveransloggen. Logga id och felkoder, inte innehåll med personuppgifter.
Återkalla nyckeln när den inte längre behövs. Då slutar alla dess åtkomsttoken att gälla direkt. Skapa en ny hemlighet vid behov och följ organisationens rutin vid incidenter.
Versioner
Partner-API:t har version v1. Inom v1 läggs bara nya fält, värden och anrop till; ert system ska ignorera fält och värden det inte känner igen. En ändring som inte är bakåtkompatibel blir v2, och v1 stöds i minst 12 månader efter att v2 har blivit allmänt tillgänglig.
Swagger-referensen finns på https://www.caire.se/resurser/utvecklare/api. Där kan ni utforska anrop, fält, behörigheter och svar utan att ange inloggningsuppgifter. OpenAPI-filen finns även på https://app.caire.se/api/partner/v1/openapi.json.