{ "resourceType": "StructureDefinition", "id": "AuditEvent", "text": { "status": "extensions", "div": "

Generated Narrative: StructureDefinition AuditEvent

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" AuditEvent 0..*AuditEventEvent record kept for security purposes
\".\"\".\"\".\" type 1..1CodingHigh level grouping of the message types. E.g. PSIS Query
\".\"\".\"\".\"\".\" system 1..1uriIdentity of the terminology system
Required Pattern: https://fhir.nhs.uk/Id/productId
\".\"\".\"\".\" Slices for subtype 1..*CodingMore specific type/id for the event
Slice: Unordered, Closed by pattern:system
\".\"\".\"\".\"\".\" subtype:All Slices Content/Rules for all slices
\".\"\".\"\".\"\".\"\".\" system 1..1uriIdentity of the terminology system
\".\"\".\"\".\"\".\"\".\" code 1..1codeSymbol in syntax defined by the system
\".\"\".\"\".\"\".\" subtype:interactionId 1..1CodingHL7V3 identifier, for FHIR there is no standard. E.g. PORX_IN020101UK04
\".\"\".\"\".\"\".\"\".\" system 0..1uriIdentity of the terminology system
Required Pattern: https://fhir.nhs.uk/Id/nhsServiceInteractionId
\".\"\".\"\".\"\".\"\".\" display 0..1stringHuman readable interactionID. E.g. Parent Prescription
\".\"\".\"\".\" action 1..1codeType of action performed during the event
\".\"\".\"\".\" recorded S1..1instantTime when the event was recorded
\".\"\".\"\".\" Slices for agent 1..*BackboneElementActor involved in the event
Slice: Unordered, Closed by pattern:who.identifier.system
\".\"\".\"\".\"\".\" agent:All Slices Content/Rules for all slices
\".\"\".\"\".\"\".\"\".\" who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
\".\"\".\"\".\"\".\"\".\"\".\" identifier 1..1IdentifierLogical reference, when literal reference is not known
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 1..1uriThe namespace for the identifier value
\".\"\".\"\".\"\".\"\".\"\".\"\".\" value 1..1stringThe value that is unique
\".\"\".\"\".\"\".\"\".\"\".\" display 1..1stringText alternative for the resource
\".\"\".\"\".\"\".\" agent:organisation 1..2BackboneElementActor involved in the event
\".\"\".\"\".\"\".\"\".\" who
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
\".\"\".\"\".\"\".\"\".\"\".\"\".\" value 0..1stringODS code of the organisation. E.g. X26
\".\"\".\"\".\"\".\"\".\"\".\" display 0..1stringName of the organisation
\".\"\".\"\".\"\".\" agent:accreditedSystemId 0..1BackboneElementTODO This is an Endpoint identifier, move to organisation?
\".\"\".\"\".\"\".\"\".\" who
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/spine-ASID
\".\"\".\"\".\"\".\"\".\"\".\"\".\" value 0..1stringSpine Accredited System Id
\".\"\".\"\".\"\".\" agent:user 0..1BackboneElementActor involved in the event
\".\"\".\"\".\"\".\"\".\" who
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/sds-user-id
\".\"\".\"\".\"\".\"\".\"\".\"\".\" value 0..1stringUser identifier. E.g. 1234567890
\".\"\".\"\".\"\".\"\".\"\".\" display 0..1stringUser Name
\".\"\".\"\".\"\".\" agent:userRole 0..1BackboneElementActor involved in the event
\".\"\".\"\".\"\".\"\".\" who
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/sds-role-profile-id
\".\"\".\"\".\"\".\"\".\"\".\"\".\" value 0..1stringRole Profile ID of the user
\".\"\".\"\".\" source 1..1BackboneElementI think this is endpoint instance (Device) which created the audit
\".\"\".\"\".\"\".\" observer
\".\"\".\"\".\"\".\"\".\" display 1..1stringAudit Creator Name (the system which has generated the event)
\".\"\".\"\".\"\".\" type
\".\"\".\"\".\"\".\"\".\" system 1..1uriAudit Creator system Identifier
\".\"\".\"\".\"\".\"\".\" code 1..1codeAudit Creator Identifier code
\".\"\".\"\".\" Slices for entity 3..*BackboneElementData or objects used
Slice: Unordered, Closed by pattern:type
\".\"\".\"\".\"\".\" entity:All Slices Content/Rules for all slices
\".\"\".\"\".\"\".\"\".\" what 1..1Reference(Resource)Specific instance of resource
\".\"\".\"\".\"\".\"\".\"\".\" identifier 1..1IdentifierLogical reference, when literal reference is not known
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 1..1uriThe namespace for the identifier value
\".\"\".\"\".\"\".\"\".\" type 1..1CodingType of entity involved
\".\"\".\"\".\"\".\" entity:patient 1..1BackboneElementData or objects used
\".\"\".\"\".\"\".\"\".\" what 0..1Reference(Resource)Patient NHS Number
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/nhs-number
\".\"\".\"\".\"\".\"\".\" type 0..1CodingType of entity involved
Required Pattern: At least the following
\".\"\".\"\".\"\".\"\".\"\".\" system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
\".\"\".\"\".\"\".\"\".\"\".\" code1..1codeSymbol in syntax defined by the system
Fixed Value: Patient
\".\"\".\"\".\"\".\" entity:endpoint 1..1BackboneElementData or objects used
\".\"\".\"\".\"\".\"\".\" what 0..1Reference(Resource)Endpoint details
\".\"\".\"\".\"\".\"\".\"\".\" identifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" system 0..1uriThe namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/spine-ASID
\".\"\".\"\".\"\".\"\".\" type 0..1CodingType of entity involved
Required Pattern: At least the following
\".\"\".\"\".\"\".\"\".\"\".\" system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
\".\"\".\"\".\"\".\"\".\"\".\" code1..1codeSymbol in syntax defined by the system
Fixed Value: Endpoint
\".\"\".\"\".\"\".\"\".\" name 1..1stringHuman readable interactionID. E.g. Parent Prescription
\".\"\".\"\".\"\".\"\".\" Slices for detail 2..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by pattern:type
\".\"\".\"\".\"\".\"\".\"\".\" detail:interactionIdentifier 1..1BackboneElementHL7V3 identifier, for FHIR there is no standard
\".\"\".\"\".\"\".\"\".\"\".\"\".\" type 1..1stringName of the property
Required Pattern: productIdentitifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" Slices for value[x] 1..1stringProperty value
Slice: Unordered, Open by type:$this
\".\"\".\"\".\"\".\"\".\"\".\"\".\"\".\" value[x]:valueString 1..1stringProperty value
\".\"\".\"\".\"\".\"\".\"\".\" detail:productIdentifier 1..1BackboneElementHigh level grouping of the message types
\".\"\".\"\".\"\".\"\".\"\".\"\".\" type 1..1stringName of the property
Required Pattern: productIdentifier
\".\"\".\"\".\"\".\"\".\"\".\"\".\" Slices for value[x] 1..1stringProperty value
Slice: Unordered, Open by type:$this
\".\"\".\"\".\"\".\"\".\"\".\"\".\"\".\" value[x]:valueString 1..1stringProperty value
\".\"\".\"\".\"\".\" entity:transaction 1..1BackboneElementData or objects used
\".\"\".\"\".\"\".\"\".\" what 0..1Reference(Resource)Transaction Id, Correlation Id or X-RequestID
\".\"\".\"\".\"\".\"\".\" type 0..1CodingType of entity involved
Required Pattern: At least the following
\".\"\".\"\".\"\".\"\".\"\".\" system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
\".\"\".\"\".\"\".\"\".\"\".\" code1..1codeSymbol in syntax defined by the system
Fixed Value: XrequestId

\"doco\" Documentation for this format
" }, "url": "https://fhir.nhs.uk/Sandbox/DDD/England/StructureDefinition/AuditEvent", "version": "0.0.1-current", "name": "AuditEvent", "title": "AuditEvent - Patient Audit Record Service", "status": "draft", "date": "2024-09-10T15:01:34+00:00", "publisher": "NHS England", "contact": [ { "telecom": [ { "system": "url", "value": "https://www.ihe.net/ihe_domains/it_infrastructure/" } ] }, { "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] }, { "name": "NHS England", "telecom": [ { "system": "email", "value": "iti@ihe.net" } ] } ], "description": "The Patient Audit Record Service (PARS) is a reporting service that describes how patient data has been accessed. This service is used by guardians of data e.g. Privacy officers to track and monitor requests to access patient records.", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "dicom", "uri": "http://nema.org/dicom", "name": "DICOM Tag Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "w3c.prov", "uri": "http://www.w3.org/ns/prov", "name": "W3C PROV" }, { "identity": "fhirprovenance", "uri": "http://hl7.org/fhir/provenance", "name": "FHIR Provenance Mapping" } ], "kind": "resource", "abstract": false, "type": "AuditEvent", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent", "derivation": "constraint", "differential": { "element": [ { "id": "AuditEvent.type", "path": "AuditEvent.type", "short": "High level grouping of the message types. E.g. PSIS Query" }, { "id": "AuditEvent.type.system", "path": "AuditEvent.type.system", "min": 1, "patternUri": "https://fhir.nhs.uk/Id/productId" }, { "id": "AuditEvent.subtype", "path": "AuditEvent.subtype", "slicing": { "discriminator": [ { "type": "pattern", "path": "system" } ], "rules": "closed" }, "min": 1 }, { "id": "AuditEvent.subtype.system", "path": "AuditEvent.subtype.system", "min": 1 }, { "id": "AuditEvent.subtype.code", "path": "AuditEvent.subtype.code", "min": 1 }, { "id": "AuditEvent.subtype:interactionId", "path": "AuditEvent.subtype", "sliceName": "interactionId", "short": "HL7V3 identifier, for FHIR there is no standard. E.g. PORX_IN020101UK04", "min": 1, "max": "1" }, { "id": "AuditEvent.subtype:interactionId.system", "path": "AuditEvent.subtype.system", "patternUri": "https://fhir.nhs.uk/Id/nhsServiceInteractionId" }, { "id": "AuditEvent.subtype:interactionId.display", "path": "AuditEvent.subtype.display", "short": "Human readable interactionID. E.g. Parent Prescription" }, { "id": "AuditEvent.action", "path": "AuditEvent.action", "min": 1 }, { "id": "AuditEvent.recorded", "path": "AuditEvent.recorded", "definition": "DateTime the event happened. In Spine this is derived from the internalID, in PARS it will be its own field", "mustSupport": true }, { "id": "AuditEvent.agent", "path": "AuditEvent.agent", "slicing": { "discriminator": [ { "type": "pattern", "path": "who.identifier.system" } ], "rules": "closed" } }, { "id": "AuditEvent.agent.who", "path": "AuditEvent.agent.who", "min": 1 }, { "id": "AuditEvent.agent.who.identifier", "path": "AuditEvent.agent.who.identifier", "min": 1 }, { "id": "AuditEvent.agent.who.identifier.system", "path": "AuditEvent.agent.who.identifier.system", "min": 1 }, { "id": "AuditEvent.agent.who.identifier.value", "path": "AuditEvent.agent.who.identifier.value", "min": 1 }, { "id": "AuditEvent.agent.who.display", "path": "AuditEvent.agent.who.display", "min": 1 }, { "id": "AuditEvent.agent:organisation", "path": "AuditEvent.agent", "sliceName": "organisation", "min": 1, "max": "2" }, { "id": "AuditEvent.agent:organisation.who.identifier.system", "path": "AuditEvent.agent.who.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/ods-organization-code" }, { "id": "AuditEvent.agent:organisation.who.identifier.value", "path": "AuditEvent.agent.who.identifier.value", "short": "ODS code of the organisation. E.g. X26" }, { "id": "AuditEvent.agent:organisation.who.display", "path": "AuditEvent.agent.who.display", "short": "Name of the organisation" }, { "id": "AuditEvent.agent:accreditedSystemId", "path": "AuditEvent.agent", "sliceName": "accreditedSystemId", "short": "TODO This is an Endpoint identifier, move to organisation?", "max": "1" }, { "id": "AuditEvent.agent:accreditedSystemId.who.identifier.system", "path": "AuditEvent.agent.who.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/spine-ASID" }, { "id": "AuditEvent.agent:accreditedSystemId.who.identifier.value", "path": "AuditEvent.agent.who.identifier.value", "short": "Spine Accredited System Id" }, { "id": "AuditEvent.agent:user", "path": "AuditEvent.agent", "sliceName": "user", "max": "1" }, { "id": "AuditEvent.agent:user.who.identifier.system", "path": "AuditEvent.agent.who.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/sds-user-id" }, { "id": "AuditEvent.agent:user.who.identifier.value", "path": "AuditEvent.agent.who.identifier.value", "short": "User identifier. E.g. 1234567890" }, { "id": "AuditEvent.agent:user.who.display", "path": "AuditEvent.agent.who.display", "short": "User Name" }, { "id": "AuditEvent.agent:userRole", "path": "AuditEvent.agent", "sliceName": "userRole", "max": "1" }, { "id": "AuditEvent.agent:userRole.who.identifier.system", "path": "AuditEvent.agent.who.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/sds-role-profile-id" }, { "id": "AuditEvent.agent:userRole.who.identifier.value", "path": "AuditEvent.agent.who.identifier.value", "short": "Role Profile ID of the user" }, { "id": "AuditEvent.source", "path": "AuditEvent.source", "short": "I think this is endpoint instance (Device) which created the audit" }, { "id": "AuditEvent.source.observer.display", "path": "AuditEvent.source.observer.display", "short": "Audit Creator Name (the system which has generated the event)", "min": 1 }, { "id": "AuditEvent.source.type.system", "path": "AuditEvent.source.type.system", "short": "Audit Creator system Identifier", "min": 1 }, { "id": "AuditEvent.source.type.code", "path": "AuditEvent.source.type.code", "short": "Audit Creator Identifier code", "min": 1 }, { "id": "AuditEvent.entity", "path": "AuditEvent.entity", "slicing": { "discriminator": [ { "type": "pattern", "path": "type" } ], "rules": "closed" }, "min": 3 }, { "id": "AuditEvent.entity.what", "path": "AuditEvent.entity.what", "min": 1 }, { "id": "AuditEvent.entity.what.identifier", "path": "AuditEvent.entity.what.identifier", "min": 1 }, { "id": "AuditEvent.entity.what.identifier.system", "path": "AuditEvent.entity.what.identifier.system", "min": 1 }, { "id": "AuditEvent.entity.type", "path": "AuditEvent.entity.type", "min": 1 }, { "id": "AuditEvent.entity:patient", "path": "AuditEvent.entity", "sliceName": "patient", "min": 1, "max": "1" }, { "id": "AuditEvent.entity:patient.what", "path": "AuditEvent.entity.what", "short": "Patient NHS Number" }, { "id": "AuditEvent.entity:patient.what.identifier.system", "path": "AuditEvent.entity.what.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/nhs-number" }, { "id": "AuditEvent.entity:patient.type", "path": "AuditEvent.entity.type", "patternCoding": { "system": "http://hl7.org/fhir/resource-types", "code": "Patient" } }, { "id": "AuditEvent.entity:endpoint", "path": "AuditEvent.entity", "sliceName": "endpoint", "min": 1, "max": "1" }, { "id": "AuditEvent.entity:endpoint.what", "path": "AuditEvent.entity.what", "short": "Endpoint details" }, { "id": "AuditEvent.entity:endpoint.what.identifier.system", "path": "AuditEvent.entity.what.identifier.system", "patternUri": "https://fhir.nhs.uk/Id/spine-ASID" }, { "id": "AuditEvent.entity:endpoint.type", "path": "AuditEvent.entity.type", "patternCoding": { "system": "http://hl7.org/fhir/resource-types", "code": "Endpoint" } }, { "id": "AuditEvent.entity:endpoint.name", "path": "AuditEvent.entity.name", "short": "Human readable interactionID. E.g. Parent Prescription", "min": 1 }, { "id": "AuditEvent.entity:endpoint.detail", "path": "AuditEvent.entity.detail", "slicing": { "discriminator": [ { "type": "pattern", "path": "type" } ], "rules": "open" }, "min": 2 }, { "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier", "path": "AuditEvent.entity.detail", "sliceName": "interactionIdentifier", "short": "HL7V3 identifier, for FHIR there is no standard", "min": 1, "max": "1" }, { "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier.type", "path": "AuditEvent.entity.detail.type", "patternString": "productIdentitifier" }, { "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier.value[x]", "path": "AuditEvent.entity.detail.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier.value[x]:valueString", "path": "AuditEvent.entity.detail.value[x]", "sliceName": "valueString", "min": 1, "type": [ { "code": "string" } ] }, { "id": "AuditEvent.entity:endpoint.detail:productIdentifier", "path": "AuditEvent.entity.detail", "sliceName": "productIdentifier", "short": "High level grouping of the message types", "min": 1, "max": "1" }, { "id": "AuditEvent.entity:endpoint.detail:productIdentifier.type", "path": "AuditEvent.entity.detail.type", "patternString": "productIdentifier" }, { "id": "AuditEvent.entity:endpoint.detail:productIdentifier.value[x]", "path": "AuditEvent.entity.detail.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "AuditEvent.entity:endpoint.detail:productIdentifier.value[x]:valueString", "path": "AuditEvent.entity.detail.value[x]", "sliceName": "valueString", "min": 1, "type": [ { "code": "string" } ] }, { "id": "AuditEvent.entity:transaction", "path": "AuditEvent.entity", "sliceName": "transaction", "min": 1, "max": "1" }, { "id": "AuditEvent.entity:transaction.what", "path": "AuditEvent.entity.what", "short": "Transaction Id, Correlation Id or X-RequestID" }, { "id": "AuditEvent.entity:transaction.type", "path": "AuditEvent.entity.type", "patternCoding": { "system": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType", "code": "XrequestId" } } ] } }