Page Comparison

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.

...

 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 een Koppeltaal interface wijzigt of het schema van de resources wordt aanpast, voegt men een uniek (major) versienummer toe aan de URI voor elke (FHIR) 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, met een verplicht element zoals bijvoorbeeld "gender", kan deze nieuwe versie van de resource worden blootgesteld via een URI met eenversienummer, zoals https://koppeltaal.nl/fhir/v2/Patient/61 

Dit mechanisme voor versiebeheer is zeer eenvoudig, maar is afhankelijk van de FHIR Resource Provider die de aanvraag naar het juiste eindpunt moet doorsturen. Dit mechanisme kan onhandig worden als de Koppeltaal interface via verschillende iteraties groeit en de FHIR Resource Provider een aantal verschillende versies moet ondersteunen. Vanuit het oogpunt van een purist halen de toepassingen in alle gevallen dezelfde gegevens op (Patient 61), dus de URI mag niet echt verschillen, afhankelijk van de versie. FHIR referenties wordt door dit mechanisme ook ingewikkelder, omdat alle referenties 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 (HTTP) 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 het 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/fhir/Patient/61 HTTP/1.1

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 cliënt toepassing een HTTP GET-aanvraag naar de FHIR Resource Provider verzendt, moet deze de indeling van de inhoud bepalen die het kan verwerken met behulp van een Accept-header. Vaak is het doel van de Accept-header ervoor te zorgen dat de cliënt toepassing op kan geven of de inhoud van het antwoord XML, JSON of een andere algemene indeling moet zijn, die door de cliënt kan worden verwerkt. Het is echter mogelijk aangepaste media typen te definiëren met informatie voor het inschakelen van de cliënt toepassing, om aan te geven welke versie van een FHIR resource wordt verwacht.

In het volgende voorbeeld is een aanvraag met een Accept-header met de waarde application/koppeltaal.adventure-works.v2+json. Het koppeltaal.adventure-works.v2-element geeft bij de FHIR Resource Provider aan dat versie 2 van de resource aan de cliënt toepassing 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 cliënt toepassing kan verschillende indelingen opgeven in deAccept-header. In dat geval kan de FHIR Resource Provider de meest geschikte indeling voor de inhoud kiezen). De FHIR Resource Provider bevestigt de indeling van de gegevens in de inhoud met behulp van de Content-Type-header.

Als de Accept-header geen bekende media typen opgeeft, kan de FHIR Resource Provider een antwoordbericht HTTP 406 (Niet aanvaardbaar) genereren, of een bericht retourneren met een standaard-mediatype. Deze aanpak is misschien de zuiverste van de verschillende methoden voor versiebeheer en is van nature geschikt voor FHIR referenties, dat het MIME-type van gerelateerde gegevens in links naar resources kan opnemen.

...

Het Open API Initiatief voor versiebeheer van interfaces

Het Open API Initiatief is gemaakt door een brancheconsortium om (FHIR) 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.

...

• 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.

FHIR Profielen voor versiebeheer van resources

FHIR resources zijn in de basis generiek en worden met behulp van profielen uitgebreid en specifieker gemaakt voor een specifieke toepassing. In een profiel wordt bijvoorbeeld beschreven:

• Versie identifier die gebruikt wordt om de versie van de structuur te identificeren wanneer ernaar wordt verwezen in een specificatie, model, ontwerp of exemplaar. 
• Welke resource elementen worden gebruikt en welke niet en welke additionele elementen worden toegevoegd die geen onderdeel zijn van de basisspecificatie van een FHIR basis set.
• Welke API interacties worden er gebruikt voor een bepaalde resource
• Welke terminologieën worden gebruikt in bepaalde elementen
• Hoe de resource elementen mappen naar lokale eisen en/of implementaties

Door de manier waarop profielen wordt toegepast binnen FHIR kunnen er voor een bepaalde basis resource versie (DSTU 2, STU 3, R4, etc.) een groot aantal verschillende profielen bestaan, bijvoorbeeld afhankelijk van zorgdomein, land, instelling of leverancier. Om interoperabiliteit te borgen is het van belang dat binnen een bepaalde 'use case' dezelfde profielen gebruikt worden. 

Elke  FHIR basis set, bestaat uit:

• set datatypes (primitieve, algemene, meta en speciale toepassingen) 
• set resources (+/- 148 resources)
• standaard REST operaties 
• standaard zoek (search) parameters
• standaard terminologie 

Elke FHIR resource (zie het element meta.profile in een resource instantie) refereert naar een Canonical URL. Dit is een unieke identifier voor een conformance resource (uri) waaraan de resource beweert te voldoen.

Voorbeeld: een Patient die aan het KT2_Patient profiel voldoet 

{
  "resourceType": "Patient",
  "meta": {
     "profile": [ "http://example.org/fhir/StructureDefinition/KT2Patient" ]
  },
  ...
}

Deze Patient (JSON) structuur instantie beweert te voldoen aan een profile wat is vastgelegd in http://example.org/fhir/StructureDefinition/KT2Patient

De Profile legt beperkingen op FHIR basis datatypes, FHIR basis resources en eventueel op een ander FHIR profile. Verder kunnen er additionele elementen worden toegevoegd die geen onderdeel zijn van de FHIR basis set. Een profile is gelaagd (er zit een hiërarchische structuur in ).

Bijvoorbeeld:

• FHIR STU3-CORE→ FHIR NL-CORE (2017) → FHIR NL Medicatie → MedMij
• FHIR STU3-CORE→ FHIR NL-CORE (2017) → FHIR NL Medicatie → ZIB (Zorg Informatie Bouwsteen)
• FHIR R4-CORE → FHIR NL-CORE (2020) → FHIR Koppeltaal 2.0

Een register met FHIR profielen is te vinden op www.simplifier.net (deze site is opgezet in samenwerking met HL7 Nederland). Een draft versie van een Koppeltaal 2.0 profile, gebaseerd op FHIR R4 , met een National NL scope, is te vinden op Simplifier.NET. 

Voor Koppeltaal 2.0: https://simplifier.net/koppeltaalv2.0

{}