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

Example AuditEvent/example-rest-create-traceID (XML)

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

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

Jump past Narrative

RESTful create with TraceID (id = "example-rest-create-traceID")

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

<AuditEvent xmlns="http://hl7.org/fhir">
  <id value="example-rest-create-traceID"/> 
  <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: AuditEvent</b> <a name="example-rest-create-traceID"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource AuditEvent &quot;example-rest-create-traceID&quot; </p> </div> <p> <b> category</b> : Restful Operation <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-audit-event-type.html">Audit Event ID</a> #rest)</span> </p> <p> <b> code</b> : create <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="codesystem-restful-interaction.html">FHIR Restful Interactions</a> #create)</span> </p> <p> <b> action</b> : C</p> <p> <b> recorded</b> : 4 Dec 2019, 10:59:28 pm</p> <h3> Outcomes</h3> <table class="grid"><tr> <td> -</td> <td> <b> Code</b> </td> </tr> <tr> <td> *</td> <td> Success (Details: http://terminology.hl7.org/CodeSystem/audit-event-outcome code
             0 = 'Success', stated as 'Success')</td> </tr> </table> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : human user <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-extra-security-role-type.html">Security Role Type</a> #humanuser)</span> </p> <p> <b> who</b> : <span/>  </p> <p> <b> requestor</b> : true</p> </blockquote> <blockquote> <p> <b> agent</b> </p> <p> <b> AuditEvent Alternative User ID</b> : process ID: 6580</p> <p> <b> type</b> : Source Role ID <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://dicom.nema.org/resources/ontology/DCM">DICOM</a> #110153)</span> </p> <p> <b> who</b> : <span/>  </p> <p> <b> requestor</b> : false</p> <p> <b> network</b> : Workstation1.ehr.familyclinic.com</p> </blockquote> <h3> Sources</h3> <table class="grid"><tr> <td> -</td> <td> <b> Observer</b> </td> <td> <b> Type</b> </td> </tr> <tr> <td> *</td> <td> <span/>  </td> <td> Web Server <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-security-source-type.html">Audit Event Source Type</a> #3)</span> </td> </tr> </table> <blockquote> <p> <b> entity</b> </p> <p> <b> what</b> : <a href="patient-example.html">Patient/example/_history/1</a>  &quot;Peter CHALMERS&quot;</p> <p> <b> role</b> : Patient <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-object-role.html">AuditEventEntityRole</a> #1)</span> </p> </blockquote> <blockquote> <p> <b> entity</b> </p> <p> <b> what</b> : <span title="  The TraceID from the software stack  "><span/>  </span> </p> <p> <b> role</b> : Job Stream <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.1.0/CodeSystem-object-role.html">AuditEventEntityRole</a> #21)</span> </p> </blockquote> </div> </text> <category> 
     <coding> 
    <system value="http://terminology.hl7.org/CodeSystem/audit-event-type"/> 
    <code value="rest"/> 
    <display value="Restful Operation"/> 
     </coding> 
  </category> 
  <code> 
     <coding> 
    <system value="http://hl7.org/fhir/restful-interaction"/> 
    <code value="create"/> 
    <display value="create"/> 
     </coding> 
  </code> 
  <action value="C"/> 
  <recorded value="2019-12-04T11:59:28.646+00:00"/> 
  <outcome> 
    <code> 
      <system value="http://terminology.hl7.org/CodeSystem/audit-event-outcome"/> 
      <code value="0"/> 
      <display value="Success"/> 
    </code> 
  </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> 
    <requestor value="true"/> 
  </agent> 
  <agent> 
        <!--    Source active participant, the software making the . AlternativeUserId - Process
     ID    --> 
    <extension url="http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID">
      <valueIdentifier> 
        <type> 
        <text value="process ID"/> 
        </type> 
        <value value="6580"/> 
      </valueIdentifier> 
    </extension> 
    <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> 
    <requestor value="false"/>  
    <networkString value="Workstation1.ehr.familyclinic.com"/> 

  </agent> 
  <source> 
    <observer> 
    <identifier> 
      <value value="hl7connect.healthintersections.com.au"/> 
      </identifier> 
    </observer> 
    <type> 
     <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/security-source-type"/> 
      <code value="3"/> 
      <display value="Web Server"/> 
     </coding> 
    </type> 
  </source> 
  <entity> 
    <what> 
      <reference value="Patient/example/_history/1"/> 
    </what> 

    <role> 
     <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/object-role"/> 
      <code value="1"/> 
      <display value="Patient"/> 
     </coding> 
    </role> 
  </entity> 
  <entity> 
        <!--    The TraceID from the software stack    -->
    <what> 
      <identifier> 
          <type> 
          <text value="TraceID"/> 
        </type> 
        <system value="http://example.com/server"/> 
        <value value="6b507ee2d716780372c255df69ece653"/> 
      </identifier> 
    </what> 

    <role> 
     <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/object-role"/> 
      <code value="21"/> 
      <display value="Job Stream"/> 
     </coding> 
    </role> 
  </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.