Interfaces Adressering Server

getRoutingInfo

Service

1.6.0

routing-info:OIS:-:1

Adressering

Tijdelijke work-around voor Twiin cancel-notification.

De legacy feature samengevoegd met de actuele feature.

Ready for review. Versie verhoogd van 1.5.0 naar 1.6.0

AOF.UC.ADS.100.v8

getRoutingInfo

1.6.0

AORTA Stelseltoken

>=*

>=*

getRoutingInfo

1.6.0

AORTA-ID HTTP Header

>=1.0.0

>=1.0.0

getRoutingInfo

1.6.0

Formaat AORTA interactietabel

>=*

-

getRoutingInfo

1.6.0

getTransformatieMetadata

>=*

-

AORTA-ID HTTP Header

Subfeature

1.0.0

-

HTTP Headers

19 Oct 2023

Initiële versie van feature.

Name

Cardinality

Type

Toelichting

destination

0..1

Object met attributen

Beoogde bestemming van de interactie.

Vereist wanneer er geen ontvangen interaction aanwezig is met url parameters aanwezig is met daarin een appID (zie interaction bepalingswijze 2) (Legacy)

destination wordt genegeerd wanneer alle ontvangen interaction een url attribuut bevatten met daarin een appID. (Legacy)

Wanneer één ontvangen interaction een url attribuut bevat met een appID en een ander ontvangen interaction wordt uitgedrukt middels een id attribuut, dan wordt de destination slechts gebruikt voor de interaction met het id attribuut. Voor de interaction met het url attribuut wordt dan de appID uit het url attribuut gebruikt. (Legacy)

destination.code

1..1

String

Beoogde bestemming van de interactie.

Mogelijke waarden:

• <appID>

• <URA>

destination.codeSystem

1..1

String

Het gehanteerde codesysteem.

Mogelijke waarden: 

• "urn:oid:2.16.840.1.113883.2.4.6.6" (appID)

• "urn:oid:2.16.528.1.1007.3.3" (URA)

interaction

1..n

Object met attributen

Structuur waaruit het interactie-id van ieder te adresseren interactie kan worden bepaald.

Een interaction dient te zijn gevuld met de attributen volgens één van de volgende bepalingswijze:

1. id (bijv. search:zib-LivingSituation:2)

2. method + url + aortaVersion (bijv. GET + Observation/127328348 + 2.1, nodig voor instance-level interacties) (Legacy)

3. type + fhirProfile + fhirProfileVersion (bijv. read +  http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation + 2.1.3)

4. type + fhirProfile (bijv. search +  http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation)

Bij gebruik van één van de bovenstaande bepalingswijze is de cardinaliteit van de hierboven genoemde attributen verplicht (1..1) en alle andere attributen moeten niet aanwezig zijn (0..0).

interaction.id

0..1

String

Ontvangen interactie-id van het te adresseren bericht. Indien het id attribuut is gevuld, wordt dit beschouwd als het canonieke interactie‑id en wordt geen verdere afleiding toegepast.

Vereist voor interaction bepalingswijze 1.

Het versie-deel in het id attribuut wordt gespecificeerd a.d.h.v. aan major versienummer conform semver, bijvoorbeeld "1", "*" of "x". Hiermee is de compatibiliteit afdoende geborgd.

interaction.method

0..1

String

De gebruikte HTTP method.

Vereist voor interaction bepalingswijze 2. (Legacy)

Moet worden gevuld met waarde “GET”, “POST”, “PUT” of “DELETE”

interaction.url

0..1

String

De gebruikte URL, inclusief eventuele (zoek)parameters.

Vereist voor interaction bepalingswijze 2. (Legacy)

Toegestane formaten zijn:

• voor type-level interacties, zoals search:

  • [base]/[type]{?[parameters]} en

  • [type]{?[parameters]}

• voor instance-level interacties, zoals read en update:

  • [base]/[app-id]/[type]/[id]

  • [app-id]/[type]/[id]

  • [type]/[id]

De waarde van een eventueel meegezonden [base] deel van de URL wordt genegeerd. Bij search interacties kunnen optioneel parameters worden opgenomen in de URL. Deze parameters worden eveneens genegeerd, omdat ze niet van belang zijn voor de juiste bepaling van het interactie-id.

interaction.aortaVersion

0..1

String

De gebruikte AORTA versie van de interactie.

Vereist voor interaction bepalingswijze 2. (Legacy)

Het aortaVersion attribuut wordt gespecificeerd a.d.h.v. aan major versienummer conform semver, dus bijvoorbeeld "1", "*" of "x". Hiermee is de compatibiliteit afdoende geborgd.

interaction.type

0..1

String

Het (restful FHIR) interactie type.

Vereist voor interaction methode 3 en 4.

Moet worden gevuld met waarde “create”, “read”, “update”, “delete”, “search”, “batch” of “transaction“.

De waarden “batch” en “transaction” zijn uitsluitend van toepassing op bundle‑gebaseerde interacties en niet op resource‑specifieke instance‑level interacties.

interaction.mode

0..1

String

Dit attribuut geeft aan of de client de interactie zelf wil initiëren (“initiate”), of dat de resource broker de interactie, bijv. als gevolg van een $get-aorta-data, initieert namens te client (“trigger”).

Indien het attribuut wordt weggelaten, dan is de veronderstelde waarde “initiate”.

Moet worden gevuld met waarde “initiate” of “trigger”.

interaction.fhirProfile

0..1

String

De canonical van het gehanteerde FHIR profiel, bijv. "http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation".

Vereist voor interaction bepalingswijze 3 en 4.

interaction.fhirProfileVersion

0..1

String

De versie van het gehanteerde FHIR profiel.

Vereist voor interaction bepalingswijze 3.

Het fhirProfileVersion attribuut wordt gespecificeerd a.d.h.v. aan major versienummer conform semver, dus bijvoorbeeld "1", "*" of "x". Hiermee is de compatibiliteit afdoende geborgd.

client

0..1

Object met attributen

Client die de interactie initieerde.

Indien aanwezig dan kan deze als volgt zijn gevuld:

• role-id van Resource Broker MedMij-in (deze fungeert binnen AORTA als client namens een PGO)

• app-id van een GBx-applicatie (interactie is geïnitieerd of wordt getriggerd door een GBx-applicatie)

Afwezig wanneer er een ontvangen interaction aanwezig is met url parameters met daarin een appID (Legacy)

client.code

1..1

String

Client die de interactie initieerde.

Mogelijke waarden:

• <appID>

• <role-id>

client.codeSystem

1..1

String

Het gehanteerde codesysteem.

Mogelijke waarden: 

• "urn:oid:2.16.840.1.113883.2.4.6.6" (appID)

• "urn:oid:2.16.840.1.113883.2.4.3.111.8" (role-id)

Name

Cardinality

Type

Toelichting

interactionId

1..1

String

Interactie-id van het uitvoerbare (het adresseren) bericht.

Wordt gevuld met de interactie, indien mogelijk inclusief het  exacte versienummer, waarmee de flow dient te worden vervolgd. Ook indien een transformatie is vereist.

Merk op, dit kan een actuele (> AoF 0.7) interactie-id, of legacy (=< AoF 0.7) interactie-id bevatten. (Legacy)

destinationInfo

0..n

Object met attributen

Slechts aanwezig indien tenminste één geschikte GBx-applicatie is gevonden, en de interactie ook mag worden geïnitieerd.

destinationInfo.destination

1..1

Object met attributen

Beoogde bestemming van de interactie.

destination.code

1..1

String

Beoogde bestemming van de interactie.

Mogelijke waarden:

• <appID>

destination.codeSystem

1..1

String

Het gehanteerde codesysteem.

Mogelijke waarden: 

• "urn:oid:2.16.840.1.113883.2.4.6.6" (appID)

destinationInfo.fqdn

1..1

String

FQDN van de GBx-applicatie.

destinationInfo.transformationId

0..1

String

Het ID van het uit te voeren transformatie algoritme.

Slechts aanwezig indien de applicatie die het request moet beantwoorden, vereist dat eerst een transformatie wordt uitgevoerd.

Wordt nooit gevuld wanneer de interactie een FHIR-operation is.

destinationInfo.aortaATversion

0..1

String

De hoogste versie van het AORTA access_token die wordt ondersteund door de beoogde bestemming van de interactie.

Indien een transformatie vereist is naar een v3 bouwsteenquery, dan moet dit attribuut tenminste AORTA access_token versie 3 bevatten zodat de RB VnC de juiste queries kan opbouwen.

Afwezig indien de bestemming geen AORTA access_tokens kan verwerken, en ook geen transformatie naar een v3 bouwsteenquery is vereist.

Afwezig indien de ontvangen getRoutingInfoRequest volgens de legacy interface was (Legacy)

Stap

Omschrijving

i

Het systeem ontvangt een verzoek en start de verwerking.

Het systeem toetst of het gevraagde type content (Accept header) en het gehanteerde type content (Content-Type header) worden ondersteund.

NB. wanneer het verzoek wordt ontvangen van een component van VZVZ, dan hoeft geen toets op type content te worden uitgevoerd.

Gevraagd type content niet ondersteund

statuscode 406 Not Acceptable

• Deze situatie kan slechts optreden wanneer requests worden ontvangen via HTTP(S)

Gehanteerd type content niet ondersteund

statuscode 415 Unsupported Media Type

• Deze situatie kan slechts optreden wanneer requests worden ontvangen via HTTP(S)

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

1

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

Ongeldig verzoek

statuscode 400 Bad Request

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

2

Het systeem stelt vast voor het verzoek voor welke interactie-id('s) routing info wordt gevraagd. Zie de Toelichting bepalen ontvangen interactie-id(s)

NB. interacties van het type transaction of batch, worden hierin vooralsnog niet uitgesplitst in de individuele interacties die deel uitmaken van de batch/transaction.

Tijdelijke work-around (nodig tot GBZ-applicaties cancelation van notificaties gaan ondersteunen). Indien de uitvoerbare interactie een “update:twiin-TaskNotifiedPull:1” interactie betreft, dan behandelt het systeem deze als “create:twiin-TaskNotifiedPull:1“. In de response (exit stap) wordt als interactie-id echter wel opgenomen “update:twiin-TaskNotifiedPull:1“.

Interactie-id kan niet worden bepaald (komt niet voor in de AORTA interactietabel en/of is onjuist)

statuscode 400 Bad Request

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

3

Het systeem stelt vast voor voor het verzoek welke beoogde doel systeem(en) routing info wordt gevraagd. Zie de Toelichting bepalen beoogde destination(s).

Destination kan niet worden bepaald

statuscode 400 Bad Request

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

4

Het systeem stelt de routeringsinformatie vast m.b.v. het routeringsalgoritme. Als input voor het routeringsalgoritme wordt het interactie-id(s) en beoogde doelsystem(en) gebruikt. Zie de Beschrijving routeringsalgoritme.

Destination niet gevonden

statuscode 404 Not Found

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

5

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

getInteractionInfo

Service

1.0.0

interaction-info.OIS.-.1

Adressering

26 Sep 2025

Initiële versie.

AOF.UC.ADS.200.v1

getInteractionInfo

1.0.0

AORTA Stelseltoken

>=*

>=*

getInteractionInfo

1.0.0

AORTA-ID HTTP Header

>=1.0.0

>=1.0.0

getInteractionInfo

1.0.0

Formaat AORTA interactietabel

>=*

-

getInteractionInfo

1.0.0

getTransformatieMetadata

>=*

-

AORTA-ID HTTP Header

Subfeature

1.0.0

-

HTTP Headers

19 Oct 2023

Initiële versie van feature.

Name

Cardinality

Type

Toelichting

interaction

1..n

Object met attributen

Structuur waaruit het interactie-id kan worden bepaald waar informatie over is opgevraagd

Een interactie dient op één van de volgende methoden te worden doorgegeven:

1. id (bijv. search:zib-LivingSituation:2)

2. type + fhirProfile + fhirProfileVersion (bijv. read +  http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation + 2.1.3)

3. type + fhirProfile (bijv. search +  http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation)

interaction.id

0..1

String

Interactie-id waarover meer informatie wordt gevraagd.

Het versie-deel in het id attribuut wordt gespecificeerd a.d.h.v. aan major versienummer conform semver, dus bijvoorbeeld "1", "*" of "x". Hiermee is de compatibiliteit afdoende geborgd.

interaction.type

0.1

String met waarde create | read | update | delete | search | batch | transaction

Het (restful FHIR) interactie type.

interaction.mode

0..1

String

Dit attribuut geeft aan of de client de interactie zelf wil initiëren (“initiate”), of dat de resource broker de interactie, bijv. als gevolg van een $get-aorta-data, initieert namens te client (“trigger”).

Indien het attribuut wordt weggelaten, dan is de veronderstelde waarde “initiate”.

Mogelijke waarden:

• “initiate”

• “trigger”

interaction.fhirProfile

0..1

String

De canonical van het gehanteerde FHIR profiel, bijv. "http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation".

interaction.fhirProfileVersion

0..1

String

De versie van het gehanteerde FHIR profiel.

Het attribuut wordt gespecificeerd conform semver, dus bijvoorbeeld "1.0.0" of "2.x". De Adressering Server houdt bij het zoeken naar applicaties slechts rekening met het major nummer, omdat compatibiliteit hierdoor afdoende is geborgd.

Name

Cardinality

Type

Toelichting

interactionId

1..1

String

Elk JSON object bevat één van de interactie-ids waarover informatie is opgevraagd.

Wordt gevuld met de interacties vanuit de getInteractionInfoRequest.

interactionInfo

1..1

Object

Object welke interacties bevat die (mogelijk m.b.v. een transformatie) compatible zijn met de gevraagde interactie.

interactionInfo.transformableInteractions

0..n

Array van objecten

Array met interacties die transformeerbaar zijn met de gevraagde interactie.

transformableInteractions.id

1..1

String

Het ID van de betreffende interactie.

Stap

Omschrijving

i

Het systeem ontvangt een verzoek en start de verwerking.

Het systeem toetst of het gevraagde type content (Accept header) en het gehanteerde type content (Content-Type header) worden ondersteund.

NB. wanneer het verzoek wordt ontvangen van een component van VZVZ, dan hoeft geen toets op type content te worden uitgevoerd.

Gevraagd type content niet ondersteund

statuscode 406 Not Acceptable

• Deze situatie kan slechts optreden wanneer requests worden ontvangen via HTTP(S)

Gehanteerd type content niet ondersteund

statuscode 415 Unsupported Media Type

• Deze situatie kan slechts optreden wanneer requests worden ontvangen via HTTP(S)

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

1

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

Ongeldig verzoek

statuscode 400 Bad Request

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

2

Het systeem stelt vast voor welke ontvangen interactie-id('s) interactie info wordt gevraagd. Zie de Toelichting bepalen ontvangen interactie-id(s)

Interactie-id kan niet worden bepaald (komt niet voor in de AORTA interactietabel en/of is onjuist)

statuscode 400 Bad Request

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

3

Het systeem bepaald m.b.v. de transformatie server metadata de interactie-ids waarnaar de gevraagde interactie getransformeerd kan worden.

4

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK