Interfaces Resource Broker MedMij-in
AS FHIR Resource Broker Interface
AOF.RB-I.ASF.100.v2
De AS FHIR Resource Broker Interface is nagenoeg gelijk aan de AORTA FHIR Resource Interface, inclusief de gehanteerde HTTP-headers. Dit geldt zowel voor het generieke deel van de interface als voor de AORTA FHIR * interacties. In deze sectie worden daarom slechts de afwijkingen hierop beschreven.
M.b.t. de HTTP-headers die worden gebruikt geldt voor alle interacties de volgende uitzonderingen:
In de Authorization header wordt een MedMij access_token meegestuurd
Authorization: Bearer <medmij_access_token>Tevens zal het, van DigiD ontvangen, authenticatietoken (Assertion), base64url gecodeerd conform RFC 4648) als volgt worden toegevoegd aan ieder request:
DigiD-Authenticatie: Bearer <DigiD SAML Assertion>De
AORTA-Versionheader is optioneel en mag worden weggelaten
Een token dat wordt meegezonden is in sommige gevallen een XML SAMLv2 Assertion, en in andere situaties een JSON Web Token (JWT). Een JWT bestaat uit een aantal base64 strings, die aan elkaar zijn gekoppeld met punten. Omdat een base64url geëncodeerde SAMLv2 Assertion geen punten kan bevatten, is de ontvanger altijd in staat om het type token bepalen.
MedMij CapabilityStatement Interface
AOF.RB-I.MMC.100.v1
Resource broker biedt op zijn endpoint een CapabilityStatement aan. Een resource client kan het statement als volgt bij de resource broker opvragen:
GET [base]/metadata {?_format=[mime-type]}
De waarde van [base] is gelijk aan de in de MedMij ZAL geregistreerde ResourceEndpointUri.
Het gaat hier om een CapabilityStatement van het type "Instance", oftewel het bevat informatie over de daadwerkelijke installatie die benaderbaar is. Bovenstaande capabilities interactie is binnen FHIR verplicht voor FHIR servers.
Deze interface maakt deel uit van de resource interface, zoals gespecificeerd in het MedMij afsprakenstelsel. Op deze interface worden de additionele HTTP headers, zoals de Authorization header en de MedMij-Request-ID header, echter NIET toegepast.
MedMij FHIR Resource Broker Interface
Generiek
AOF.RB-I.MMF.100.v1
Resource broker biedt de resource interface, zoals gespecificeerd in het MedMij afsprakenstelsel. De resource broker biedt gedurende sommige perioden meerdere endpoints, d.w.z. één per actieve release van het MedMij afsprakenstelsel.
Ondersteunde MedMij gegevensdiensten
AOF.RB-I.OMG.100.v2
Resource broker ondersteunt de volgende MedMij gegevensdiensten:
Gegevensdienstnaam | Gegevensdienst-ID | Technisch protocol tussen Resource Broker en Resource Server (xIS) | # inkomende interacties | # uitgaande interacties |
|---|---|---|---|---|
Verzamelen Medicatiegegevens 9.0 | 31 | HL7v3 (via generieke query) | 2 | |
Verzamelen Medicatiegegevens 9.A | 35 | HL7v3 (via generieke query) | 1 | |
Verzamelen Afspraken 2.0 | 47 | HL7-FHIR, HL7v3 (via RB VnC) | 1 | |
Verzamelen Basisgegevens zorg 3.0 | 48 | HL7-FHIR | 28 | |
Verzamelen Huisartsgegevens 2.0 | 49 | HL7-FHIR, HL7v3 (via generieke query) | 7 | |
Verzamelen Basisgegevens GGZ 2.0 | 50 | HL7-FHIR | 19 | |
Verzamelen Documenten 3.0 | 51 | HL7-FHIR, HL7v3 (via generieke query) | 3 per document | |
Verzamelen Meetwaarden vitale functies 2.0 | 52 | HL7-FHIR | 1 | |
Delen Meetwaarden vitale functies 2.0 | 53 | HL7-FHIR, HL7v3 (via RB VnC) | 1 | |
Verzamelen Medicatiegerelateerde Overgevoeligheden 2.A | 58 | HL7v3 (via generieke query) | 1 | |
Verzamelen verwijzingen naar vragenlijsten 2.0 | 59 | HL7-FHIR | 1 | |
Delen antwoorden op vragenlijsten 2.0 | 60 | HL7-FHIR | 2 | |
Delen BgZ-wijzigingsverzoek 1.0 | 62 | HL7-FHIR | 1 | |
De kolommen voor de aantallen interacties bevatten het maximum aantal interacties dat per persoon zal worden geïniteerd om de gehele use case één maal te doorlopen.
RS-Logging Interface
AOF.RB-I.RSL.100.v1
Logbestanden die nodig zijn voor de managementrapportages kunnen, conform gemaakte afspraken in het DAP, middels een API, via HTTPS (TLS) door VZVZ-beheer worden opgehaald. Technisch formaat van de logbestanden is JSON.
De logging kan desgewenst worden opgesplitst in meerdere JSON-bestanden. Ieder JSON-bestand heeft wel altijd betrekking op interacties die plaats hebben gevonden conform één specifieke MedMij-release. Op deze manier kan in de rapportages een beeld worden gecreëerd van het gebruik van een bepaalde MedMij-release in de tijd.
AOF.RB-I.RSL.200.v1
De volgende loggegevens moeten beschikbaar worden gesteld:
FHIR-v3 verkeer | FHIR-FHIR verkeer |
|---|---|
Ontvangen FHIR-requests en de bijbehorende geretourneerde FHIR-responses of error responses
| Ontvangen FHIR-requests en de bijbehorende geretourneerde FHIR-responses of error responses
|
Verzonden introspection requests en de bijbehorende ontvangen introspection responses of error responses
| N.v.t. |
N.v.t. | Verzonden ZAB requests en de bijbehorende ontvangen ZAB responses of error responses
|
N.v.t. | Verzonden token exchange requests en de bijbehorende ontvangen token exchange responses of error responses
|
Verzonden LSP-queries en de bijbehorende ontvangen LSP-responses of error responses, inclusief grootte van responses
| N.v.t. |
N.v.t. | Verzonden FHIR-requests en de bijbehorende ontvangen FHIR-responses of error responses
|
HTTP- en processing errors
| HTTP- en processing errors
|