Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Example AuditEvent/example-error (JSON)

Security Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Device, Patient, Practitioner

Raw JSON (canonical form + also see JSON Format Specification)

Audit of a transaction that was failed resulting in OperationOutcome

{
  "resourceType" : "AuditEvent",
  "id" : "example-error",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Recording that an error has happened due to a client requesting that an Observation resource be Created on the Patient endpoint. Note that the OperationOutcome from failed transaction is recorded as an AuditEvent.entity.</div>"
  },
  "contained" : [{
    "resourceType" : "OperationOutcome",
    "id" : "o1",
    "issue" : [{
      "severity" : "error",
      "code" : "invalid",
      "details" : {
        "text" : "Invalid pointer operation"
      }
    }]
  }],
  "category" : [{
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
      "code" : "rest",
      "display" : "Restful Operation"
    }]
  }],
  "code" : {
    "coding" : [{
      "system" : "http://hl7.org/fhir/restful-interaction",
      "code" : "create",
      "display" : "create"
    }]
  },
  "action" : "C",
  "recorded" : "2017-09-07T23:42:24Z",
  "outcome" : {
    "code" : {
      "system" : "http://hl7.org/fhir/issue-severity",
      "code" : "error",
      "display" : "Error"
    },
    "detail" : [{
      "text" : "Invalid request to create an Operation resource on the Patient endpoint."
    }]
  },
  "agent" : [{
    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
        "code" : "humanuser",
        "display" : "human user"
      }]
    },
    "who" : {
      "identifier" : {
        "value" : "95"
      },
      "display" : "Grahame Grieve"
    },
    "requestor" : true
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID",
      "valueIdentifier" : {
        "type" : {
          "text" : "process ID"
        },
        "value" : "6580"
      }
    }],
    "type" : {
      "coding" : [{
        "system" : "http://dicom.nema.org/resources/ontology/DCM",
        "code" : "110153",
        "display" : "Source Role ID"
      }]
    },
    "who" : {
      "identifier" : {
        "system" : "urn:oid:2.16.840.1.113883.4.2",
        "value" : "2.16.840.1.113883.4.2"
      }
    },
    "requestor" : false,
    "networkString" : "Workstation1.ehr.familyclinic.com"
  }],
  "source" : {
    "observer" : {
      "identifier" : {
        "value" : "hl7connect.healthintersections.com.au"
      },
      "display" : "Cloud"
    },
    "type" : [{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/security-source-type",
        "code" : "3",
        "display" : "Web Server"
      }]
    }]
  },
  "entity" : [{
    "what" : {
      "reference" : "#o1",
      "display" : "transaction failed"
    }
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.