Generated Narrative: StructureDefinition AuditEvent

Name Flags Card. Type Description & Constraints doco
. . AuditEvent 0 .. * AuditEvent Event record kept for security purposes
. . . type 1 .. 1 Coding High level grouping of the message types. E.g. PSIS Query
. . . . system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/Id/productId
. . . Slices for subtype 1 .. * Coding More specific type/id for the event
Slice: Unordered, Closed by pattern:system
. . . . subtype:All Slices Content/Rules for all slices
. . . . . system 1..1 uri Identity of the terminology system
. . . . . code 1..1 code Symbol in syntax defined by the system
. . . . subtype:interactionId 1..1 Coding HL7V3 identifier, for FHIR there is no standard. E.g. PORX_IN020101UK04
. . . . . system 0 .. 1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/Id/nhsServiceInteractionId
. . . . . display 0 .. 1 string Human readable interactionID. E.g. Parent Prescription
. . . action 1..1 code Type of action performed during the event
. . . recorded S 1 .. 1 instant Time when the event was recorded
. . . Slices for agent 1 .. * BackboneElement Actor involved in the event
Slice: Unordered, Closed by pattern:who.identifier.system
. . . . agent:All Slices Content/Rules for all slices
. . . . . who 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
. . . . . . identifier 1..1 Identifier Logical reference, when literal reference is not known
. . . . . . . system 1..1 uri The namespace for the identifier value
. . . . . . . value 1..1 string The value that is unique
. . . . . . display 1..1 string Text alternative for the resource
. . . . agent:organisation 1..2 BackboneElement Actor involved in the event
. . . . . who
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
. . . . . . . value 0 .. 1 string ODS code of the organisation. E.g. X26
. . . . . . display 0 .. 1 string Name of the organisation
. . . . agent:accreditedSystemId 0..1 BackboneElement TODO This is an Endpoint identifier, move to organisation?
. . . . . who
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/spine-ASID
. . . . . . . value 0 .. 1 string Spine Accredited System Id
. . . . agent:user 0..1 BackboneElement Actor involved in the event
. . . . . who
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/sds-user-id
. . . . . . . value 0 .. 1 string User identifier. E.g. 1234567890
. . . . . . display 0 .. 1 string User Name
. . . . agent:userRole 0..1 BackboneElement Actor involved in the event
. . . . . who
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/sds-role-profile-id
. . . . . . . value 0 .. 1 string Role Profile ID of the user
. . . source 1 .. 1 BackboneElement I think this is endpoint instance (Device) which created the audit
. . . . observer
. . . . . display 1..1 string Audit Creator Name (the system which has generated the event)
. . . . type
. . . . . system 1..1 uri Audit Creator system Identifier
. . . . . code 1..1 code Audit Creator Identifier code
. . . Slices for entity 3 .. * BackboneElement Data or objects used
Slice: Unordered, Closed by pattern:type
. . . . entity:All Slices Content/Rules for all slices
. . . . . what 1..1 Reference(Resource) Specific instance of resource
. . . . . . identifier 1..1 Identifier Logical reference, when literal reference is not known
. . . . . . . system 1..1 uri The namespace for the identifier value
. . . . . type 1..1 Coding Type of entity involved
. . . . entity:patient 1..1 BackboneElement Data or objects used
. . . . . what 0 .. 1 Reference(Resource) Patient NHS Number
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/nhs-number
. . . . . type 0 .. 1 Coding Type of entity involved
Required Pattern: At least the following
. . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
. . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: Patient
. . . . entity:endpoint 1..1 BackboneElement Data or objects used
. . . . . what 0 .. 1 Reference(Resource) Endpoint details
. . . . . . identifier
. . . . . . . system 0 .. 1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/spine-ASID
. . . . . type 0 .. 1 Coding Type of entity involved
Required Pattern: At least the following
. . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
. . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: Endpoint
. . . . . name 1..1 string Human readable interactionID. E.g. Parent Prescription
. . . . . Slices for detail 2 .. * BackboneElement Additional Information about the entity
Slice: Unordered, Open by pattern:type
. . . . . . detail:interactionIdentifier 1..1 BackboneElement HL7V3 identifier, for FHIR there is no standard
. . . . . . . type 1 .. 1 string Name of the property
Required Pattern: productIdentitifier
. . . . . . . Slices for value[x] 1 .. 1 string Property value
Slice: Unordered, Open by type:$this
. . . . . . . . value[x]:valueString 1..1 string Property value
. . . . . . detail:productIdentifier 1..1 BackboneElement High level grouping of the message types
. . . . . . . type 1 .. 1 string Name of the property
Required Pattern: productIdentifier
. . . . . . . Slices for value[x] 1 .. 1 string Property value
Slice: Unordered, Open by type:$this
. . . . . . . . value[x]:valueString 1..1 string Property value
. . . . entity:transaction 1..1 BackboneElement Data or objects used
. . . . . what 0 .. 1 Reference(Resource) Transaction Id, Correlation Id or X-RequestID
. . . . . type 0 .. 1 Coding Type of entity involved
Required Pattern: At least the following
. . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
. . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId

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