FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source1

{
  "resourceType": "StructureDefinition",
  "id": "England-AuditEvent-PARS",
  "url": "https://fhir.nhs.uk/England/StructureDefinition/England-AuditEvent-PARS",
  "version": "0.3.0",
  "name": "EnglandAuditEventPARS",
  "title": "England Audit Event PARS",
  "status": "draft",
  "date": "2026-01-27T15:49:00+00:00",
  "publisher": "NHS England",
  "contact": [
    {
      "name": "NHS England",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work",
          "rank": 1
        }
      ]
    }
  ],
  "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.",
  "purpose": "This documents NHS England Data Dictionary and HL7 definitions",
  "copyright": "Copyright © 2025+ NHS England Licensed under the Apache License, Version 2.0 (the \\"License\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\"AS IS\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "AuditEvent",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "AuditEvent.type.system",
        "path": "AuditEvent.type.system",
        "min": 1
      },
      {
        "id": "AuditEvent.subtype.system",
        "path": "AuditEvent.subtype.system",
        "min": 1
      },
      {
        "id": "AuditEvent.subtype.code",
        "path": "AuditEvent.subtype.code",
        "min": 1
      },
      {
        "id": "AuditEvent.action",
        "path": "AuditEvent.action",
        "short": "Type of operation - Create Read Update Delete",
        "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": "value",
              "path": "who.type"
            }
          ],
          "rules": "closed"
        }
      },
      {
        "id": "AuditEvent.agent.who",
        "path": "AuditEvent.agent.who",
        "min": 1
      },
      {
        "id": "AuditEvent.agent.who.type",
        "path": "AuditEvent.agent.who.type",
        "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:organisation",
        "path": "AuditEvent.agent",
        "sliceName": "organisation",
        "min": 1,
        "max": "2"
      },
      {
        "id": "AuditEvent.agent:organisation.who",
        "path": "AuditEvent.agent.who",
        "short": "Name of the organisation"
      },
      {
        "id": "AuditEvent.agent:organisation.who.type",
        "path": "AuditEvent.agent.who.type",
        "fixedUri": "Organization"
      },
      {
        "id": "AuditEvent.agent:organisation.who.display",
        "path": "AuditEvent.agent.who.display",
        "short": "Name of the organisation"
      },
      {
        "id": "AuditEvent.agent:patient",
        "path": "AuditEvent.agent",
        "sliceName": "patient",
        "min": 0,
        "max": "1"
      },
      {
        "id": "AuditEvent.agent:patient.who.type",
        "path": "AuditEvent.agent.who.type",
        "fixedUri": "Patient"
      },
      {
        "id": "AuditEvent.agent:patient.who.display",
        "path": "AuditEvent.agent.who.display",
        "short": "Patient Name"
      },
      {
        "id": "AuditEvent.agent:user",
        "path": "AuditEvent.agent",
        "sliceName": "user",
        "min": 0,
        "max": "1"
      },
      {
        "id": "AuditEvent.agent:user.who.type",
        "path": "AuditEvent.agent.who.type",
        "fixedUri": "Practitioner"
      },
      {
        "id": "AuditEvent.agent:user.who.display",
        "path": "AuditEvent.agent.who.display",
        "short": "User Name"
      },
      {
        "id": "AuditEvent.agent:userRole",
        "path": "AuditEvent.agent",
        "sliceName": "userRole",
        "min": 0,
        "max": "1"
      },
      {
        "id": "AuditEvent.agent:userRole.who.type",
        "path": "AuditEvent.agent.who.type",
        "fixedUri": "PractitionerRole"
      },
      {
        "id": "AuditEvent.agent:device",
        "path": "AuditEvent.agent",
        "sliceName": "device",
        "min": 0,
        "max": "1"
      },
      {
        "id": "AuditEvent.agent:device.who.type",
        "path": "AuditEvent.agent.who.type",
        "fixedUri": "Endpoint"
      },
      {
        "id": "AuditEvent.agent:device.who.identifier",
        "path": "AuditEvent.agent.who.identifier",
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Product-Id",
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Accredited-System",
              "http://hl7.org/fhir/StructureDefinition/Identifier"
            ]
          }
        ]
      },
      {
        "id": "AuditEvent.source",
        "path": "AuditEvent.source",
        "short": "The endpoint instance (Device) which created the audit"
      },
      {
        "id": "AuditEvent.source.site",
        "path": "AuditEvent.source.site",
        "short": "Audit Creator system Code"
      },
      {
        "id": "AuditEvent.source.observer",
        "path": "AuditEvent.source.observer",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Device"
            ]
          }
        ]
      },
      {
        "id": "AuditEvent.source.observer.identifier",
        "path": "AuditEvent.source.observer.identifier",
        "short": "Audit Creator system Identifier",
        "definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.\r\n\r\nIdentifiers for ASIDs or Product IDs SHOULD use the appropriate URL as defined within the England-Identifier profiles.",
        "min": 1,
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Accredited-System",
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Product-Id",
              "http://hl7.org/fhir/StructureDefinition/Identifier"
            ]
          }
        ]
      },
      {
        "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",
        "path": "AuditEvent.source.type",
        "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": "value",
              "path": "type.system"
            },
            {
              "type": "value",
              "path": "type.code"
            }
          ],
          "rules": "closed"
        }
      },
      {
        "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.type.system",
        "path": "AuditEvent.entity.type.system",
        "min": 1
      },
      {
        "id": "AuditEvent.entity.type.code",
        "path": "AuditEvent.entity.type.code",
        "min": 1
      },
      {
        "id": "AuditEvent.entity:patient",
        "path": "AuditEvent.entity",
        "sliceName": "patient",
        "short": "Patient NHS number",
        "min": 1,
        "max": "1"
      },
      {
        "id": "AuditEvent.entity:patient.type.system",
        "path": "AuditEvent.entity.type.system",
        "fixedUri": "http://terminology.hl7.org/CodeSystem/audit-entity-type"
      },
      {
        "id": "AuditEvent.entity:patient.type.code",
        "path": "AuditEvent.entity.type.code",
        "fixedCode": "1"
      },
      {
        "id": "AuditEvent.entity:patient.role.system",
        "path": "AuditEvent.entity.role.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/object-role"
      },
      {
        "id": "AuditEvent.entity:patient.role.code",
        "path": "AuditEvent.entity.role.code",
        "fixedCode": "1"
      },
      {
        "id": "AuditEvent.entity:transaction",
        "path": "AuditEvent.entity",
        "sliceName": "transaction",
        "short": "Transaction Id, Correlation Id or X-RequestID",
        "min": 1,
        "max": "1"
      },
      {
        "id": "AuditEvent.entity:transaction.type.system",
        "path": "AuditEvent.entity.type.system",
        "fixedUri": "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType"
      },
      {
        "id": "AuditEvent.entity:transaction.type.code",
        "path": "AuditEvent.entity.type.code",
        "fixedCode": "XrequestId"
      },
      {
        "id": "AuditEvent.entity:submittedOrganisation",
        "path": "AuditEvent.entity",
        "sliceName": "submittedOrganisation",
        "short": "ODS code of the organisation submitted in the message/headers",
        "max": "1"
      },
      {
        "id": "AuditEvent.entity:submittedOrganisation.type.system",
        "path": "AuditEvent.entity.type.system",
        "fixedUri": "http://terminology.hl7.org/CodeSystem/audit-entity-type"
      },
      {
        "id": "AuditEvent.entity:submittedOrganisation.type.code",
        "path": "AuditEvent.entity.type.code",
        "fixedCode": "3"
      },
      {
        "id": "AuditEvent.entity:endpoint",
        "path": "AuditEvent.entity",
        "sliceName": "endpoint",
        "short": "Endpoint details"
      },
      {
        "id": "AuditEvent.entity:endpoint.what.identifier",
        "path": "AuditEvent.entity.what.identifier",
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Accredited-System",
              "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Product-Id",
              "http://hl7.org/fhir/StructureDefinition/Identifier"
            ]
          }
        ]
      },
      {
        "id": "AuditEvent.entity:endpoint.type.system",
        "path": "AuditEvent.entity.type.system",
        "fixedUri": "http://hl7.org/fhir/resource-types"
      },
      {
        "id": "AuditEvent.entity:endpoint.type.code",
        "path": "AuditEvent.entity.type.code",
        "fixedCode": "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": "value",
              "path": "type"
            }
          ],
          "rules": "open"
        },
        "min": 2,
        "max": "2"
      },
      {
        "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",
        "fixedString": "productIdentifier"
      },
      {
        "id": "AuditEvent.entity:endpoint.detail:productIdentifier.value[x]",
        "path": "AuditEvent.entity.detail.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier",
        "path": "AuditEvent.entity.detail",
        "sliceName": "interactionIdentifier",
        "min": 1,
        "max": "1"
      },
      {
        "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier.type",
        "path": "AuditEvent.entity.detail.type",
        "fixedString": "interactionIdentifier"
      },
      {
        "id": "AuditEvent.entity:endpoint.detail:interactionIdentifier.value[x]",
        "path": "AuditEvent.entity.detail.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}