Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Auditevent-example-error.xml

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

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

Jump past Narrative

Audit of a transaction that was failed resulting in OperationOutcome (id = "example-error")

<?xml version="1.0" encoding="UTF-8"?>

<AuditEvent xmlns="http://hl7.org/fhir">
  <id value="example-error"/> 
  <text> 
    <status value="generated"/> 
    <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> 
  </text>   
  <contained> 
    <!--   contained OperationOutcome from failed transaction   -->
    <OperationOutcome> 
      <id value="o1"/> 

      <issue> 
        <severity value="error"/> 
        <code value="invalid"/> 
        <details> 
          <text value="Invalid pointer operation"/> 
        </details> 
      </issue> 
    </OperationOutcome> 
  </contained> 
  <type> 
    <system value="http://terminology.hl7.org/CodeSystem/audit-event-type"/> 
    <code value="rest"/> 
    <display value="Restful Operation"/> 
  </type> 
  <subtype> 
    <system value="http://hl7.org/fhir/restful-interaction"/> 
    <code value="create"/> 
    <display value="create"/> 
  </subtype> 
  <action value="C"/> 
  <recorded value="2017-09-07T23:42:24Z"/> 
  <outcome> 
    <coding> 
      <system value="http://hl7.org/fhir/audit-event-outcome"/> 
      <code value="8"/> 
      <display value="Serious Failure"/> 
    </coding> 
    <text value="Invalid request to create an Operation resource on the Patient endpoint."/> 
  </outcome>  

  <agent> 
    <type> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/extra-security-role-type"/> 
        <code value="humanuser"/> 
        <display value="human user"/> 
      </coding> 
    </type>  

    <who> 
      <identifier> 
        <value value="95"/> 
      </identifier> 
    </who> 
    <altId value="601847123"/> 
    <name value="Grahame Grieve"/> 
    <requestor value="true"/> 
  </agent> 
  <agent> 
    <!--   Source active participant, the software making the . AlternativeUserId - Process ID
       --> 
    <type> 
      <coding> 
        <system value="http://dicom.nema.org/resources/ontology/DCM"/> 
        <code value="110153"/> 
        <display value="Source Role ID"/> 
      </coding> 
    </type>  
    <who> 
  <identifier> 
    <system value="urn:oid:2.16.840.1.113883.4.2"/>  
    <value value="2.16.840.1.113883.4.2"/>  
  </identifier> 
</who> 
    <altId value="6580"/>  
    <requestor value="false"/>  
    <network> 
      <address value="Workstation1.ehr.familyclinic.com"/> 
      <type value="1"/> 
    </network>  
  </agent> 
  <source> 
    <site value="Cloud"/> 
    <observer> 
      <identifier> 
        <value value="hl7connect.healthintersections.com.au"/> 
      </identifier> 
    </observer> 
    <type> 
      <system value="http://terminology.hl7.org/CodeSystem/security-source-type"/> 
      <code value="3"/> 
      <display value="Web Server"/> 
    </type> 
  </source> 
  <entity> 
    <!--   record the original transaction parameters   -->
    <type> 
      <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type"/> 
      <code value="2"/> 
      <display value="System Object"/> 
    </type> 
    <detail> 
      <type value="requested transaction"/> 
      <valueString value="http POST ..... "/> 
      <!--   or better to have a pointer to the propritary log files from the API gateway or web
       server   -->
    </detail> 
  </entity> 
  <entity> 
    <!--   record the OperationOutcome returned to the client   -->
    <what> 
      <reference value="#o1"/> 
    </what> 
    <type> 
      <system value="http://hl7.org/fhir/resource-types"/> 
      <code value="OperationOutcome"/> 
      <display value="OperationOutcome"/> 
    </type> 
    <name value="transaction failed"/> 
  </entity> 
</AuditEvent> 

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.