Alle normale interacties met de FHIR Resource Service

FHIR resource service

AuditEvent

Alle foutmeldingen die voorkomen op de FHIR Resource Service

FHIR resource service

AuditEvent op outcome.

Het starten en stoppen van applicatie(instanties).

Applicatie

Tabel AuditEvent

Het starten van een launch

Applicatie

Tabel AuditEvent

Het ontvangen van een launch

Applicatie

Tabel AuditEvent

Het verzenden van een notificatie van een abonnement

FHIR resource service

Tabel AuditEvent

Het ontvangen  van een notificatie van een abonnement

Applicatie

Tabel AuditEvent

Problemen met de verwerking van de gegevens

Applicatie

TOP-KT-012b - FHIR REST Client foutafhandeling

Problemen met het ontvangen van de launch

Applicatie

TOP-KT-012c - Foutafhandeling bij de launch

Event type

Read

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

R

agent.who

De referentie naar de applicatie die de actie uitvoert

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

entity.query

Query parameters in base64Binary formaat

Entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen.

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, deze wordt door de FHIR server bepaald, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Update

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

U

agent.who

De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Delete

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

D

agent.who

De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

{
 "system": "http://hl7.org/fhir/resource-types"
 "code": "OperationOutcome"
 "display": "OperationOutCome"
}

The OperationOutcome wordt alleen getoond in een fout situatie.

entity.what

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

entity.query

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Create

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

C

agent.who

De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Search

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

R

agent.who

De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.what (1)

entity.type (1)

entity.role (1)

entity.query (1)

Query parameters in base64Binary formaat

entity.what (2)

entity.type (2)

entity.query (2)

Query parameters in base64Binary formaat

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Capability

FHIR AuditEvent voor Koppeltaal

RESTful operatie

verantwoordelijke partij

FHIR Resource Provider

type

subtype

action

R

agent.who

De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

{

"reference": "CapabilityStatement/<Capability_id>,
"type": "CapabilityStatement"

}

Dit veld is optioneel

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service.

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Launch

FHIR AuditEvent voor Koppeltaal

Application Launch Activity - Launching

verantwoordelijke partij

Lancerende Applicaties

type

subtype

action

E

agent.who

De referentie naar de applicatie die de actie uitvoert, de lancerende partij, cq de applicatie die veroorzaker is van het Event

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

De referentie naar de applicatie die de launch ontvangt, de ontvangende partij:

Na afstemming met de Technical Community van Koppeltaal wordt hier de referentie naar de Task verwacht. Deze aanpassing wordt eerst in de Technical Community besproken.

{
 "reference": "Device/<id|client_id>"
}

Ent

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Not Used

source.site

De publieke URL van de applicatie waarvandaan de launch gestart wordt. Bijvoorbeeld: https://portal.mijnggz.nl

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de lancerende applicatie. Deze kan opgesteld worden op basis van de client_id:

{
 "reference": "Device/<id|client_id>"
}

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Launched

FHIR AuditEvent voor Koppeltaal

Application Launch Activity - Launched

verantwoordelijke partij

Gelanceerde Applicatie

type

subtype

action

E

agent.who

De referentie naar de applicatie die de actie uitvoert, de ontvangende partij:

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

false

entity.type

entity.what

De referentie naar de applicatie die de actie uitvoert, de ontvangende partij, cq de applicatie die wordt geactiveerd door de launch.

{
 "reference": "Device/<id|client_id>"
}

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Not Used

source.site

De publieke URL van de applicatie waarheen de launch gaat. Bijvoorbeeld: https://module.mijnaanbieder.nl

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de ontvangende applicatie. Deze kan opgesteld worden op basis van de client_id:

{
 "reference": "Device/<id|client_id>"
}

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Send Notification

FHIR AuditEvent voor Koppeltaal

Transmit Record Lifecycle Event

verantwoordelijke partij

FHIR Resource Provider

type

subtype

-

action

E

agent.who (1)

De referentie naar de applicatie die notificatie veroorzaakt.

{
 "reference": "Device/<id|client_id>"
}

agent.type (1)

agent.requestor (1)

True

agent.who (2)

De referentie naar de applicatie naar wie de notificatie wordt verstuurd, cq de applicatie waar naartoe de notificatie wordt verstuurd. De destination

{
 "reference": "Device/<id|client_id>"
}

agent.type (2)

agent.requestor (2)

false

entity.type (1)

entity.what (1)

entity.query (1)

Query parameters in base64Binary formaat

entity.type (2)

entity.what (2)

De referentie van de subscription:

{
 "reference": "Subscription/<id>/_history/<version>"
}

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role (2)

Not Used

entity.query(2)

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie waar de log wordt aangemaakt

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service.

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Receive Notification

FHIR AuditEvent voor Koppeltaal

Transmit Record Lifecycle Event

verantwoordelijke partij

Ontvangende Applicatie

type

subtype

-

action

E

agent.who(1)

De referentie naar de applicatie die notificatie verzendt

{
 "reference": "Device/<id|client_id>"
}

agent.type(1)

agent.requestor(1)

true

agent.who(2)

De referentie naar de applicatie die notificatie ontvangt.

{
 "reference": "Device/<id|client_id>"
}

agent.type(2)

agent.requestor(2)

false

entity.type

entity.what

De referentie van de ontvanger van notificatie:

{
 "reference": "Device/<id|client_id>"
}

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

entity.query

Query parameters in base64Binary formaat

source.site

Base URL van de applicatie de log wordt aangemaakt

source.observer

De device reference van het device dat het event waarneemt. In dit geval is dat de applicatie die de notificatie ontvangt. Deze kan opgesteld worden op basis van de client_id:

{
 "reference": "Device/<id|client_id>"
}

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

Status Change

FHIR AuditEvent voor Koppeltaal

Application Activity

verantwoordelijke partij

Applicatie

type

subtype

action

E

agent.who

De referentie van de applicatie die de status change verstuurt.

{
 "reference": "Device/<id|client_id>"
}

agent.type

agent.requestor

true

entity.type

entity.what

De referentie naar de applicatie:

{
 "reference": "Device/<id|client_id>"
}

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

Not Used

entity.query

Not Used

source.site

Base URL van de applicatie waar de log wordt aangemaakt.

source.observer

De device reference van het device dat het event waarneemt. Deze kan opgesteld worden op basis van de client_id:

{
 "reference": "Device/<id|client_id>"
}

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

Event type

User Authentication

FHIR AuditEvent voor Koppeltaal

User Authentication

verantwoordelijke partij

Authorization Service

type

subtype

action

E

agent.who

1. De referentie naar de autorisatieserver die de authenticatie aanvraagt,

   {
    "reference": "Device/<id|client_id>"
   }

2. (optioneel) De referentie naar de IdP.

agent.type

1. 110153

   {
    "coding" : {
     "system": "http://dicom.nema.org/resources/ontology/DCM"
     "code": "110153"   
     "display": "Source Role ID"
    }
   }

2. 110152 (optioneel)

   {
    "coding" : {
     "system": "http://dicom.nema.org/resources/ontology/DCM"
     "code": "110152"   
     "display": "Destination Role ID"
    }
   }

agent.requestor

1. true

2. false (optioneel)

entity.type

entity.what

FHIR reference to Patient / Practitioner:

{
 "reference" : <Patient | Practitioner>/<id>
}

entity.name

Veld wordt alleen gevuld met de waarde “OperationOutcome” wanneer een fout optreedt bij het verwerken van een event (outcome <>0) Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.role

1 of 15 afhankelijk van Patient of Practioner

{

"system": "http://terminology.hl7.org/CodeSystem/object-role"

"code": "1"

"display": "Patient"

}

{

"system": "http://terminology.hl7.org/CodeSystem/object-role"

"code": "15"

"display": "Practitioner"

}

entity.query

Not Used

source.site

Base URL van de autorisatieserver waar de log wordt aangemaakt.

source.observer

De device reference van de autorisatieserver dat het event waarneemt. Deze kan opgesteld worden op basis van de client_id:

{
 "reference": "Device/<id|client_id>"
}

recorded

Timestamp van vastlegging, bijvoorbeeld: 2024-02-05T12:06:13+0000

FHIR AuditEvent Resource

extension.request-id

0..1

Om één interactie (request of response) eenduidig uniek te kunnen identificeren a.d.h.v. een identifier (X-Request-Id)

De waarde van het X-Request-Id veld, indien de waarde ontbreekt in het originele request moet deze zelf gegenereerd worden.

extension.correlation-id

0..1

De waarde van het X-Correlation-Id veld in het voorgaande request, indien van toepassing.

extension.trace-id

0..1

Om een set interacties te groeperen en eenduidig uniek te kunnen identificeren onder een bepaalde (initiërende) type gebeurtenis a.d.h.v. een traceer identifier (X-Trace-Id).

De waarde van het X-Trace-id veld, indien van toepassing.

extension.resource-origin

0..1

De referentie naar de device van de aanvrager van het request. In het geval van de FHIR resource service wordt dit veld automatisch gevuld door de aanvrager van het request voor alle REST operaties op alle resources. 

Beschrijving van een gebeurtenis.

type

1..1

Identificatie van het type gebeurtenis. Coding met als waardeset het audit-event-type, waarvan met name de volgende sets (of een deel daarvan) worden gebruikt:

• http://terminology.hl7.org/CodeSystem/audit-event-type

• http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle

• http://dicom.nema.org/resources/ontology/DCM

subtype

0..*

Gedetailleerde beschrijving van het type gebeurtenis. Coding met als waardeset AuditEventSub-Type.

Afhankelijk van type gebeurtenis kan dit zijn:

• DICOM Controlled Terminology Definitions: Application Start, Application Stop, etc.

• FHIR Restful Interactions: create, read, vread,  update, delete, search, etc.

action

0..1

Aanduiding van de AuditEventAction bij deze gebeurtenis.

• C - Creëren van data 

• R - Lezen van data

• U - Wijzigen van data

• D - Verwijderen van Data

• E - Starten of stoppen van een proces

period

0..1

De periode waarbinnen de gebeurtenis plaatsvond. Het datatype is Period.

recorded

1..1

Het tijdstip van de gebeurtenis wordt eenduidig en aan het begin van de gebeurtenis vastgelegd, het tijdstip wordt vastgelegd in de UTC tijdzone.

outcome

0..1

Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome, 

• 0: Succes

• 4: Kleine fout

• 8: Serieuze fout

• 12: Fataal

outcomeDesc

0..1

Beschrijving van de melding, indien een foutmelding.

agent

1..*

Identificatie van een gebruiker. Dit kan een persoon, organisatie of applicatie instantie in een informatie systeem representeren. Bij elke gebeurtenis MOET tenminste één gebruiker geïdentificeerd worden.

agent.who

1..1

Identificator van de gebruiker die de gebeurtenis initieert voor de bron van logging. De gebruiker is bij Koppeltaal is dit altijd een Reference naar een Device.

agent.role

0..*

De veiligheidsrol van de agent, met als waardeset SecurityRoleType, waaronder:

• 110150 - Application

• 110151 - Application Launcher

• 110152 - Destination Role ID

• 110153 - Source Role ID

agent.type

1..1

Rol van de gebruiker bij de gebeurtenis van het type ParticipationRoleType, waaronder:

• 110150 - Application

• 110151 - Application Launcher

• 110152 - Destination Role ID

• 110153 - Source Role ID

agent.requestor

1..1

Aanduiding dat deze gebruikers de initiator is van de gebeurtenis.

agent.network

0..1

Dit veld heeft de waarde van Subscription.channel.endpoint

entity

1..*

Identificatie van de betrokken objecten en typen objecten bij deze gebeurtenis. Verschillende typen objecten worden op verschillende wijzen geïdentificeerd. Ter identificatie van de betrokken objecten MOETEN het Identificatortype en Identificator van het object bepaald worden.

entity.type

0..1

Geef het type identificator van het betrokken object weer. Coding met als waardeset AuditEventEntityType.

Dit veld kan gevuld worden met de ResourceType, zoals

• Patient

• Practitioner

• Task

• ....

entity.what

0..1

Geeft een unieke identificator van een bij de gebeurtenis betrokken object weer, afhankelijk van het Identificatortype van het object.

Dit veld kan gevuld worden met de entity referentie, zoals:

• Patient/e7b5f229-8b28-46f7-afef-49cbec94943a

• Practitioner/d86d79aa-8dea-4bfc-8ea2-a247b9e97a7b

• Task/c97e2000-e423-401d-9c25-a1b7e65e5b6d

entity.name

0..1

Nadere aanduiding van het betrokken object. Dit element komt te vervallen in de FHIR R5 Standaard en komt daarom ook in de huidige versie van Koppeltaal te vervallen

entity.description

0..1

Tekst die de entiteit in verder detail beschrijft, in het geval van een OperationOutcome kan hier de beschrijving in gezet worden.

entity.securityLabel

0..*

Toegangscontrole beleid dat specifiek is voor Koppeltaal, dat wordt gebruikt om één of meer autorisatiebeleidsregels af te dwingen.

entity.role

0..1

Code die de categorie (of rol) van het betrokken object weergeeft.

We gebruiken hiervoor de volgende code systemen:

• http://terminology.hl7.org/CodeSystem/object-role,

Voorbeeld: waarde "Query" De inhoud van een query. Dit wordt gebruikt om de inhoud van elke soort query vast te kunnen leggen. Voor beveiligingstoezicht doeleinden is het erg belangrijk om te weten welke vragen er worden gesteld.

entity.lifecycle

0..1

Code die het stadium van het betrokken object weergeeft voor die objecten die een bepaalde levenscyclus kennen.

We gebruiken hiervoor de volgende code systemen:

• DICOM Audit Message Record Lifecycle Events

• ISO 21089-2017 Health Record Lifecycle Events

entity.query

0..1

De feitelijke formulering van een "Query" in geval het betrokken object als categorie "Query" is.

source

source.site

0..1

Domeinnaam van de locatie waar gelogd is.

source.observer

1..1

Unieke identificatie van de bron in het informatiedomein waar de gebeurtenis is gelogd. Een referentie naar het Device, bijvoorbeeld: Device/5aa804f8-0b03-4f02-bbfe-53889893a4bb

source.type

0..*

Type (device) van de bron waar de gebeurtenis gelogd is.