AORTA on FHIR specificaties
Working version v20260904 v20260521 v20251218 v20250926 v20250723 v20250613 v20250328 v20250110 v20241108 v20240923
AORTA on FHIR specificaties
Working version v20260904 v20260521 v20251218 v20250926 v20250723 v20250613 v20250328 v20250110 v20241108 v20240923
Breadcrumbs

AORTA interactietabel



Feature

Formaat AORTA interactietabel

Type

Subfeature

Versie

2.0.0

Systeemrolcode

-

Groep

Configuratie

Gepubliceerd

Delta

Toevoeging fhir.include attribuut, waarmee _include parameters kunnen worden geconfigureerd die moeten worden toegevoegd aan een FHIR-search interactie.

In de export van de interactietabel worden kolommen contextcode en gegevensdienst niet langer meegeleverd. Deze kolommen werden tijdelijk nog wel meegeleverd, maar horen niet in de interactietabel.

De AORTA interactietabel bevat alle interacties die via AORTA kunnen plaatsvinden. Interacties delen eenzelfde groupId wanneer ze functioneel equivalent zijn. Verschillende interacties zijn technisch, per definitie, niet gelijk aan elkaar. Wanneer interacties onderling kunnen worden getransformeerd naar elkaar, dan is dit opgenomen in de metadata van de Transformatie Server. Dit is niet zichtbaar in de AORTA interactietabel.

AoF Releases

Test Version

CSV bestand

Datum

Delta

test-AoF-Interactions-config-20260529.csv

Preference attribuut van interactie-id’s in oude 0.7 interactie-id formaat gelijk gesteld aan die van het interactie-id van dezelfde interactie in het 1.0 formaat. Op deze wijze kunnen “synoniemen” worden herkend.

test-AoF-Interactions-config-20260519.csv

Toegevoegd ConsentNotification: PXAC_IN990010NL01

test-AoF.2026.1-interactions-config-20260304.csv

Toegevoegd

  • create:DocumentPickupNotification

  • create:RequestDocumentPickup

  • PZP (ACP) search interacties

Verwijderd

  • create:RegisterSyncNotification

  • create:RegisterSyncRequest

Toegevoegd

  • Contextcode MEDMVE en corresponderende autorisaties

test-AoF.2026.1-interactions-config-20251105.csv

Toevoeging fhir.include attribuut, waarmee _include parameters kunnen worden geconfigureerd die moeten worden toegevoegd aan een FHIR-search interactie.

In de export van de interactietabel worden kolommen contextcode en gegevensdienst niet langer meegeleverd. Deze kolommen werden tijdelijk nog wel meegeleverd, maar horen niet in de interactietabel.

test-AoF.2026.1-interactions-config-20251007.csv

Toevoeging interactie getInteractionInfo.

Nieuw beleid rondom naamgeving

Zie hieronder AORTA interactietabel | Naamgevingsbeleid

test-AoF.2026.1-interactions-config-20250603.csv

Contextcode MEDMTDTOT toegevoegd aan

search:MedicationAgreement2;search:mp-MedicationAgreement:1

search:MedicationAgreement2;QUMA_IN991201NL04

AoF-Interactions-Working-12 (2).csv

AoF-Interactions-Working-12 weer teruggezet door de programmeurs wegens problemen met de classifier en de scopeExtension in de NotificationTask. In overleg met de programmeurs dient dit hersteld te worden en dient de interactietabel naar aanleiding hiervan aangepast worden.

AoF-Interactions-Working-13.csv

fhir.classifier aangepast voor de berichten create:twiin-TaskNotifiedPull:1 en update:twiin-TaskNotifiedPull:1 van code=http://fhir.nl/fhir/NamingSystem/TaskCode|pull-notification naar code=http://fhir.nl/fhir/CodeSystem/TaskCode|pull-notification.

fhir.scopeExtension aangepast conform de AoF-specificaties naar

patient/Task.c?code=http://vzvz.nl/fhir/CodeSystem/aorta-taskcode|notified_pull

AoF-Interactions-Working-12.csv

Interacties voor RegisterSync toegevoegd.

AoF-Interactions-Working-11.csv

Capabilities interactie (“FHIR-ping”) toegevoegd voor R4.

AoF-Interactions-Working-10.csv

Opvragen medicatieafspraken interacties voor MO in een nieuwe groep gestopt, zodat niet kan worden teruggevallen op medicatieafspraken die worden gebruikt in de BGZ of bij MedMij.

AoF-Interactions-Working-9.csv

Cancel-notification interactie toegevoegd t.b.v. AORTA GTK.

AoF-Interactions-Working-8.csv

Interactie search:mp612-DispenseToFHIRConversion-Dispense:1 samengevoegd met search:mp612-DispenseToFHIRConversion-Dispense:1. Wordt gebruikt door LSP+.

AoF-Interactions-Working-7.csv

Protocol van capabilities:1.0:request gewijzigd in “hl7fhir”.

Interacties met protocol “aorta” weer toegevoegd aan tabel. Deze worden gebruikt om een ander configuratiebestand t.b.v. logging te vullen.

Ontbrekende scopeExtension toegevoegd bij search:mp-MedicationAdministration2:1.

AoF-Interactions-Working-6.csv

Toevoeging read interacties voor scopeExtensions die nog ontbraken als afzonderlijke interactie.

AoF-Interactions-Working-5.csv

Toevoeging extra scopeExtensions t.b.v. _includes MO.

Toevoeging interactie-id’s t.b.v. nieuwe transformaties.

Interacties met protocol “aorta” verwijderd.

AoF-Interactions-Working-4.csv

Typo fix in classifier nierfunctie.

AoF-Interactions-Working-3.csv

Scope extensions toegevoegd t.b.v. compatibiliteit Twiin en AORTA notificaties.

AoF-Interactions-Working-2.csv

Bevat ook fixes uit 2024_1-3.

AoF-Interactions-Working-1.csv

Toevoeging interacties voor GTK.

Productie - AoF

CSV bestand

Datum

Delta

prod-AoF.2026.2-Interactions-config-20260716.csv

Toegevoegd:

  • create:Communication|create:mp-ReplyProposalDispenseRequest:1

  • create:Communication|create:mp-ReplyProposalMedicationAgreement-Bundle:1

  • create:DocumentPickupNotification|create:nl-vzvz-notify-document-retrieved:1

  • create:RequestDocumentPickup create:nl-vzvz-notify-document-ready:1

  • operation:InteractionInfo operation:interaction-info:1

  • search:AdvanceDirective2 search:ACP-AdvanceDirective:1

  • search:CommunicationRequest search:ACP-InformRelativesRequest:1

  • search:Encounter search:ACP-Encounter:1

  • search:Goal search:ACP-MedicalPolicyGoal:1

  • search:MedicalDevice2 search:ACP-MedicalDevice:1

  • search:Observation search:ACP-Observation:1

  • search:Procedure2 search:ACP-Procedure:1

  • search:TreatmentDirective2 search:ACP-TreatmentDirective:1

  • search:TreatmentDirective2 search:nl-core-TreatmentDirective2:1

  • transaction:ConsentNotification PXAC_IN990010NL01

Verwijderd:

  • create:RegisterSyncNotification create:nl-vzvz-notify-document-retrieved:1

  • create:RegisterSyncRequest create:nl-vzvz-notify-document-ready:1

Verwijderd kolommen;

  • contextCode

  • gegevensdienst

Toegevoegd kolom:

  • fhir.include

Aanpassingen:

  • preference

  • fhir.scopeExtension

is gelijk aan Test 29 mei 2026

prod-AoF.2024.3-interacties-config-20250603.csv

  • Concept toegevoegd voor create:HealthcareProviderLocation

  • Toegevoegd create:RegisterSyncNotification

  • Toegevoegd create:RegisterSyncRequest

  • Interactie operation:capabilities:2 toegevoegd aan group operation:Capabilities

  • Bijgewerkt search:MedicationAgreement2 met extra contextcode MEDMTDTOT

Nieuw beleid rondom naamgeving

Zie hieronder AORTA interactietabel | Naamgevingsbeleid

AoF-Interactions-2024_3-1.csv

Opvragen medicatieafspraken interacties voor MO in een nieuwe groep gestopt, zodat niet kan worden teruggevallen op medicatieafspraken die worden gebruikt in de BGZ of bij MedMij.

AoF-Interactions-2024_2-3.csv

Interactie search:mp612-DispenseToFHIRConversion-Dispense:1 samengevoegd met search:mp612-DispenseToFHIRConversion-Dispense:1. Wordt gebruikt door LSP+.

AoF-Interactions-2024_2-2.csv

Protocol van capabilities:1.0:request gewijzigd in “hl7fhir”.

Interacties met protocol “aorta” weer toegevoegd aan tabel. Deze worden gebruikt om een ander configuratiebestand t.b.v. logging te vullen.

Ontbrekende scopeExtension toegevoegd bij search:mp-MedicationAdministration2:1.

Toevoeging read interacties voor scopeExtensions die nog ontbraken als afzonderlijke interactie.

AoF-Interactions-2024_2-1.csv

Toevoeging extra scopeExtensions t.b.v. _includes MO.

Toevoeging interactie-id’s t.b.v. nieuwe transformaties.

Interacties met protocol “aorta” verwijderd.

Scope extensions toegevoegd t.b.v. compatibiliteit Twiin en AORTA notificaties.

Toevoeging interacties voor GTK.

AoF-Interactions-2024_1-4a.csv

Tijdelijke fix in scopeExtension kolom: “patient/” verwijderd, en “ “ vervangen door “,”.

Fix is niet meer nodig zodra AS ZA die het attribuut gebruikt is aangepast.

AoF-Interactions-2024_1-4.csv

Typo fix in classifier nierfunctie.




AoF-Interactions-2024_1-3.csv

Correctie BGZ LabResult codes, nu alle categories die vallen onder labresults toegestaan.

Response interacties verwijderd. Horen niet in interactietabel.




AoF-Interactions-2024_1-2.csv - NIET GEBRUIKEN, bevat fouten.

MO:

  • Meesturen nierfunctie bij voorschrift

  • Correctie lichaamsgewicht en lengte bij voorschrift (nu R4 interacties)

LSP+:

  • Interacties voor Huisartsgegevens toegevoegd t.b.v. BTD.

  • Category bij labresultaten BGZ gecorrigeerd.

AoF-Interactions-2024_1-1.csv

Initiële configuratie voor deze release.

AoF-Interactions-3.csv

scopeExtension geformatteerd als kant-en-klare onderdelen om op te nemen in de scope.

AoF-Interactions-2.csv

Toevoeging interactionIdResponse attribuut voor v3-interacties

AoF-Interactions-1.csv

Fix: response type interacties verwijderd uit bestand.

Structuur interactietabel

De structuur van interactietabel is als volgt:

Attribuut

Cardinaliteit

Type

Toelichting

groupId

1..1

String

Interacties delen eenzelfde groupId wanneer ze functioneel equivalent zijn.

Formaat:

  • <interactionType>:<concept>

interactionId

1..1

String

Uniek ID voor de betreffende interactie.

NB. het betref het ID waarmee het soort interactie kan worden aangeduid. Het gaat niet om een ID van een instance van een interactie.

Het ID wordt samengesteld uit de waarde van een andere kolommen in de interactietabel. Het formaat is afhankelijk van het protocol van de interactie.

Formaat voor “hl7fhir”:

  • <interactionType>:<fhir.profile>:<major van fhir.profileVersion>

Formaat voor “hl7v3”:

  • <v3.tempateId>

Formaat voor “aorta”:

  • <interactionType>:<fhir.profile>:<major van fhir.profileVersion>
    Voor deze interacties worden dus, zoals te zien, vooralsnog kolommen gebruikt die eigenlijk zijn bedoeld voor FHIR-interacties.

interactionType

1..1

String

Mogelijke waarden:

  • “create“, “read“, “update“, “delete“, “search“, “transaction“, “operation“.

Interacties met protocol gelijk aan “aorta” hanteren altijd interactionType “operation”.

direction

1..1

String

Interacties die zijn aangeduid als “push-verkeer” verlopen via de protocol-agnostische push-aorta-data operatie. Voor deze interacties wordt eventueel de waarde van fhir.classifier gebruikt om autorisatierestricties aan te brengen.

Voor interacties die zijn aangeduid als “pull-verkeer” geldt dat bij het verkrijgen van een AORTA access_token de SDS moet worden geraadpleegd om eventuele autorisatierestricties op te halen.

Mogelijke waarden:

  • “push”, “pull”, “response”, “-”.

Interacties waarvoor het direction attribuut gelijk is aan “response”, zijn slechts opgenomen in de configuratie voor de Transformatie Server (BTD), en zijn niet nodig voor andere doeleinden.

concept

1..1

String

Het type concept (protocol-agnostisch) dat onderwerp is van de interactie.

Voor interacties met interactionType “create“, “read“, “update“, “delete“ of “search“ (protocol is hiervoor altijd gelijk aan “hl7fhir” of “hl7v3”), wordt concept gevuld met het ZIB-type waarop de interactie betrekking heeft.

Voor interacties met interactionType “transaction“ (protocol is hiervoor altijd gelijk aan “hl7fhir” of “hl7v3”), wordt concept bij voorkeur gevuld o.b.v. het FHIR-profiel van de FHIR-transaction. De v3-interactie hanteert dan hetzelfde concept. Indien geen FHIR-profiel van toepassing is, dan wordt zelf een toepasselijke naam gekozen. Dit laatste geldt ook voor interacties met interactionType “aorta”.

effective-time

1..1

String

Naam van de interactie-specifieke parameter, waarmee de generieke parameter effective-time moet worden doorgegeven.

Leeg indien niet van toepassing.

therapy-identifier

1..1

String

Naam van de interactie-specifieke parameter, waarmee de generieke parameter therapy-identifier moet worden doorgegeven.

Leeg indien niet van toepassing.

classifier

1..1

String

Naam van de interactie-specifieke parameter, waarmee de generieke parameter classifier moet worden doorgegeven.

Leeg indien niet van toepassing.

instance-identifier

1..1

String

Naam van de interactie-specifieke parameter, waarmee de generieke parameter instance-identifier moet worden doorgegeven.

Leeg indien niet van toepassing.

protocol

1..1

String

Mogelijke waarden:

  • "hl7fhir", "hl7v3" en “aorta”.

protocolVersion

1..1

String

Versienummer van het protocol, bijv. "v3" of "R4".

preference

1..1

Integer

Voorkeursnummer voor deze interactie, bijv. “2”.

Wanneer interacties behoren tot eenzelfde groupId en tot eenzelfde protocol, dan geeft preference de voorkeur aan voor welke interactie het best geïnitieerd kan worden indien een ontvanger meerdere interacties ondersteund. Nummer “1” heeft dan de voorkeur boven nummer “2” etc.

De interactietabel bevat nog interacties die een legacy interactionId formaat hanteren. Deze interacties zijn ook opgenomen in het huidige formaat. Deze twee varianten van eenzelfde interactie hanteren eenzelfde preference waarde. Op deze wijze kunnen “synoniemen” worden herkend.

fhir

0..1

Object

Slechts gevuld voor interacties waarvoor het protocol gelijk is aan “hl7fhir” of gelijk is aan “aorta”.

fhir.profile

1..1

String

Protocol is “hl7fhir:

  • Naam van het FHIR-profiel. Bijv. "zib-BloodPressure".

Protocol is “aorta”:

  • Een zelf gekozen, herkenbare, benaming voor de interactie.

fhir.profileVersion

1..1

String

Protocol is “hl7fhir:

Versienummer van het FHIR-profiel.

Indien het versienummer door Nictiz wordt beheerd in een informatiestandaard, dan wordt deze gebruikt. Indien VZVZ het betreffende profiel beheert, dan beheert VZVZ ook het versienummer van het profiel.

Indien Nictiz wel het profiel beheert, maar hierbij geen versienummers hanteert, dan wordt als versienummer “*” gehanteerd.

Protocol is “aorta”:

Versienummer van de interactie. Door VZVZ beheert.

fhir.resourceType

1..1

String

Protocol is “hl7fhir:

  • Het FHIR resourcetype, bijv. "Observation".

Protocol is “aorta”:

  • Waarde is “-”.

fhir.classifier

1..1

String

Protocol is “hl7fhir:

String met één of meerdere classificerende attributen. 

Bijv. "code=http://loinc.org|85354-9" of "code=http://loinc.org|14770-2,code=http://loinc.org|14743-9,code=http://loinc.org|14760-3".

Protocol is “aorta”:

  • Waarde is “-”.

fhir.scopeExtension

0..1

String

Slechts gevuld voor wanneer protocol gelijk is aan “hl7fhir”.

Mogelijke uitbreidingen die moeten worden gedaan op de toegestane SMART on FHIR scope voor deze interactie in het AORTA access_token.

Bijv. “medication.r”. Wanneer de betreffende interactie wordt uitgevoerd m.b.t. een specifieke patiënt, dan zal in deze situatie de string “patient/medication.r” moeten worden toegevoegd aan de scope van het AORTA access_token.

fhir.include

0..1

String

Slechts gevuld voor wanneer protocol gelijk is aan “hl7fhir”.

Eén of meerdere _include parameters die moeten worden toegevoegd aan een interactie.

Slechts toegestaan voor FHIR-search interacties.

Bijv. “_include=Coverage:payor:Patient&_include=Coverage:payor:Organization”

v3

1..1

Object

Bevat informatie voor v3-interacties.

v3.tempateId

1..1

String

ID van de template die in de betreffende v3-interactie wordt gebruikt.

De ID wordt tevens gebruikt als interactionId.

Voor niet-v3-interacties wordt de kolom gevuld met “-”.

Deze kolom is slechts een hulpkolom, zou daarom weggelaten kunnen worden uit de gepubliceerde interactietabel.

parentId

0..n

String

Een batch- of transaction type interactie bestaat uit één of meerdere andere interacties. Een parentId is een interactieId van een batch-of transactietype “parent” interactie waarin de betreffende interactie kan worden toegepast.

interactionIdResponse

0..1

String

Het interaction-id van de response die hoort bij deze interactie. Slechts van toepassing voor hl7v3 interacties.

Naamgevingsbeleid

Naamgeving van AORTA interactietabel configuratiebestanden (per 26 augustus 2025):

<env>-<platform>.<YYYY>.<n>-<topic>-config-<YYYYMMDD>[-v<ordinal>].<ext>

Explanation:

  • env: dev, test, acc, prod

    • Working => test

    • AoF 2024 => prod

  • platform: e.g., AoF

  • YYYY.<sequencenumber>: e.g., 2024.3

  • topic: e.g., interactions

  • YYYYMMDD: e.g., 20250822

  • [-v<ordinal>]: Optional version number for multiple versions published on the same date

    • -v1 is not mentioned! Only v2 and higher are mentioned!

  • ext: .csv

Example: test-AoF.2024.3-interactions-config-20250822-v2.json