Het is zeer onwaarschijnlijk dat een Koppeltaal interface ongewijzigd blijft. Als de Koppeltaal eisen in der loop ter tijd veranderen, kunnen er nieuwe verzamelingen van FHIR resources, profielen en interacties worden toegevoegd, kunnen de relaties tussen de resources veranderen en kan de structuur van de gegevens in de resources worden gewijzigd.
Hoewel het bijwerken van de Koppeltaal interfaces voor het afhandelen van nieuwe of verschillende behoeften een relatief eenvoudig proces lijkt, moet men echter rekening houden met de effecten die dergelijke wijzigingen kunnen hebben op de aanbiedende en afnemende partijen die de verschillende Koppeltaal interfaces gebruiken. Het probleem is dat, hoewel de leverancier die een Koppeltaal toepassing levert en controle heeft over die interface, geen volledige controle heeft over de voorzieningen en toepassingen, die mogelijk worden geleverd door andere organisaties. Belangrijk is het zorgen dat bestaande toepassingen ongewijzigd blijven werken, terwijl nieuwe toepassingen kunnen profiteren van nieuwe functies en FHIR resources.
Versiebeheer moet ervoor zorgen dat een Koppeltaal interface of resource aan kan geven welke functies en FHIR resources beschikbaar worden gemaakt en een cliënt toepassing interacties kan uitvoeren die doorgestuurd kan worden naar een specifieke versie van een functie of FHIR resource.
Versiebeleid zorgt ervoor dat elke wijziging of aanpassing van een configuratie item (CI) een gedefinieerde versie heeft voor belanghebbenden.
De volgende CI worden
De aanpassingen die aan een Koppeltaal interface of FHIR profiel (CI) wordt gedaan, kunnen in 2 categorieën worden onderverdeeld:
- een Minor of kleine wijziging of
- een Major of grote wijziging
| Interface of Resource release | Omschrijving | Versienummer |
|---|---|---|
| Major | Een breaking change aan een voorziening of toepassing waarbij de afnemer of aanbieder de software functioneel en technisch moet aanpassen om de nieuwe versie te ondersteunen. Hierbij kun je denken aan het noodzakelijk maken van een nieuwe parameter, of de verandering van de structuur of (referentie) type van een FHIR resource. | 1.x, 2.x, etc. |
| Minor | Het betreft het toevoegen van functionaliteit die de bestaande functionaliteit niet aanraakt/beïnvloedt. Afhankelijk van de gekozen implementatie zijn kleine technische aanpassingen alleen lokaal noodzakelijk. | 1.1, 1.2, 2.1, etc. |
| Build | Een niet breaking change aan een een voorziening of toepassing, waarbij de aanbieder of afnemers hun software niet hoeven aan te passen. Een tussentijdse update van de laatste versie, typisch met een aantal verwerkte wijzigingen (RFC’s). | 1.1.001, 1.2.001 |
Het is afhankelijk van de implementatie wanneer een wijziging breaking of niet breaking is. Wanneer bijvoorbeeld validatie wordt toegepast op inkomende berichten en de aanroepende partij hanteert een ander versienummer dan de ontvangende partij waarbij in het bericht een element is toegevoegd, zal bij de ontvangende partij het bericht niet verwerkt worden door deze validatie. Om te voorkomen dat alle wijzigingen breaking zijn, is de keuze gemaakt om elementen in de resources optioneel te maken zodat verschillende Minor en Build versies kunnen communiceren met elkaar of te wel backwards compatible blijven. Bij integratie is het verstandig dat partijen ervan uit gaan dat wijzigingen breaking zijn en dat hiermee rekening moet worden gehouden in de implementatie.
De volgende paragrafen beschrijven verschillende benaderingen hoe om te gaan met verschillende versies, die allemaal hun eigen voor- en nadelen hebben.
Geen versiebeheer
Dit is de eenvoudigste manier en mogelijk acceptabel voor een aantal (interne) Koppeltaal interfaces. Belangrijke wijzigingen kunnen worden weergegeven als nieuwe resources of nieuwe koppelingen. Als u optionele elementen toevoegt aan bestaande FHIR resources, is er mogelijk geen wijziging die problemen geeft, omdat cliënt toepassingen die deze elementen niet verwachten te zien, dit zullen negeren.
Een aanvraag voor de URI moet bijvoorbeeld de details retourneren van Patient 61 met de velden "name" en "birthDate"
GET https://koppeltaal.nl/fhir/Patient/61
{ "resourceType": "Patient",
"id": "61",
"identifier": [ { "use": "official", "system": "irma", "value": "berendbotje01@vzvz.nl" } ], "active": true, "name": [ { "text": "Berend Botje", "family": "Botje", "given": [ "Berend" ] } ], "birthDate": "1970-12-20"
}
Als het optionele element "gender" wordt toegevoegd aan de resource instantie zouden bestaande toepassingen goed moeten blijven werken als ze in staat zijn om niet-herkende elementen te negeren, terwijl nieuwe toepassingen kunnen worden ontworpen voor het afhandelen van dit nieuwe element. Als echter ingrijpender (verplichte) wijzigingen in het schema van de resources optreden (zoals verwijderen of wijzigen van elementen) of de relaties tussen resources worden gewijzigd, kan dit bestaande toepassingen zodanig beïnvloeden dat deze niet meer correct werken. In deze (Major) situaties moet u één van de volgende benaderingen overwegen.
URI-versiebeheer
Telkens wanneer de Koppeltaal interface wijzigt of het schema van resources aanpast, voegt men een uniek versienummer toe aan de URI voor elke resource. De bestaande URI's moeten blijven functioneren als voorheen en resources retourneren die voldoen aan hun oorspronkelijke schema.
Als het vorige voorbeeld wordt uitgebreid, als het veld is geherstructureerd in subvelden met elk onderdeel van het adres (zoals , , en ), kan deze versie van de resource worden blootgesteld via een URI met een versienummer, zoals https://koppeltaal.nl/v2/Patient/3
Dit mechanisme voor versiebeheer is zeer eenvoudig, maar is afhankelijk van de server die de aanvraag naar het juiste eindpunt doorstuurt. Het kan echter onhandig worden als de Koppeltaal interface via verschillende iteraties groeit en de server een aantal verschillende versies moet ondersteunen. Vanuit het oogpunt van een purist halen de toepassingen in alle gevallen dezelfde gegevens op (Patient 3), dus de URI mag niet echt verschillen, afhankelijk van de versie. FHIR Referenties wordt door dit schema ook ingewikkelder, omdat alle koppelingen het versienummer moeten opnemen in hun URI's.
Header-versiebeheer
In plaats van het versienummer in het URI toe te voegen, kan men een aangepaste header implementeren die de versie van de resource aangeeft. Deze aanpak vereist dat de toepassing de juiste header toevoegt aan alle aanvragen, hoewel de code voor het verwerken van de aanvraag een standaardwaarde (versie 1) kan gebruiken als de versie-header wordt weggelaten. In de volgende voorbeelden wordt een aangepaste header met de naam Custom-Header gebruikt. De waarde van deze header geeft de versie van de Koppeltaal interface aan.
GET https://koppeltaal.nl/Patient/3
Custom-Header: Koppeltaal-version=2
Net als bij de vorige benadering moet men voor het implementeren van FHIR referenties de juiste aangepaste header in koppelingen toevoegen.
Mediatype-versiebeheer
Wanneer een client toepassing een HTTP GET-aanvraag naar een webserver verzendt, moet deze de indeling van de inhoud bepalen die ze kan verwerken met behulp van een Accept-header. Vaak is het doel van de Accept-header ervoor te zorgen dat de client toepassing op kan geven of de inhoud van het antwoord XML, JSON of een andere algemene indeling moet zijn, die door de client kan worden geparseerd. Het is echter mogelijk aangepaste mediatypen te definiëren met informatie voor het inschakelen van de client toepassing, om aan te geven welke versie van een FHIR resource wordt verwacht.
In het volgende voorbeeld ziet u een aanvraag die een Accept-header opgeeft met de waarde application/vnd.adventure-works.v2+json. Het vnd.adventure-works.v1-element geeft bij de webserver aan dat versie 2 van de resource moet worden geretourneerd, terwijl het json-element aangeeft dat de indeling van de inhoud JSON moet zijn:
De code voor het verwerken van de aanvraag is verantwoordelijk voor de verwerking van de Accept-header en het zo veel mogelijk naleven ervan (de client toepassing kan verschillende indelingen opgeven in de Accept-header. In dat geval kan de webserver de meest geschikte indeling voor de inhoud kiezen). De webserver bevestigt de indeling van de gegevens in de inhoud met behulp van de Content-Type-header.
Als de Accept-header geen bekende mediatypen opgeeft, kan de webserver een antwoordbericht HTTP 406 (Niet aanvaardbaar) genereren, of een bericht retourneren met een standaard-mediatype. Deze aanpak is weliswaar de zuiverste van de mechanismen voor versiebeheer en is van nature geschikt voor FHIR referenties, dat het MIME-type van gerelateerde gegevens in links naar resources kan opnemen.
Notitie
Wanneer men een strategie voor versiebeheer selecteert, moet men ook de gevolgen voor de prestaties overwegen, met name opslaan in caches op de webserver.
De schema's voor URI-versiebeheer is cache-vriendelijk, aangezien dezelfde combinatie van de URI-querytekenreeks telkens naar dezelfde gegevens verwijst.
De mechanismen voor Header-versiebeheer en Mediatype-versiebeheer vereisen extra logica voor het onderzoeken van de waarden in de aangepaste header of de Accept-header.
In een grootschalige omgeving kan het gebruik van verschillende versies van een web-API door veel clients leiden tot een aanzienlijke hoeveelheid gedupliceerde gegevens in een cache aan serverzijde. Dit probleem kan acuut worden als een client toepassing met een webserver communiceert via een proxy die opslaan in cache implementeert en die alleen een aanvraag naar de webserver verzendt als deze niet op dit moment een kopie van de aangevraagde gegevens in de cache bevat.
Het Open API Iniatief
Het Open API Iniatatief is gemaakt door een brancheconsortium om REST-API-beschrijvingen bij leveranciers te standaardiseren. Als onderdeel van dit initiatief kreeg de Swagger 2.0-specificatie de nieuwe naam OpenAPI Specification (OAS) en werd deze onder het Open API Initiatief gebracht.
Wellicht kan men het OpenAPI overnemen voor de beheer van de verschillende Koppeltaal interfaces. Enkele punten om in overweging te nemen:
De OpenAPI Specification wordt geleverd met een set van richtlijnen over hoe een REST-API moet worden ontworpen. Dit heeft voordelen voor interoperabiliteit, maar vereist meer zorg bij het ontwerpen van de Koppeltaal interfaces om te voldoen aan de specificatie.
OpenAPI draagt bij aan een contract-eerst-benadering, in plaats van een implementatie-eerst-benadering (zie onze referentie implementatie). Contract-eerst betekent dat de Koppeltaal interface-contract (de interface) eerst ontwerpt en vervolgens de code schrijft die het contract implementeert.
Hulpprogramma's zoals Swagger kunnen client bibliotheken of documentatie van de API-contracten genereren. Zie bijvoorbeeld helppagina'ASP.NET web-API met behulp van Swagger.