Additionele eisen via de API

Heb je als intermediair via de Elanza API jouw plansysteem gekoppeld aan Elanza? Dan lees je hier wat je nodig hebt om additionele eisen correct te kunnen ontvangen via de koppeling.

Wat zijn additionele eisen?

Een dienst vraagt regelmatig om extra ervaring, training of specifieke vaardigheden, zoals werken met een bepaalde doelgroep of het uitvoeren van een bijzondere handeling. Additionele eisen ondersteunen dit: het zijn aanvullende, optionele eisen die een zorgorganisatie kan uitvragen. Je kunt dus ook een zorgverlener op een dienst aanmelden die niet over de bijbehorende kwalificatie beschikt.

Bij een aanmelding van een zorgverlener die niet over de bijbehorende optionele kwalificaties beschikt, krijgt de zorgorganisatie een melding. Deze aanmeldingen worden niet meer automatisch geaccepteerd. Een planner moet de individuele aanmelding beoordelen.

Definities

  • Vereist product: het verplichte product van een dienst. Elanza vertaalt dit naar een deskundigheid.
  • Deskundigheid: een of meer verplichte eigenschappen van een zorgverlener. Afhankelijk van de deskundigheid kan een zorgverlener op bepaalde diensten worden aangemeld. In de API noemen we dit skills.
  • Additionele eis: een of meer optionele eigenschappen van een dienst.
  • Kwalificatie: een of meer optionele eigenschappen van een zorgverlener. In de API noemen we dit skills.

⚠️ Let op
 In de API is er geen onderscheid tussen kwalificaties en deskundigheden - dat onderscheid bestaat alleen in de applicatie. In de API worden deskundigheden en kwalificaties uitgedrukt als skills. Als koppelpartner geef je dus geen aparte "kwalificatie" door via de API, alleen skills/deskundigheden.

Hoe lees ik diensten met additionele eisen uit via de API?

Wordt er een dienst aangemaakt met een extra product? Dan sturen we de bijbehorende gevraagde skills mee in het veld optionalSkillUuids.

Waar vind je het veld optionalSkillUuids?

Je vindt dit veld op twee plekken:

  • In de GET /shifts-endpoint
  • In onze webhook-berichten

💡 Tip
 De technische aanpassing is in de meeste gevallen klein - op één voorwaarde: je plansysteem moet onderscheid kunnen maken tussen verplichte en optionele eigenschappen.

Kwalificaties toevoegen aan een pool (bij testen via de UI)

Maak je diensten via de UI aan om de koppeling te testen? Zorg er dan voor dat de betreffende kwalificaties actief zijn in de pool waarnaar je publiceert. Staat een kwalificatie niet in de pool, dan komt die ook niet terug via de skills-API.

Hoe maak ik zorgverleners aan via de API met kwalificaties?

Het aanmaken en updaten van zorgverleners gaat via de Worker API. Gebruik hiervoor het veld skills.