Not Used
| Expand | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
Koppeltaal maakt gebruik van de Trace Context standaard om de gebeurtenissen over verschillende systemen te kunnen volgen. Dit houdt in dat er drie headers worden gebruikt in elk request die het mogelijk maken een keten van AuditEvents te kunnen creëren die verschillende gebeurtenissen over systemen kunnen vastleggen, namelijk de X-Request-id, X-Trace-id en X-Correlation-id. Deze doen zich met name voor in de volgende situaties:
...
Gebeurtenis | Verantwoordelijkheid | Beschreven in |
|---|---|---|
Alle normale interacties met de FHIR Resource Service | FHIR resource service | |
Alle foutmeldingen die voorkomen op de FHIR Resource Service | FHIR resource service | AuditEvent op outcome. |
Het starten en stoppen van applicatie(instanties). | Applicatie | |
Het starten van een launch | Applicatie | |
Het ontvangen van een launch | Applicatie | |
Het verzenden van een notificatie van een abonnement | FHIR resource service | |
Het ontvangen van een notificatie van een abonnement | Applicatie | |
Problemen met de verwerking van de gegevens | Applicatie | |
Problemen met het ontvangen van de launch | Applicatie |
...
De X-Request-Id kan het beste gezien worden als een unieke request ID voor alle requests die in koppeltaal plaatsvinden. In asynchrone en/of notificaties kan er een hiërarchie van requests gemaakt worden door steeds een nieuw request ID voor elk request te maken, en de ontvangen request ID als bovenliggend request in het X-Correlation-Id in te vullenis een unieke identifiër en wordt gecreëerd en ongewijzigd meegegeven met de response van de request. De X-Trace-id is ook een unieke identifier die aan een request wordt gegeven, deze wijkt af in hoe deze wordt doorgegeven; deze waarde moet, indien gevuld, ongewijzigd doorgegeven worden.
...
| Drawio sketch | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Drawio sketch | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Read | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| |||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert
| ||
|
| ||
|
| ||
|
| ||
|
| ||
| Query parameters in base64Binary formaat | ||
|
| ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, deze wordt door de FHIR server bepaald, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Update | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| |||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
| Not Used | ||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Delete | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
De OperationOutcome wordt alleen getoond in een fout situatie. | ||
|
| ||
|
| ||
| |||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Create | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
| Not Used | ||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Search | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
| Query parameters in base64Binary formaat | ||
|
| ||
entity.type (2) |
| ||
entity.query (2) | Query parameters in base64Binary formaat | ||
| | ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Capability | ||
FHIR AuditEvent voor Koppeltaal | RESTful operatie | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
|
| ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die de actie uitvoert, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
| ||
| { "reference": "CapabilityStatement " "display/<Capability_id>, "CapabilityStatement" } |
| Not UsedDit veld is optioneel |
|
| ||
| Not Used | ||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie waar de log wordt aangemaakt. In dit geval is dat de base URL van de fhir-service. | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Launch | ||
FHIR AuditEvent voor Koppeltaal | Application Launch Activity - Launching | ||
verantwoordelijke partij | Lancerende Applicaties | ||
|
| ||
|
| ||
|
| ||
| |||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| Een voor de gebruiker gebruikelijke tekst moet hier worden opgeslagen. Zie ook: | ||
| De referentie naar de applicatie die de actie uitvoert, de lancerende partij, cq de applicatie die veroorzaker is van het Event
| ||
|
| ||
|
| ||
|
| ||
| 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.
Ent | ||
entity.name |
| ||
| Not Used | ||
| Not Used | ||
| De publieke URL van de applicatie waarvandaan de launch gestart wordt. Bijvoorbeeld: https://portal.mijnggz.nl | ||
| 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:
| ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Launched | ||
FHIR AuditEvent voor Koppeltaal | Application Launch Activity - Launched | ||
verantwoordelijke partij | Gelanceerde Applicatie | ||
|
| ||
|
| ||
|
| ||
| |||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| Een voor de gebruiker gebruikelijke tekst moet hier worden opgeslagen. Zie ook: | ||
| De referentie naar de applicatie die de actie uitvoert, de ontvangende partij:
| ||
|
| ||
|
| ||
|
| ||
| De referentie naar de applicatie die de actie uitvoert, de ontvangende partij, cq de applicatie die wordt geactiveerd door de launch.
| ||
|
| ||
| Not Used | ||
| Not Used | ||
| De publieke URL van de applicatie waarheen de launch gaat. Bijvoorbeeld: https://module.mijnaanbieder.nl | ||
| 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:
| ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Send Notification | ||
FHIR AuditEvent voor Koppeltaal | Transmit Record Lifecycle Event | ||
verantwoordelijke partij | FHIR Resource Provider | ||
|
| ||
| - | ||
| E
| ||
| - | ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
agent.who (1) | De referentie naar de applicatie die notificatie veroorzaakt.
| ||
agent.type (1) |
| ||
|
| ||
| De referentie naar de applicatie naar wie de notificatie wordt verstuurd, cq de applicatie waar naartoe de notificatie wordt verstuurd. De destination
| ||
|
| ||
|
| ||
entity.type (1) |
| ||
entity.what (1) |
| ||
entity.query (1) | Query parameters in base64Binary formaat | ||
|
| ||
| De referentie van de subscription:
| ||
|
| ||
| Not Used | ||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie waar de log wordt aangemaakt | ||
| De device reference van het device dat het event waarneemt. In dit geval is dat de fhir-resource service. | ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Receive Notification | ||
FHIR AuditEvent voor Koppeltaal | Transmit Record Lifecycle Event | ||
verantwoordelijke partij | Ontvangende Applicatie | ||
|
| ||
| - | ||
|
| ||
| |||
| - | ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie naar de applicatie die notificatie verzendt
| ||
|
| ||
|
| ||
| De referentie naar de applicatie die notificatie ontvangt.
| ||
|
| ||
|
| ||
|
| ||
| De referentie van de ontvanger van notificatie:
| ||
|
| ||
|
| ||
| Query parameters in base64Binary formaat | ||
| Base URL van de applicatie de log wordt aangemaakt | ||
| 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:
| ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||
|---|---|---|---|
Event type | Status Change | ||
FHIR AuditEvent voor Koppeltaal | Application Activity | ||
verantwoordelijke partij | Applicatie | ||
|
| ||
|
| ||
|
| ||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||
| De referentie van de applicatie die de status change verstuurt.
| ||
|
| ||
|
| ||
|
| ||
| De referentie naar de applicatie:
| ||
|
| ||
| Not Used | ||
| Not Used | ||
| Base URL van de applicatie waar de log wordt aangemaakt. | ||
| De device reference van het device dat het event waarneemt. Deze kan opgesteld worden op basis van de client_id:
| ||
| Timestamp van vastlegging, bijvoorbeeld: |
...
Veld | Waarde | ||||
|---|---|---|---|---|---|
Event type | User Authentication | ||||
FHIR AuditEvent voor Koppeltaal | User Authentication | ||||
verantwoordelijke partij | Authorization Service | ||||
|
| ||||
|
| ||||
|
| ||||
| Indicatie van het resultaat van de gebeurtenis van het type AuditEventOutcome,
| ||||
| De beschrijving van de fout in het geval de outcome <> 0. Voor de correcte weergave van de foutmelding wordt verwezen naar: | ||||
|
| ||||
|
| ||||
|
| ||||
|
| ||||
| FHIR reference to Patient / Practitioner:
| ||||
|
| ||||
|
{
} {
} | ||||
| Not Used | ||||
| Base URL van de autorisatieserver waar de log wordt aangemaakt. | ||||
| De device reference van de autorisatieserver dat het event waarneemt. Deze kan opgesteld worden op basis van de client_id:
| ||||
| Timestamp van vastlegging, bijvoorbeeld: |
...
FHIR AuditEvent Resource | |||||
Element | Card | Omschrijving | Voorbeeld | ||
|---|---|---|---|---|---|
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: |
| ||
subtype | 0..* | Gedetailleerde beschrijving van het type gebeurtenis. Coding met als waardeset AuditEventSub-Type. Afhankelijk van type gebeurtenis kan dit zijn:
|
| ||
action | 0..1 | Aanduiding van de AuditEventAction bij deze gebeurtenis.
|
| ||
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,
|
| ||
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:
| |||
agent.type | 1..1 | Rol van de gebruiker bij de gebeurtenis van het type ParticipationRoleType, waaronder:
| |||
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
| |||
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:
| |||
| 0..1 |
| |||
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: 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: |
| ||
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. | |||
...