Interfaces Adressering Server

getRoutingInfo

Service

1.2.3

Adressering

03 May 2024

Toegevoegd dat uitgaande requests en ontvangen responses ook moeten worden gelogd in de componentenlog.

AOF.UC.ADS.100.v3

getRoutingInfo

1.2.3

AORTA Stelseltoken

*

*

getRoutingInfo

1.2.3

AORTA-ID HTTP Header

*

*

getRoutingInfo

1.2.3

Formaat AORTA interactietabel

*

-

getRoutingInfo

1.2.3

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 één van de ingestuurde interactions géén url  attribuut bevat met daarin een appID.

Wordt genegeerd wanneer alle ingestuurde interactions een url  attribuut bevatten met daarin een appID.

Wanneer één ingestuurde interaction een url attribuut bevat met een appID en een andere ingestuurde 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.

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 bericht kan worden bepaald.

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 van het te adresseren bericht, of van de te adresseren berichten.

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

client

0..1

Object met attributen

Beoogde client voor de interactie.

client.code

1..1

String

Beoogde client voor de interactie.

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 te adresseren bericht, of van de te adresseren berichten.

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

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.

Afwezig indien de bestemming geen AORTA access_tokens kan verwerken.

Stap

Omschrijving

i

Het systeem ontvangt een verzoek en start de verwerking.

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

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.

1

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.

2

Het systeem stelt vast voor welke interactie-id('s) routing info wordt gevraagd.

Interactie-id kan niet worden bepaald (of is onjuist)

statuscode 400 Bad Request

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

3

Het systeem stelt, m.b.v. de transformatie server metadata, vast welk van de gevraagde interactie-id('s) eventueel m.b.t. transformatie kunnen worden uitgevoerd, en bepaalt naar welke interactie-id's dan zou worden getransformeerd.

4

Het systeem stelt voor iedere gevraagde interactie-id vast, naar welke actieve GBx-applicatie(s) (appID) binnen de aangegeven destination, de betreffende interactie, zo nodig na transformatie, kan worden verzonden. 

• Instance-level interactie: het appID wordt verkregen uit het url attribuut in de interaction (formaat van de url is in deze situatie "<base endpointadres Resource Broker XXX-in>/<appID>/<type>/<id>").

• Type- of whole system interactie: hierbij wordt gebruik gemaakt van de Applicatie Register Interface van het APR (zie ook de Toelichting "systeemrollen en conformances" en de Toelichting "filtering interacties").

In de rol van Resource Server, verschijnt Resource Broker GTK hierbij uit als een reguliere GBx-applicatie (Resource Server). RB GTK heeft één appID, en kan interacties opzetten met alle, op Twiin aangesloten, externe GTK’s.

RB GTK wordt als Resource Server slechts betrokken in het routeringsalgoritme indien:

• voor een interactie geen route kan worden gevonden binnen AORTA, en

• de beoogde bestemming van een interactie (URA) deze blijkens de registratie in ZORG-AB ook kan ontvangen. NB. omdat verwacht wordt dat ZORG-AB hiervoor niet tijdig geschikt zal zijn, wordt in eerste instantie gewerkt met een interne registratie in het systeem.

Destination niet gevonden

statuscode 404 Not Found

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

Client niet gevonden

statuscode 404 Not Found

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

5

Het systeem stelt voor iedere gevonden GBZ-applicatie, op basis van de systeemrollen in het APR, vast of de betreffende applicatie AORTA access_tokens kan verwerken, en zo ja wat de hoogste versie is die wordt ondersteund.

6

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK