Skip to main content
Skip table of contents

Interfaces Lokalisatie Server

Lokalisatie Interface

Verkrijgen van informatie over bronnen

Feature

getSourceInfo

Type

Service

Versie

1.0.2

Groep

Lokalisatie

Gepubliceerd

Delta

Aanpassingen tijdens ontwikkeling:

  • requester.organisationId vervangen door applicationId;

  • de GBx-applicatie van de requester zelf weglaten uit het resultaat.

  • verhelderd dat consent per dataCategory moet worden bepaald.

Use case

AOF.UC.LOK.100.v2

Feature

Versie

Dependency

Aanbieder

Afnemer

getSourceInfo

1.0.2

AORTA Stelseltoken

-

*

getSourceInfo

1.0.2

AORTA-ID HTTP Header

*

*

getSourceInfo

1.0.2

migratedToMitz

*

-

Inhoud en formaat van een getSourceInfoRequest

Middels deze interactie kan worden bepaald welke GBZ-applicaties beschikken over bepaalde patiëntgegevens. Tevens wordt hierbij informatie geretourneerd over of de betreffende patiënt toestemming heeft gegeven aan de zorgaanbieder om de gegevens beschikbaar te stellen voor opvraag door derden.

Een getSourceInfoRequest wordt op de volgende wijze verzonden:

CODE 
POST [base endpointadres]/getSourceInfo/v1

Bij het verzenden van een getSourceInfoRequest dienen de volgende HTTP headers te worden meegezonden:

Feature

AORTA-ID HTTP Header

Type

Subfeature

Versie

1.0.0

Groep

HTTP Headers

Gepubliceerd

Delta

Initiële versie van feature.

AORTA-ID: initialRequestID=<UUID conform RFC4122>; requestID=<UUID conform RFC4122>

Het initialRequestID attribuut bevat het ID van het allereerste request in de hele keten en dient te worden opgenomen in de logbestanden van alle partijen in de keten, zodat bij foutopsporing de verschillende logbestanden aan elkaar kunnen worden gerelateerd.

Het requestID is voor iedere request message uniek. In requests wordt deze gegenereerd door de client. Ook het requestID dient te worden opgenomen in de verschillende logbestanden, zodat altijd duidelijk is op welk bericht een log entry van toepassing is.

Content-Type: application/json; charset=utf-8

Het technische formaat van de HTTP body van een getSourceInfoRequest is:

JSON 
{
  "source": [
    "",
    ""
  ],
  "requester": {
    "applicationId": "",
    "subject": "",
    "role": "",
    "actor": ""
  },
  "patient": "",
  "dataCategory": [
    {
      "code": "",
      "codeSystem": ""
    }
  ],
  "purposeOfUse": ""
}

Input parameters:

Name

Cardinality

Type

Toelichting

source

0..n

String

Identificatie van de bron, waarvoor de toets moet worden uitgevoerd.

Toegestane vullingen (indien aanwezig):

  • één URA, OF

  • één of meerdere appID’s

Formaat van een URA:

  • "urn:oid:2.16.528.1.1007.3.3.<URA>"

Formaat van een applicatie-id:

  • "urn:oid:2.16.840.1.113883.2.4.6.6.<applicatie-id>"

requester

1..1

Object met attributen

requester.applicationId

1..1

String

ID van de GBx-applicatie van waaruit de opvrager acteert.

Toegestane vullingen:

  • appID

Formaat van een applicatie-id:

  • "urn:oid:2.16.840.1.113883.2.4.6.6.<applicatie-id>"

requester.subject

1..1

ID van de verantwoordelijke persoon.

Toegestane vullingen:

  • UZI-nummer (zorgverlener/medewerker)

Formaat van een UZI-nummer:

  • "urn:oid:2.16.528.1.1007.3.1.<UZI-nummer>", of

  • "http://fhir.nl/fhir/NamingSystem/uzi-nr-pers|<UZI-nummer>"

requester.role

1..1

Rolcode van de verantwoordelijke persoon.

Toegestane vullingen:

  • UZI-rolcode (zorgverlener)

Formaat van een UZI-rolcode:

  • "urn:oid:2.16.840.1.113883.2.4.15.111.<UZI-rolcode>", of

  • "http://fhir.nl/fhir/NamingSystem/uzi-rolcode|<UZI-rolcode>"

requester.actor

0..1

ID van de acterende persoon.

Verplicht aanwezig, indien de acterende persoon iemand anders is dan de verantwoordelijke persoon.

Toegestane vullingen:

  • UZI-nummer (zorgverlener/medewerker)

Formaat van een UZI-nummer:

  • "urn:oid:2.16.528.1.1007.3.1.<UZI-nummer>", of

  • "http://fhir.nl/fhir/NamingSystem/uzi-nr-pers|<UZI-nummer>"

patient

1..1

String

Het ID van de patiënt, d.w.z. de persoon waarop de gegevens, die worden uitgewisseld, betrekking hebben.

Formaat (één van de volgende):

  • "urn:oid:2.16.840.1.113883.2.4.6.3.<BSN>"

  • "http://fhir.nl/fhir/NamingSystem/bsn|<bsn>"

dataCategory

1..n

String

Gegevenssoort of bouwsteentype.

dataCategory.codeSystem

1..1

String

Mogelijke waarden:

  • gegevenssoort: "urn:oid:2.16.840.1.113883.2.4.15.4" 

  • bouwsteentype: "urn:oid:2.16.840.1.113883.2.4.3.111.15.3"

dataCategory.code

1..1

String

Mogelijke waarden:

  • <gegevenssoort>

  • <bouwsteentype>

purposeOfUse

1..1

String

Een aanduiding van de situatie waarin de (beoogde) interactie plaatsvindt, "normaal" of "nood".

Inhoud en formaat van een getSourceInfoResponse

Bij het verzenden van een getSourceInfoResponse dienen de volgende HTTP headers te worden meegezonden:

Content-Type: application/json; charset=utf-8

Het technische formaat van de HTTP body van een getSourceInfoResponse is:

JSON 
{
  "source-info": [
    {
      "applicationId": "",
      "dataCategory": [
        {
          "code": "",
          "codeSystem": "",
          "consent": ""
        }
      ]
    }
  ]
}

Output parameters, nul of meerdere sourceInfo objecten. Inhoud van een sourceInfo object:

Name

Cardinality

Type

Toelichting

applicationId

1..1

string

Het app-id van de GBx-applicatie die over de gevraagde gegevens beschikt.

Het betreft het app-id zonder aanduiding van een namingsystem of root OID.

dataCategory

0..n

String

Gegevenssoort of bouwsteentype.

dataCategory.codeSystem

1..1

String

Mogelijke waarden:

  • gegevenssoort: "urn:oid:2.16.840.1.113883.2.4.15.4" 

  • bouwsteentype: "urn:oid:2.16.840.1.113883.2.4.3.111.15.3"

dataCategory.code

1..1

String

Mogelijke waarden:

  • <gegevenssoort>

  • <bouwsteentype>

dataCategory.consent

1..1

String

De waarde van de toestemming van de patiënt.

Mogelijke waarden:

  • “Permit”, er is toestemming gegeven

  • “Deny”, er is geen toestemming gegeven

  • “Unknown”, onbekend, geen oordeel over toestemming

HTTP statuscodes

HTTP statuscodes die kunnen worden geretourneerd zijn opgenomen in onderstaande tabel.

Omdat bepaalde Confluence macro’s nog niet worden ondersteund in de publicatie omgeving, bevat de tabel, in de publicatieomgeving, ook informatie over de wijze waarop de betreffende interface wordt geïmplementeerd in de server component. De statuscodes die kunnen worden geretourneerd zijn opgenomen in de kolom “Uitkomst”. De overige informatie mag worden genegeerd.

Stap

Omschrijving

Uitkomst

1

Het systeem ontvangt een verzoek en start de verwerking.

Gevraagd type content niet ondersteund

statuscode 406 Not Acceptable

Gehanteerd type content niet ondersteund

statuscode 415 Unsupported Media Type

Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.

2

Het systeem toetst of het verzoek voldoet aan de interface specificatie.

Ongeldig verzoek

statuscode 400 Bad Request

Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.

3

Ontvangen request bevat ID('s) van te bevragen source(s):

  • Het systeem toetst, m.b.v. feature migratedToMitz of op een andere wijze m.b.v. het APR, of er zich binnen de source, waarover informatie wordt gevraagd, GBZ-applicaties bevinden die voor patiënt toestemming zijn gemigreerd naar Mitz.

  • Het systeem toetst bij Mitz, middels de gesloten toestemmingsvraag, of de patiënt toestemming heeft verleend voor beschikbaarstelling van gegevens onder de omstandigheden, zoals gerepresenteerd in het ontvangen request.

Het verkregen antwoord van Mitz geldt voor alle GBZ-applicaties die voor patiënt toestemming zijn gemigreerd naar Mitz. Voor eventueel niet-gemigreerde GBZ-applicaties (van de aangeduide zorgaanbieder) kan de toestemming niet worden vastgesteld (consent=”Unknown”). Het systeem bepaalt de juiste waarde van de consent voor elk van de gevraagde dataCategories.

Mitz migratie status kan niet worden vastgesteld

statuscode 500

Status van toestemming in Mitz kan niet worden vastgesteld

statuscode 500

Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.

4

Ontvangen request bevat géén ID('s) van te bevragen source(s):

  • Het systeem bepaalt, m.b.v. de Verwijsindex, welke GBZ-applicaties beschikken over gegevens zoals aangeduid in het ontvangen request.

  • Het systeem toetst, m.b.v. feature migratedToMitz of op een andere wijze m.b.v. het APR, of er zich binnen de verkregen VWI-bronnen, GBZ-applicaties bevinden die voor patiënt toestemming zijn gemigreerd naar Mitz, en laat deze weg uit het verkregen tussenresultaat.

  • Het systeem toetst bij Mitz, middels de open toestemmingsvraag, of er bronnen (GBZ-applicaties) zijn, waaraan de patiënt toestemming heeft verleend voor beschikbaarstelling van gegevens onder de omstandigheden, zoals gerepresenteerd in het ontvangen request.

  • Het systeem bepaalt, m.b.v. het Actualiteitsregister, voor alle gevonden bronnen in Mitz, over welke gegevenssoorten/bouwsteentypen zij beschikken voor deze patiënt.

Het systeem voegt de verkregen informatie samen. Voor appID’s die zijn verkregen van Mitz krijgt consent de waarde “Permit”. Voor appID’s die zijn verkregen uit de VWI, en die niet zijn gemigreerd naar Mitz, krijgt consent de waarde “Unknown”. Het systeem bepaalt de juiste waarde van de consent voor elk van de gevraagde dataCategories.

VWI-bronnen kunnen niet worden bepaald

statuscode 500

Mitz migratie status kan niet worden vastgesteld

statuscode 500

Mitz-bronnen kunnen niet worden bepaald

statuscode 500

Toets bij Actualiteitsregister kon niet worden uitgevoerd

Het systeem logt deze gebeurtenis, en gaat verder met de verwerking.

Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.

5

De GBx-applicatie van de requester (geïdentificeerd door requester.applicationId) wordt, indien aanwezig, uit de verkregen informatie weggehaald.

6

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close