Hiërarchie van koppelingen

In dit artikel leggen we uit welke hiërarchie koppelingen we kennen, en wat dit betekent.

Definities:

• Supplier
  De externe leverancier / externe partij die koppelingen ontwerpt en beheert. Een externe partij wordt een supplier als deze tijdens de intake is geaccepteerd. De supplier heeft toegang tot het Ons API Dashboard van waaruit hij connectors en versies beheert.
• Connector
  De koppeling; het ‘product’ dat de supplier als dienst aan een zorgorganisatie levert.
• Version
  De versie van een connector.

Hiërarchie

De hiërarchie die we hanteren is als volgt:

• Supplier
  • Connector
    • Version

Elke versie hangt onder één connector, en elke connector onder één supplier. Een supplier kan meerdere connectors hebben en een connector kan meerdere versies hebben. Voorbeeld:

• Supplier A
  • Connector X
    • 0.1.0
    • 1.0.0
    • 2.0.0
  • Connector Y
    • 0.1.0
    • 0.2.0

Versie-aanduiding

Nummering
Wij verplichten geen conventie voor de schrijfwijze van de versie, maar raden de Semantic Versioning-conventie aan: major.minor.patch. Voorbeeld:

• 0.0.1
• 0.0.2
• 0.1.0
• 2.0.0

Omschrijving
Het is mogelijk om een versie-omschrijving in te vullen in het Ons API Dashboard. De versie-omschrijving is op een later moment te wijzigen, het versienummer niet.

Versies en ontwikkelstadia

Elke versie bevindt zich altijd in één van twee stadia: aanpasbaar of niet meer aanpasbaar.

Aanpasbaar: In deze fase bevindt de versie zich nog in de ontwerpfase. Aanpassingen aan het functioneel en technisch ontwerp van de versie zijn nog mogelijk.

Niet meer aanpasbaar: Zodra de versie is vastgesteld, wordt deze als definitief beschouwd. Vanaf dit moment kan de versie worden gekoppeld aan de test- en productieomgevingen van zorgorganisaties. Aanpassingen zijn vanaf dat moment niet meer toegestaan.

• Supplier A
  • Connector X
    • 1.0.0 ⟶ niet aanpasbaar
    • 1.0.1 ⟶ niet aanpasbaar
    • 2.0.0 ⟶ aanpasbaar

Gebruik de knop “Create editable copy of this version” om eenvoudig een missend model of veld toe te voegen.

Certificaten en consent

Alle specificaties waarop wordt getoetst en waarop door zorgorganisaties toestemming wordt verleend (certificaten, consent), bevindt zich op versie-niveau. Een zorgorganisatie kan dus feitelijk geen toestemming geven voor het inschakelen van een koppeling met een connector, maar alleen voor een versie van een connector. Nedap keurt ook geen connector goed, maar alleen een versie van een connector.

Wanneer een nieuwe versie en wanneer een nieuwe connector?

Wanneer kies je ervoor om een nieuwe versie te maken, en wanneer voor een nieuwe connector? Dit is een klein beetje grijs gebied, maar als maatstaf is het goed om het product dat een supplier aan een zorgorganisatie levert te verhouden tot een connector, en een verbijzondering daarvan als versie. Voorbeeld:

• Care 2 Media Concepts B.V. (supplier)
  • NedapOns-Youtube-integratie (connector)
    • 0.9.0 (versie voor pilot-klanten)
    • 1.0.0 (eerste gereleasde versie)
    • 1.1.0 (versie met ondersteuning voor ondertiteling)
    • 1.1.1 (versie met werkende ondertiteling)
  • NedapOns-Instagram-integratie (connector)
    • 0.9.0 (versie voor pilot-klanten)
    • 1.0.0 (eerste gereleasde versie)
    • 1.1.0 (versie met ondersteuning voor ondertiteling)
    • 1.1.1 (versie met werkende ondertiteling)

Update van de koppelingversie bij reeds gekoppelde zorgorganisaties

Als je de versie van een koppeling wilt wijzigen voor een reeds aangesloten zorgorganisatie, moet de zorgorganisatie opnieuw toestemming geven. Zodra die toestemming is verleend, worden de certificaten die aan de oude versie gekoppeld waren automatisch overgezet naar de nieuwe versie.

---