{
"description": "Defines the data structure for audit events in the ePA system.",
"_filename": "StructureDefinition-epa-auditevent.json",
"package_name": "de.gematik.dev.epa",
"date": "2024-07-15",
"derivation": "constraint",
"publisher": "gematik GmbH",
"fhirVersion": "4.0.1",
"name": "EPAAuditEvent",
"abstract": false,
"type": "AuditEvent",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "AuditEvent for the ePA (Elektronische Patientenakte)",
"package_version": "1.1.0-alpha.5",
"status": "active",
"id": "f0682b80-1d4c-4ab1-a6c3-f42eb7fd6338",
"kind": "resource",
"url": "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent",
"version": "1.1.0-rc1",
"differential": {
"element": [ {
"id": "AuditEvent.type",
"path": "AuditEvent.type",
"binding": {
"strength": "required",
"valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs"
}
}, {
"id": "AuditEvent.subtype",
"max": "0",
"path": "AuditEvent.subtype"
}, {
"id": "AuditEvent.action",
"min": 1,
"path": "AuditEvent.action",
"short": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E",
"definition": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E",
"mustSupport": true
}, {
"id": "AuditEvent.period",
"max": "0",
"path": "AuditEvent.period"
}, {
"id": "AuditEvent.recorded",
"path": "AuditEvent.recorded",
"mustSupport": true
}, {
"id": "AuditEvent.outcome",
"min": 1,
"path": "AuditEvent.outcome",
"short": "success: 0; failure: 4; major failure: 12",
"definition": "success: 0; failure: 4; major failure: 12",
"mustSupport": true
}, {
"id": "AuditEvent.outcomeDesc",
"max": "0",
"path": "AuditEvent.outcomeDesc"
}, {
"id": "AuditEvent.purposeOfEvent",
"max": "0",
"path": "AuditEvent.purposeOfEvent"
}, {
"id": "AuditEvent.agent",
"path": "AuditEvent.agent",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "type",
"type": "pattern"
} ]
},
"mustSupport": true
}, {
"id": "AuditEvent.agent.type",
"min": 1,
"path": "AuditEvent.agent.type",
"mustSupport": true
}, {
"id": "AuditEvent.agent.requestor",
"path": "AuditEvent.agent.requestor",
"fixedBoolean": false
}, {
"id": "AuditEvent.agent.location",
"max": "0",
"path": "AuditEvent.agent.location"
}, {
"id": "AuditEvent.agent.policy",
"max": "0",
"path": "AuditEvent.agent.policy"
}, {
"id": "AuditEvent.agent.media",
"max": "0",
"path": "AuditEvent.agent.media"
}, {
"id": "AuditEvent.agent.network",
"max": "0",
"path": "AuditEvent.agent.network"
}, {
"id": "AuditEvent.agent:user",
"max": "1",
"min": 0,
"path": "AuditEvent.agent",
"sliceName": "user",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.extension:healthcareFacilityType",
"max": "1",
"min": 0,
"path": "AuditEvent.agent.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension" ]
} ],
"sliceName": "healthcareFacilityType",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.type",
"path": "AuditEvent.agent.type",
"binding": {
"strength": "required",
"valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-participation-role-type-user-vs"
}
}, {
"id": "AuditEvent.agent:user.role",
"path": "AuditEvent.agent.role",
"short": "Professional role of the service provider",
"binding": {
"strength": "required",
"valueSet": "https://simplifier.net/gem-terminology/epa-ehealth-dsi-healthcare-facility-type-vs"
},
"definition": "Professional role of the service provider",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.role.coding",
"path": "AuditEvent.agent.role.coding",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.role.coding.system",
"min": 1,
"path": "AuditEvent.agent.role.coding.system",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.role.coding.code",
"min": 1,
"path": "AuditEvent.agent.role.coding.code",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.role.coding.display",
"path": "AuditEvent.agent.role.coding.display",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.who",
"path": "AuditEvent.agent.who",
"short": "The subject Id of the IDToken",
"definition": "The subject Id of the IDToken",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.who.identifier",
"min": 1,
"path": "AuditEvent.agent.who.identifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id", "http://fhir.de/StructureDefinition/identifier-kvid-10" ]
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.altId",
"path": "AuditEvent.agent.altId",
"short": "Alternative User identity (e.g. Telematik-ID or the KVNR)",
"definition": "Alternative User identity (e.g. Telematik-ID or the KVNR)",
"mustSupport": true
}, {
"id": "AuditEvent.agent:user.name",
"min": 1,
"path": "AuditEvent.agent.name",
"short": "Name of HCP or Insurant",
"definition": "Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/' "
}, {
"id": "AuditEvent.agent:client",
"max": "1",
"min": 0,
"path": "AuditEvent.agent",
"sliceName": "client",
"mustSupport": true
}, {
"id": "AuditEvent.agent:client.type",
"path": "AuditEvent.agent.type",
"binding": {
"strength": "required",
"valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-participation-role-type-client-vs"
}
}, {
"id": "AuditEvent.agent:client.role",
"path": "AuditEvent.agent.role",
"mustSupport": true
}, {
"id": "AuditEvent.agent:client.who",
"min": 1,
"path": "AuditEvent.agent.who",
"short": "The subject Id of the IDToken",
"definition": "The subject Id of the IDToken",
"mustSupport": true
}, {
"id": "AuditEvent.agent:client.who.identifier",
"min": 1,
"path": "AuditEvent.agent.who.identifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id" ]
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent:client.altId",
"path": "AuditEvent.agent.altId",
"short": "Alternative client identity (e.g. Telematik-ID))",
"definition": "Alternative client identity (e.g. Telematik-ID)",
"mustSupport": true
}, {
"id": "AuditEvent.agent:client.name",
"min": 1,
"path": "AuditEvent.agent.name",
"short": "Name of a service e.g. eRezept, EU access/country name or DiGA",
"definition": "Name of a service e.g. eRezept, EU access/country name or DiGA"
}, {
"id": "AuditEvent.source",
"path": "AuditEvent.source",
"mustSupport": true
}, {
"id": "AuditEvent.source.observer.display",
"path": "AuditEvent.source.observer.display",
"fixedString": "Elektronische Patientenakte Fachdienst"
}, {
"id": "AuditEvent.source.type",
"max": "1",
"min": 1,
"path": "AuditEvent.source.type",
"binding": {
"strength": "required",
"valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs"
},
"mustSupport": true
}, {
"id": "AuditEvent.entity",
"min": 1,
"path": "AuditEvent.entity",
"mustSupport": true
}, {
"id": "AuditEvent.entity.what",
"max": "0",
"path": "AuditEvent.entity.what"
}, {
"id": "AuditEvent.entity.type",
"max": "0",
"path": "AuditEvent.entity.type"
}, {
"id": "AuditEvent.entity.role",
"max": "0",
"path": "AuditEvent.entity.role"
}, {
"id": "AuditEvent.entity.lifecycle",
"max": "0",
"path": "AuditEvent.entity.lifecycle"
}, {
"id": "AuditEvent.entity.securityLabel",
"max": "0",
"path": "AuditEvent.entity.securityLabel"
}, {
"id": "AuditEvent.entity.name",
"path": "AuditEvent.entity.name",
"short": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).",
"definition": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).",
"mustSupport": true
}, {
"id": "AuditEvent.entity.description",
"path": "AuditEvent.entity.description",
"short": "The OperationId",
"definition": "The OperationId",
"mustSupport": true
}, {
"id": "AuditEvent.entity.query",
"max": "0",
"path": "AuditEvent.entity.query"
}, {
"id": "AuditEvent.entity.detail",
"path": "AuditEvent.entity.detail",
"mustSupport": true
}, {
"id": "AuditEvent.entity.detail.type",
"path": "AuditEvent.entity.detail.type",
"short": "The Name of the property (e.g. Document Format, DocumentID, ...).",
"definition": "The Name of the property (e.g. Document Format, DocumentID, ...).",
"mustSupport": true
}, {
"id": "AuditEvent.entity.detail.value[x]",
"path": "AuditEvent.entity.detail.value[x]",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"path": "AuditEvent.entity.detail.value[x]",
"min": 1,
"definition": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)",
"short": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)",
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"sliceName": "valueString",
"max": "1",
"id": "AuditEvent.entity.detail.value[x]:valueString"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent"
}