Een koppeling specificeren

Voordat je de ontwikkelstadia kunt doorlopen, moet je (een versie van) de connector specificeren. Deze wordt gespecificeerd aan de hand van het functioneel ontwerp en het technisch ontwerp.

Functioneel ontwerp

Het functioneel ontwerp is een beschrijving van de versie van de connector. Deze informatie wordt gebruikt bij de beoordeling om de versie van de connector naar een volgend ontwikkelstadium te brengen. De informatie uit het functioneel ontwerp is zichtbaar voor zorgorganisaties in de applicatie ‘Ons Diensten’.

De gegevens bij het functioneel ontwerp zijn alleen aan te passen tijdens ontwikkelstadium 2: development. Controleer de informatie dus goed voordat je toegang naar een volgend ontwikkelstadium aanvraagt.

Omschrijvingen

• Product description
  Naamgeving in Ons Diensten: ‘Beschrijving’
  Hier geef je op welke diensten het achterliggende product biedt, niet zijnde de (versie van de) connector.

• Summarized connector description
  Naamgeving in Ons Diensten: ‘Korte beschrijving’
  Hier geef je in 140 tekens aan wat deze (versie van de) connector doet.

• Connector description
  Naamgeving in Ons Diensten: ‘Over de koppeling’
  Hier geef je uitgebreid aan wat deze (versie van de) connector doet.

• What problem is being solved?
  Naamgeving in Ons Diensten: ‘Toepassing’
  Hier geef je aan wat de meerwaarde van de (versie van de) connector is.

Bij het maken van een nieuwe versie worden beschrijvingen automatisch overgenomen. Hiervoor geldt de laatste versie als bron.

Zorgorganisatie

Vul bij ‘Shared customer’ de gegevens in van de zorgorganisatie die op een actieve manier betrokken is bij de ontwikkeling van de connector.

Technisch ontwerp

In het technisch ontwerp specificeer je:

• Welke data uitgewisseld wordt. Dit doe je door modellen te selecteren en aan te geven welke operations en velden de koppeling nodig heeft.
• Optioneel: Welke autorisaties van toepassing zijn, door rechten te selecteren. Zie voor meer informatie over dit onderwerp: Autorisatie.

Vanuit het data-minimalisatie-oogpunt is het belangrijk om alleen gegevens uit te wisselen die nodig zijn voor de daadwerkelijke koppeling; er mag geen data uitgewisseld worden die niet doelmatig is. Hierop wordt gecontroleerd tijdens de verzoeken om de (versie van de) connector naar een volgend ontwikkelstadium te brengen. Zie ook Dataminimalisatie / filtering.

Het technisch ontwerp is te wijzigen tijdens ontwikkelstadium 2: development.

Modellen

Via de modellen is te specificeren welke data uitgewisseld wordt. Hierbij selecteer je van welke je gebruik wil maken.

Zorgorganisaties die gebruik maken van deze (versie van de) connector zien in Ons Diensten een overzicht van de gespecificeerde modellen.

CRUD Operations
Voor ieder model kun je selecteren welke CRUD (Create, Read, Update, Delete) operations je wilt kunnen uitvoeren. De beschikbare operations kunnen per model verschillen en zijn afhankelijk van de beschikbare endpoints voor dit model. Je hoeft dus niet te specificeren welke exacte endpoints je wilt gebruiken.

De lijst met beschikbare endpoints is te vinden op API’s.

Sandbox mode
Om tijdens het development-stadium het werk eenvoudiger te maken, is de schakelaar Sandbox mode aanwezig.

• Staat deze aan?
  Dan wordt alleen data uitgewisseld die gespecificeerd is.
• Staat deze uit?
  Dan wordt er geen filtering toegepast en kunnen calls op alle endpoints worden gedaan.
  

Sandbox mode moet uitgeschakeld zijn voordat een verzoek gedaan kan worden om de koppeling naar ontwikkelstadium ‘production’ te brengen.

---