FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/epa-audit-event-server

Packagede.gematik.epa
Resource TypeCapabilityStatement
Idepa-audit-event-server
FHIR VersionR4
Sourcehttps://gematik.de/fhir/epa/https://simplifier.net/resolve?scope=de.gematik.epa@1.1.5&canonical=https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-server
URLhttps://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-server
Version1.1.5
Statusactive
Date2025-05-28
NameEPAAuditEventServer
TitleEPA Capability Statement für den Audit Event Service
Realmde
DescriptionEPA Capability Statement für den Audit Event Service
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
epa-basic-serverEPA Basic Server
StructureDefinition
epa-auditeventEPA AuditEvent

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement epa-audit-event-server

EPA Capability Statement für den Audit Event Service

  • Implementation Guide Version: 1.1.5
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Supported Patch Formats:
  • Published on: 2025-05-28
  • Published by: gematik GmbH

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

This CapabilityStatement imports the CapabilityStatement EPA Basic Server

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AuditEventhttps://gematik.de/fhir/epa/StructureDefinition/epa-auditevent
Additional supported profiles:
  EPA AuditEvent
yy_id, _lastUpdated, action, altid, date, outcome, entity-name, agent-name, type

Resource Conformance: SHALL AuditEvent

Base System Profile
EPA AuditEvent
Profile Conformance
SHALL
Reference Policy

Supported Profiles

EPA AuditEvent

Interaction summary
  • SHALL support search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Resource.id

SHALL_lastUpdateddate

Resource.meta.lastUpdated

SHALLactiontoken

AuditEvent.action

SHALLaltidtoken

AuditEvent.agent.altId

SHALLdatedate

AuditEvent.recorded

SHALLoutcometoken

AuditEvent.outcome

SHALLentity-namestring

AuditEvent.entity.name

SHALLagent-namestring

AuditEvent.agent.name

SHALLtypetoken

AuditEvent.type

 

Source

{
  "resourceType": "CapabilityStatement",
  "id": "epa-audit-event-server",
  "meta": {
    "profile": [
      "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "extension": [
        {
          "url": "name",
          "valueString": "X-Request-ID"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "UUID of the request message"
        },
        {
          "url": "format",
          "valueString": "uuid"
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueString": "x-insurantid"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "Health Record Identifier"
        },
        {
          "url": "pattern",
          "valueString": "^[A-Z]{1}\\d{9}[%content%]quot;
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueString": "x-useragent"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "user agent information"
        },
        {
          "url": "pattern",
          "valueString": "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}[%content%]quot;
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Request does not match schema"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "invalAuth"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Requestor has no valid entitlement"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "notEntitled"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Requestor role is not in the list of allowed user groups"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "invalidOid"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Device registration does not exist"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "unregisteredDevice"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "404"
        },
        {
          "url": "description",
          "valueString": "Health record is in state UNKNOWN or INITIALIZED"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "noHealthRecord"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "409"
        },
        {
          "url": "description",
          "valueString": "Health record is in state SUSPENDED"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "statusMismatch"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "500"
        },
        {
          "url": "description",
          "valueString": "Any other error"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "internalError"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-base-url",
      "valueString": "http://epa4all/epa/audit/api/v1/fhir"
    }
  ],
  "url": "https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-server",
  "version": "1.1.5",
  "name": "EPAAuditEventServer",
  "title": "EPA Capability Statement für den Audit Event Service",
  "status": "active",
  "date": "2025-05-28",
  "publisher": "gematik GmbH",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gematik.de"
        }
      ]
    }
  ],
  "description": "EPA Capability Statement für den Audit Event Service",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "DE"
        }
      ]
    }
  ],
  "kind": "requirements",
  "imports": [
    "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server"
  ],
  "_imports": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "AuditEvent",
          "profile": "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent",
          "_profile": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode": "SHALL"
              }
            ]
          },
          "supportedProfile": [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent"
          ],
          "_supportedProfile": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "200"
                    },
                    {
                      "url": "description",
                      "valueString": "Successful operation"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "400"
                    },
                    {
                      "url": "description",
                      "valueString": "Unknown search parameter"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_PARAM_UNKNOWN"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "400"
                    },
                    {
                      "url": "description",
                      "valueString": "Invalid query parameter(s)"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_BAD_SYNTAX"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "400"
                    },
                    {
                      "url": "description",
                      "valueString": "Invalid request"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_BAD_FORMAT"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "404"
                    },
                    {
                      "url": "description",
                      "valueString": "Unknown resource type"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_UNKNOWN_TYPE"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "200"
                    },
                    {
                      "url": "description",
                      "valueString": "Successful operation"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "400"
                    },
                    {
                      "url": "description",
                      "valueString": "Invalid request"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_BAD_FORMAT"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "404"
                    },
                    {
                      "url": "description",
                      "valueString": "Unknown resource type"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_UNKNOWN_TYPE"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                },
                {
                  "extension": [
                    {
                      "url": "statusCode",
                      "valueString": "404"
                    },
                    {
                      "url": "description",
                      "valueString": "Resource is not known"
                    },
                    {
                      "url": "responseType",
                      "valueString": "TIOperationOutcome"
                    },
                    {
                      "url": "errorCode",
                      "valueString": "MSG_RESOURCE_ID_FAIL"
                    }
                  ],
                  "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
                }
              ],
              "code": "read"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Resource.id"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "Resource.meta.lastUpdated"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "action",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
              "type": "token",
              "documentation": "AuditEvent.action"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "altid",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
              "type": "token",
              "documentation": "AuditEvent.agent.altId"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
              "type": "date",
              "documentation": "AuditEvent.recorded"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "outcome",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
              "type": "token",
              "documentation": "AuditEvent.outcome"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "entity-name",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name",
              "type": "string",
              "documentation": "AuditEvent.entity.name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "agent-name",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
              "type": "string",
              "documentation": "AuditEvent.agent.name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
              "type": "token",
              "documentation": "AuditEvent.type"
            }
          ]
        }
      ]
    }
  ]
}