Use Cases Synchronisatie Afhandelaar

Overzicht Synchronisatie Afhandelaar

Onderstaande figuur toont een overzicht van de interfaces, services en functies van de Synchronisatie Afhandelaar component. De Synchronisatie Afhandelaar biedt functionaliteit rondom de uitvoering van een register (Verwijsindex, Actualiteitsregister en Abonnementenregister) synchronisatie.

Genereren Verschillenrapportage

Primaire actor	Register Sync Proxy
Systeem	Synchronisatie Afhandelaar
Secundaire actor	Resource Client (GBx-applicatie)
Code	AOF.UC.SA.100.v1
Realiseert Feature	GetVerschillenrapportage

Pre-condities

De primaire actor is aangesloten op het systeem.

Het systeem is slechts benaderbaar voor

componenten van VZVZ die zijn aangesloten via een intern netwerk of op het AORTA netwerk

Triggers

Het systeem start de use case wanneer dit geïnitieerd wordt door de primaire actor.

Main flow

Deze use case flow bestaat uit 6 opeenvolgende interacties met ieder een verzoek en respons.

Na iedere interactie geldt dat het systeem, voor de betreffende interactie, moet voldoen aan de gespecificeerde post-condities m.b.t. logging.

1. Aanvragen verschillenrapportage

Stap

Omschrijving

Uitkomst

1.1

Het systeem ontvangt een verzoek en start de verwerking.

1.2

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

1.3

Het systeem voert een inhoudelijke toets uit op de ontvangen trigger zoals omschreven in de sectie Toetsing RequestDocumentPickup

Als er geen inhoudelijke fout is geconstateerd wordt gaat het systeem door met stap 2.1. Indien er een fout is gevonden gaat het systeem door met stap 3.1 met de geconstateerde foutcode.

2. Uitwisselen inputbestand

Stap	Omschrijving	Uitkomst
2.1	Het systeem bepaalt de URL van het op te halen inputbestand vanuit de trigger van de Primaire actor, zie stap 1.
2.2	Het systeem haalt het inputbestand op, m.b.v. Feature GetInputDocument van de GBx applicatie.
2.3 <exit>	Het systeem ontvangt en verwerkt een response. Het opgehaalde inputbestand voldoet aan het Formaat Inputbestand Register Synchronisatie.
2.4	Het systeem voert een inhoudelijke toets uit op het opgehaalde document zoals omschreven in de sectie Toetsing Inputbestand. Het systeem gaat door met stap 3.1. Indien er een fout is geconstateerd wordt de geconstateerde foutcode meegenomen.

3. Melden inputbestand opgehaald

Stap	Omschrijving	Uitkomst
3.1	De te verzenden notificatie wordt opgesteld volgens het DocumentPickupNotification datamodel Indien een foutcode is meegenomen vanuit stap 1.3 of 2.4. wordt de notificatie-status gevuld met `not-done`, en de Foutmelding-reden gevuld met de foutcode. De Referentie-gerelateerde-RequestDocumentPickup wordt gevuld met de Verzoek-id van de in stap 1 ontvangen trigger.
3.2	Het systeem verkrijgt, m.b.v. Feature getApplication(s), informatie over GBx-applicatie die moet worden genotificeerd.	Ontvanger onbekend statuscode 400 Bad Request
3.2		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
3.3	Het systeem bepaalt m.b.v. de geregistreerde conformances in het APR (verkregen in een vorige stap) of een FHIR- of een v3 Register Sync Notificatie moet worden uitgestuurd. De FQDN waarop de notificatie moet worden afgeleverd wordt eveneens verkregen uit het APR.
3.4	Het systeem verstuurt de Register Sync Notificatie via het bestaande mechanisme voor guaranteed delivery, op de wijze zoals gespecificeerd in: HL7-FHIR: DocumentPickupNotification HL7v3: Decor - Notificeren van beschikbaar bestand
3.5 <exit>	Het systeem ontvangt en verwerkt een response. Indien een foutmelding was gestuurd beëindigd het systeem de flow. In alle andere gevallen gaat het systeem door naar stap 4.1.

4. Melden Verschillenrapportage gereed

Stap	Omschrijving	Uitkomst
4.1	Het systeem genereerd de verschillenrapportage en stelt deze beschikbaar via de Feature GetVerschillenrapportage, en houdt deze beschikbaar gedurende de datum/tijd aangegeven in het verzoek. De verschillenrapportage voldoet aan Formaat Verschillenrapportage Register SYnchronisatie.
4.2	Het systeem verkrijgt, m.b.v. Feature getApplication(s), informatie over GBx-applicatie die moet worden genotificeerd.	Ontvanger onbekend statuscode 400 Bad Request
4.2		Het systeem beëindigt de flow.
4.3	Het systeem bepaalt m.b.v. de geregistreerde conformances in het APR (verkregen in een vorige stap) of een FHIR- of een v3 Process Register Sync Report notificatie moet worden uitgestuurd. De FQDN waarop de notificatie moet worden afgeleverd wordt eveneens verkregen uit het APR.
4.4	Het systeem verstuurt de notificatie via het bestaande mechanisme voor guaranteed delivery, op de wijze zoals gespecificeerd in: HL7-FHIR: RequestDocumentPickup HL7v3: Decor - Download en validatie antwoord
4.5 <exit>	Het systeem ontvangt en verwerkt een response.

5. Uitwisselen verschillenrapportage

Stap	Omschrijving	Uitkomst
5.1	Het systeem wacht op het asynchrone ophalen van de verschillenrapportage volgens de Feature GetVerschillenrapportage. Indien de beschikbaarhaarheids periode van de verschillenrapportage (Document-beschikbaar-tot van de RequestDocumentPickup in stap 4.4) verstreken is, beëindigd de flow.
5.2	Het systeem ontvangt een verzoek en start de verwerking.
5.3	Het systeem toetst of het verzoek voldoet aan de interface specificatie.	Verwerking succesvol statuscode 200 OK
		Ongeldig verzoek statuscode 400 Bad Request
		URL onbereikbaar statuscode 401 Unauthorized
		Bestand is al verwijderd statuscode 404 Not Found
		Het systeem genereert de vereiste response en gaat verder met exit stap van de 5e interactie.
5.4 <exit>	Het systeem retourneert een response naar de primaire actor. Het systeem gaat door naar stap 6.1.

6. Melden verschillenrapportage opgehaald

Stap	Omschrijving	Uitkomst
6.1	Het systeem wacht op een notificatie van de primaire actor over de status van het opgehaalde inputbestand. Indien een periode van 3 dagen verstreken is sinds stap 5.4 beëindigd het systeem de flow.	Time Out Eindigd de flow
6.2	Het systeem ontvangt een verzoek en start de verwerking.
6.3	Het systeem toetst of de Referentie-gerelateerde-RequestDocumentPickup gelijk is aan de Verzoek-id van de RequestDocumentPickup uit stap 4.4).	Onbekende Register Sync Notificatie statuscode 400 Bad Request
6.3		Het systeem genereert de vereiste response en gaat verder met exit stap van de 6e interactie.
6.4 <exit>	Het systeem retourneert een response naar de primaire actor.

Post-condities

Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.

Het systeem heeft van het ontvangen request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id
- role-id wanneer de sender van het request een VZVZ component is, en de aanroep niet via TLS geschiedt
- common name wanneer de aanroep via TLS geschiedt

==

Het systeem heeft voor ieder uitgaand request, dat bij het doorlopen van de use case werd verzonden, de volgende attributen gelogd:

datum en tijd van verzending
request-id
initial-request-id
receiver-id
- role-id wanneer de receiver van het request een VZVZ component is, en de aanroep niet via HTTP geschiedt
- FQDN wanneer de aanroep via HTTP geschiedt

Aanvullend daarop heeft het systeem van het verzonden request de volgende attributen gelogd (indien aanwezig):

Verzoek-id
Referentie-gerelateerde-RequestDocumentPickup
Register-sync-id

Het systeem heeft van de geretourneerde response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
receiver-id
- role-id wanneer de receiver van de response een VZVZ component is, en de aanroep niet via TLS geschiedt
- common name wanneer de aanroep via TLS geschiedt
HTTP statuscode en eventueel geretourneerde foutinformatie

==

Het systeem heeft voor iedere response, die bij het doorlopen van de use case werd ontvangen, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id
- role-id wanneer de sender van de response een VZVZ component is, en de aanroep niet via TLS geschiedt
- common name wanneer de aanroep via TLS geschiedt
HTTP statuscode en eventueel geretourneerde foutinformatie

Aanvullend daarop heeft het systeem van het verzonden request de volgende attributen gelogd (indien aanwezig):

Verzoek-id
Referentie-gerelateerdd-RequestDocumentPickup
Register-sync-id

Formaat Inputbestand Register Synchronisatie

Het inputbestand bevat de gegevens die nodig zijn om alle registraties te identificeren. Tijdens transport is het bestand gecomprimeerd met gzip. Het inputbestand is een csv bestand. Dit betekent dat er per verwijzing één regel wordt gebruikt en de regel wordt beëindigd met een CR/LF (US-ASCII 13,10). Alle onderstaande attributen worden van elkaar gescheiden door een komma (“,”). De volgorde van de attributen geeft de volgorde van de gegevens in de csv.

Afhankelijk van het te synchroniseren register (VWI, ACT, of ABR) zijn er verschillende eisen voor het inputbestand. Afhankelijk van het Type-register-sync uit de RequestDocumentPickup gelden de register specifieke eisen voor het inputbestand zoals hieronder beschreven.

Inputbestand VWI synchronisatie

Attribuut	Cardinaliteit	Formaat
Patiënt-id	1..1	BSN formaat
Gegevenssoort-of-bouwsteentype	1..1	Dit is een waarde uit het codesysteem 2.16.840.1.113883.2.4.15.4 of 2.16.840.1.113883.2.4.3.111.15.3
Bijwerktijd-in-lokale-administratie	1..1	Timestamp, in het formaat YYYYMMDDHHMMSS bijvoorbeeld 20110417161004
Applicatie-id	1..1	Het applicatie-id van het XIS. Dit is een waarde uit het codesysteem 2.16.840.1.113883.2.4.6.6
Zorgaanbieder-id	1..1	Het UZI-registerabonneenummer(URA) van de verantwoordelijke zorgaanbieder. Dit is een waarde uit het codesysteem 2.16.528.1.1007.3.3. De URA in het bestand dient uit 8 cijfers te bestaan en dient indien nodig met voorloopnullen te worden aangevuld.

Inputbestand ACT synchronisatie

Dit moet nog uitgewerkt worden.

Inputbstand ABR synchronisatie

Dit moet nog uitgewerkt worden.

Formaat Verschillenrapportage Register Synchronisatie

De verschillenrapportage bevat de gegevens die nodig zijn om alle verwijzingen te identificeren en te groeperen. Tijdens transport is het bestand gecomprimeerd met gzip. De verschillenrapportage is een csv bestand. Dit betekent dat er per verwijzing een regel wordt gebruikt en de regel wordt beëindigd met een CR/LF (US-ASCII 13,10). Alle onderstaande attributen worden van elkaar gescheiden door een komma (“,”). Elke registratie in het betreffende AORTA register welke afwijkt van het inputbestand wordt in de verschillenrapportage opgenomen als een regel. De volgorde van de attributen geeft de volgorde van de gegevens in de csv.

Afhankelijk van het te synchroniseren register (VWI, ACT, of ABR) zijn er verschillende eisen voor de verschillenrapportage. Afhankelijk van het Type-register-sync uit de RequestDocumentPickup gelden de register specifieke eisen voor de verschillenrapportage zoals hieronder beschreven.

Verschillenrapportage VWI sync

Attribuut	Cardinaliteit	Formaat
Patiënt-id	1..1	BSN formaat
Gegevenssoort of bouwsteentype	1..1	Dit is een waarde uit het codesysteem 2.16.840.1.113883.2.4.15.4 of 2.16.840.1.113883.2.4.3.111.15.3
Bijwerktijd in de VWI	0..1	Indien de verwijzing in de VWI staat wordt deze gevuld met de timestamp van de laatse wijziging van de verwijzing. Bevat een timestamp, in het formaat YYYYMMDDHHMMSS bijvoorbeeld 20110417161004.
Applicatie-id	1..1	Het applicatie-id van het XIS. Dit is een waarde uit het codesysteem 2.16.840.1.113883.2.4.6.6
Zorgaanbieder-id	1..1	Het UZI-registerabonneenummer(URA) van de verantwoordelijke zorgaanbieder. Dit is een waarde uit het codesysteem 2.16.528.1.1007.3.3. De URA in het bestand dient uit 8 cijfers te bestaan en dient indien nodig met voorloopnullen te worden aangevuld.
Categorie	1..1	Indien de vergelijking succesvol was bevat deze categorie een van de volgende codes: `KEY205` De verwijzing staat wel in de VWI, maar niet in het inputbestand. `KEY204` De verwijzing staat wel in het inputbestand , maar staat niet in de VWI. `KEY206` De verwijzing staat in het inputbestand, en in de VWI. Echter, de bijwerktijd van deze verwijzing in de VWI is eerder dan de bijwerktijd die is geregistreerd in het inputbestand Indien een verwijzing niet succesvol kan worden vergeleken bevat deze categorie de volgende code: `SYN105`: Een attribuut van de verwijzing is leeggelaten in het inputbestand.

Verschillenrapportage ACT synchronisatie

Dit moet nog uitgewerkt worden.

Verschillenrapporage ABR synchronisatie

Dit moet nog uitgewerkt worden.

Toetsing RequestDocumentPickup

Het systeem toetst:

Of het ontvangen Document-url geldig is. Als deze niet geldig is wordt de foutcode SYN102 geregisteerd voor de te verzenden DocumentPickupNotification.
Of de Document-url niet eerder is ontvangen. Als deze eerder is ontvangen is wordt de foutcode ALREADYUSEDDOCUMENTID geregisteerd voor de te verzenden DocumentPickupNotification.
Of de Document-id bekend is. Als deze niet bekend is wordt de foutcode UNKNOWNDOCUMENTID geregisteerd voor de te verzenden DocumentPickupNotification.
Of het Document-type ondersteund is. Als deze niet ondersteund is wordt de foutcode Syn103 geregisteerd voor de te verzendenDocumentPickupNotification .

Toetsing Inputbestand

Het systeem toetst:

Of het document een Applicatie-id of een Zorgaanbieder-id bevat. Als dit niet het geval is wordt de foutcode NS101 geregistreerd voor de te verzenden DocumentPickupNotification.
Of de Zorgaanbieder-id (URA) in het document overeenkomt met die van de secundaire actor. Als dit niet het geval is wordt de foutcode INVALCERT geregistreerd voor de te verzenden DocumentPickupNotification.
Of de Applicatie-id in het document onder de URA valt van de secundaire actor. Als dit niet het geval is wordt de foutcode SYN102 geregistreerd voor de te verzenden DocumentPickupNotification.
Of het document de juiste syntax bevat. Als dit niet het geval is wordt de foutcode SYNgeregistreerd voor de te verzenden DocumentPickupNotification.