AORTA interactietabel

groupId

1..1

String

Interacties delen eenzelfde groupId wanneer ze functioneel equivalent zijn.

Formaat:

• <interactionType>:<concept>:<conceptVersion>, OF

• <operationId>:<concept>:<conceptVersion>

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.

InteractionId formaat versie 1.0

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.

InteractionId formaat versie 2.0

Formaat voor “hl7fhir”:

• RESTful interacties:
  <interactionType>:<fhir.profile>:<major van protocolVersion>-x-<major van fhir.profileVersion>

• Custom operations:
  <operationId>:<fhir.profile>:<major van protocolVersion>-<major van OperationVersion>-<major van fhir.profileVersion>

Formaat voor “hl7v3”:

• <v3.tempateId>

Formaat voor “aorta”:

• <operationId>:x-<major van OperationVersion>-x

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”:

• InteractionId formaat versie 1.0:
  Een zelf gekozen, herkenbare, benaming voor de interactie.

• InteractionId formaat versie 2.0:
  ”-”

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”:

• InteractionId formaat versie 1.0:
  Versienummer van de interactie. Door VZVZ beheerd.

• InteractionId formaat versie 2.0:
  ”x”

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.