AuditEvent

See FHIR specification

Managed Resource

The AuditEvent resource is managed by the MIDATA platform. It is not possible to create or update AuditEvents using the API.

Each security relevant event on the platform creates an AuditEvent resource. AuditEvent resources may be read by all actors referenced in the AuditEvent and by administrators.

Semantical type

The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name AuditEvent into your applications access filter if you need to use this resource.

Resource owner

As the resource is completely managed by the platform there is no resource owner.

Example resource

{
  "resourceType": "AuditEvent",
  "id": "62e106d75c45ff5213c49b7f",
  "type": {
    "system": "http://dicom.nema.org/resources/ontology/DCM",
    "code": "110114",
    "display": "User Authentication"
  },
  "subtype": [
    {
      "system": "http://dicom.nema.org/resources/ontology/DCM",
      "code": "110122",
      "display": "Login"
    }
  ],
  "action": "E",
  "recorded": "2022-07-27T11:35:19.437+02:00",
  "outcome": "0",
  "agent": [
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://midata.coop/codesystems/user-role",
              "code": "MEMBER"
            }
          ]
        }
      ],
      "who": {
        "reference": "Patient/56ded6c179c7214042b29984"
      },
      "altId": "hugo.beispiel@example.com",
      "name": "Hugo Beispiel",
      "requestor": true
    },
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://dicom.nema.org/resources/ontology/DCM",
              "code": "110150"
            }
          ]
        }
      ],
      "who": {
        "identifier": {
          "value": "615db7aa9f50fe04abb22184"
        }
      },
      "name": "My test app"
    }
  ]
}

Read

Read a single AuditEvent by id.

Request:

[GET] /fhir/AuditEvent/<id>

Search for resources of type AuditEvent

Request:

[GET] /fhir/AuditEvent?searchParams

List of supported search parameters:

Supported query parameters:

Name Type Description
_id string The resource identity
_lastUpdated date Only return resources which were last updated as specified by the given range
_page string  
action token Type of action performed during the event
address string Identifier for the network access point of the user device
agent reference Direct reference to resource
agent-name string Human-meaningful name for the agent
agent-role token Agent role in the event
altid token Alternative User id e.g. authentication
date date Time when the event occurred on source
entity reference Specific instance of resource
entity-id token Specific instance of object
entity-name string Descriptor for entity
entity-role token What role the entity played
entity-type token Type of entity involved
outcome token Whether the event succeeded or failed
patient reference Direct reference to resource
policy uri Policy that authorized event
site token Logical source location within the enterprise
source token The identity of source detecting the event
subtype token More specific type/id for the event
type token Type/identifier of event
user token Unique identifier for the user