Release 4B 5

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

Auditevent-example-error.json

Example AuditEvent/example-error (JSON)

Security Work Group Maturity Level : N/A Standards Status : Informative Compartments : 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>"

  "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"
          }
        }
      ]
    }
  ],
  "type": {
    "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "code": "rest",
    "display": "Restful Operation"

  "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"
    }]

  },
  "subtype": [
    {
      "system": "http://hl7.org/fhir/restful-interaction",
      "code": "create",
      "display": "create"
    }
  ],
  "action": "C",
  "recorded": "2017-09-07T23:42:24Z",
  "outcome": "8",
  "outcomeDesc": "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"
        }
      },
      "altId": "601847123",
      "name": "Grahame Grieve",
      "requestor": true

  "action" : "C",
  "recorded" : "2017-09-07T23:42:24Z",
  "outcome" : {
    "code" : {
      "system" : "http://hl7.org/fhir/issue-severity",
      "code" : "error",
      "display" : "Error"

    },
    {
      "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"
        }

    "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"

      },
      "altId": "6580",
      "requestor": false,
      "network": {
        "address": "Workstation1.ehr.familyclinic.com",
        "type": "1"
      }
    }
  ],
  "source": {
    "site": "Cloud",
    "observer": {
      "identifier": {
        "value": "hl7connect.healthintersections.com.au"

      "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"
      }]

    },
    "type": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
        "code": "3",
        "display": "Web Server"

    "who" : {
      "identifier" : {
        "system" : "urn:oid:2.16.840.1.113883.4.2",
        "value" : "2.16.840.1.113883.4.2"

      }
    ]
  },
  "entity": [
    {
      "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type",
        "code": "2",
        "display": "System Object"
      },
      "detail": [
        {
          "type": "requested transaction",
          "valueString": "http POST ....."
        }
      ]

    },
    {
      "what": {
        "reference": "#o1"
      },
      "type": {
        "system": "http://hl7.org/fhir/resource-types",
        "code": "OperationOutcome",
        "display": "OperationOutcome"

    "requestor" : false,
    "networkString" : "Workstation1.ehr.familyclinic.com"
  }],
  "source" : {
    "observer" : {
      "identifier" : {
        "value" : "hl7connect.healthintersections.com.au"

      },
      "description": "transaction failed"

      "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.