AORTA interactietabel

Formaat AORTA interactietabel

1.1.0

Formaat AORTA interactietabel

Subfeature

1.1.0

Configuratie

08 Nov 2023

Toevoeging attributen t.b.v. geparameteriseerde $get-aorta-data en geparameteriseerde hybride generieke query.

groupId

0..1

String

Interacties delen eenzelfde groupId wanneer ze functioneel equivalent zijn.

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.

interactionId

1..1

String

interactionType

1..1

String

Mogelijke waarden:

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

direction

1..1

String

Interacties die zijn aangeduid als “push-verkeer” verlopen via de protocol-agnostische push-aorta-data operatie.

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”, “-”.

concept

1..1

String

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

Voor ZIB's gevuld met het ZIB-type, bijv. "PulseRate".

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.

fhir

0..1

Object

Slechts gevuld voor FHIR-interacties.

fhir.profile

1..1

String

Canonical van het FHIR-profiel.

Bijv. "http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure ".

fhir.profileVersion

1..1

String

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.

fhir.resourceType

0..1

String

Bijv. "Observation".

fhir.classifier

0..1

String

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

fhir.scopeExtension

0..1

String

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.