Interfaces Resource Broker LOG

Authorization HTTP Header

Subfeature

1.0.0

HTTP Headers

19 Oct 2023

Initiële versie van feature.

AORTA-ID HTTP Header

Subfeature

1.0.0

HTTP Headers

19 Oct 2023

Initiële versie van feature.

AORTA-Version HTTP Header

Subfeature

1.0.0

HTTP Headers

19 Oct 2023

Initiële versie van feature.

AORTA-Version HTTP Header

1.0.0

aorta-AuditEvent

Subfeature

1.0.0

FHIR-profielen

19 Oct 2023

Initiële versie van feature.

searchAuditEvent

Service

1.0.1

Logging

22 Mar 2024

Verhelderd dat toets op geldigheid van access_token en toets op content_type in sommige situaties achterwege mag worden gelaten.

AOF.UC.LOG.100.v2

searchAuditEvent

1.0.1

core-FHIR-interactie-broker

*

*

searchAuditEvent

1.0.1

aorta-AuditEvent

1.0

1.0

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.

Stap

Omschrijving

i

Het systeem controleert of alle vereiste tokens zijn toegevoegd aan het request

Ontbrekend token

statuscode 401 Unauthorized

• In deze situatie wordt geen nadere informatie over de opgetreden fout geretourneerd. In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer", maar zonder foutcode of nadere informatie omtrent de fout geretourneerd. Indien de WWW-Authenticate HTTP response header wordt geproduceerd door de resource broker, dan wordt een realm attribuut met waarde "aorta" toegevoegd.

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

ii

Het systeem controleert de geldigheid van de meegezonden, van toepassing zijnde, tokens

• AORTA access_token, zoals omschreven in de sectie "Toetsing AORTA access_token".

NB. wanneer het verzoek via een intern netwerk wordt ontvangen, en van een component van VZVZ, dan hoeft deze toets niet te worden uitgevoerd.

Ongeldig token

statuscode 401 Unauthorized

• In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer" en een error attribuut met waarde "invalid_token" geretourneerd. Indien de WWW-Authenticate HTTP response header wordt geproduceerd door de resource broker, dan wordt een realm attribuut met waarde "aorta" toegevoegd.

• In deze situatie mag daarnaast ook een OperationOutcome met issue.code "security" worden geretourneerd.

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

iii

Indien van toepassing: Het systeem controleert de samenhang tussen het AORTA access_token en het DigiD authenticatietoken, zoals omschreven in de de sectie "Toetsing van samenhang tussen tokens".

NB. wanneer het verzoek via een intern netwerk wordt ontvangen, en van een component van VZVZ, dan hoeft deze toets niet te worden uitgevoerd.

Ongeldig token

statuscode 401 Unauthorized

• In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer" en een error attribuut met waarde "invalid_token" geretourneerd. Indien de WWW-Authenticate HTTP response header wordt geproduceerd door de resource broker, dan wordt een realm attribuut met waarde "aorta" toegevoegd.

• In deze situatie mag daarnaast ook een OperationOutcome met issue.code "security" worden geretourneerd.

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

1

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

Attribuut

Cardinaliteit

Toelichting

ID van rapporterende applicatie

source.observer

1..1

Referentie naar Device.

Device.identifier bevat het app-id van de rapporterende Resource Broker component.

ID van initiërende organisatie en applicatie (source)

agent.type

1..1

Vaste waarde 110153.

<agent>
    <type>
        <coding>
            <system value="http://dicom.nema.org/resources/ontology/DCM"/>
            <code value="110153"/>
            <display value="Source Role ID"/>
        </coding>
    </type>
    <!-- ... -->
</agent>

agent.who

1..1

Referentie naar Device.

Wanneer een entry betrekking heeft op een A+D log event, dan betreft dit een initiërend GBx-applicatie, en wordt ook een Organization instance meegegeven.

Wanneer een entry betrekking heeft op een B+C log event, dan betreft dit de Resource Broker, en wordt geen Organization instance meegegeven.

Device.identifier bevat het app-id van de verzendende applicatie. Device.owner bevat een referentie naar de hiervoor verantwoordelijke Organization.

Organization.identifier bevat het organisatie-id van de verzendende organisatie, bijvoorbeeld de URA van de verzendende zorgaanbieder.

agent.requestor

1..1

"true"

<requestor value="true"/>

agent.purposeOfUse

0..1

Mogelijk later gaan gebruiken voor noodsituaties.

ID van reagerende organisatie en applicatie (destination)

agent.type

1..1

Vaste waarde 110152.

<agent>
    <type>
        <coding>
            <system value="http://dicom.nema.org/resources/ontology/DCM"/>
            <code value="110152"/>
            <display value="Destination Role ID"/>
        </coding>
    </type>
    <!-- ... -->
</agent>

agent.who

1..1

Referentie naar Device.

Wanneer een entry betrekking heeft op een A+D log event, dan betreft dit de Resource Broker, en wordt geen Organization instance meegegeven.

Wanneer een entry betrekking heeft op een B+C log event, dan betreft dit een reagerende GBx-applicatie, en wordt ook een Organization instance meegegeven.

Device.identifier bevat het app-id van de ontvangende applicatie. Device.owner bevat een referentie naar de hiervoor verantwoordelijke Organization.

Organization.identifier bevat het organisatie-id van de ontvangende organisatie, bijvoorbeeld de URA van de ontvangende zorgaanbieder.

agent.requestor

1..1

"false"

<requestor value="false"/>

interactie-id

type

1..1

"rest" voor RESTful FHIR interacties.

“hl7-v3” voor HL7v3 interacties.

NB. in beide gevallen moet de versie erbij om het juiste CodeSystem te kiezen.

voorbeeld FHIR

"type": {
  "coding": {
    "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "version": "0.5.0",
    "code": "rest"
  }
}

voorbeeld V3

"type": {
  "coding": {
    "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "version": "0.5.0",
    "code": "hl7-v3"
  }
}

subtype

0..*

"read", "create", "update", "search-type" etc.

Voor V3 fixed value “hl7-v3”.

voorbeeld FHIR

"subtype": {
  "coding": {
    "system": "http://hl7.org/fhir/restful-interaction",
    "version": "0.5.0",
    "code": "read"
  }
}

voorbeeld V3

"subtype": {
  "coding": {
    "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "version": "0.5.0",
    "code": "hl7-v3"
  }
}

entity.type

0..1

Indien het om een FHIR-object gaat, dan wordt de ValueSet AuditEventEntityType gebruikt: https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/81466

Indien het om een v3-object gaat, dan wordt het element leeg gelaten

entity.name

1..1

Dit element wordt niet gebruikt, ook al omdat het in R5 verdwijnt.

entity.detail.type

1..1

Bevat het CodeSystem uri van de interactieIDs

Vaste waarde 2.16.840.1.113883.1.6

entity.detail.valueString

1..1

Bevat het interactieID van de v3 of FHIR interactie.

gegevensdienst-id / contextcode

purposeOfEvent

0..1

Het type gegevens (data category) dat wordt uitgewisseld.

Wordt gevuld met de contextCode (AORTA) of met een gegevensdienst-id (MedMij).

system = "2.16.840.1.113883.2.4.3.111.15.1" of "http://vzvz.nl/fhir/NamingSystem/medmij-gegevensdienst"

code = "<contextCode>" of "<gegevensdienst-id>"

Voorbeeld AORTA:

"purposeOfEvent": {
  "coding": {
    "system": "urn:oid:2.16.840.1.113883.2.4.3.111.15.1",
    "code": "MEDGEG",
    "display": "Medicatieproces medicatiegegevens"
  }
}

Voorbeeld MedMij:

"purposeOfEvent": {
  "coding": {
    "system": "http://vzvz.nl/fhir/NamingSystem/medmij-gegevensdienst",
    "code": "50"
  }
}

patiënt

agent.type

1..1

Vaste waarde PAT.

<agent>
    <type>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass"/>
            <code value="PAT"/>
        </coding>
    </type>
    <!-- ... -->
</agent>

agent.who

1..1

Referentie naar Patient. Patient.identifier bevat het BSN van de persoon die onderwerp is van de persoonsgegevens in kwestie.

agent.requestor

1..1

"false" wanneer de AuditEvent betrekking heeft op een interactie waarbij de patiënt zelf niet de opvrager was.

"true" wanneer de AuditEvent betrekking heeft op een interactie waarbij de patiënt zelf wel de opvrager was.

datum en tijd van de activiteit

recorded

1..1

Datum/tijd zoals vastgelegd in de log.

-

period

1..1

Periode tussen ontvangst request en retour response:

• start = verzendtijd van request

• eind = ontvangsttijd van response

resultaat

outcome

1..1

Toegestane waarden zijn:

• 0 - Success

• 4 - Minor failure (statuscode 4xx geretourneerd)

• 8 - Serious failure (statuscode 5xx geretourneerd)

• 12 - Major failure (systeem is niet bereikbaar)

Mapping v3-transactie op codes:

• succes: 0

• AE: 8 

• CE: 12

outcomeDesc

1..1

Wordt gevuld met het volledige result veld uit de messageLog. Bevat dan de geretourneerde HTTP statuscode en eventuele gegenereerde foutcodes.

-

requestID (extension)

1..1

extension.url "http://vzvz.nl/fhir/StructureDefinition/aorta-request-id"

extension.valueString
bevat het requestID dat wordt toegekend aan de betreffende A+D of B+C event (v3: gehele messageID van A of B log, fhir: deel van messageID van A of B log).

-

initialRequestID (extension)

1..1

extension.url "http://vzvz.nl/fhir/StructureDefinition/aorta-trace-id"

extension.valueString
bevat het initialRequestID dat wordt toegekend aan de betreffende A+D en B+C event (v3: messageID van A log, fhir: deel van messageID van A log).

Hiermee kunnen de instances aan elkaar worden gerelateerd.