This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Security Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Patient, Practitioner |
Raw XML (canonical form + also see XML Format Specification)
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="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative</b> </p> <p> <b> type</b> : <span> Restful Operation</span> </p> <p> <b> subtype</b> : <span> create</span> </p> <p> <b> action</b> : C</p> <p> <b> recorded</b> : 4 Dec. 2019, 10:59:28 pm</p> <p> <b> outcome</b> : <span> Success</span> </p> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : <span> human user</span> </p> <p> <b> who</b> : <span/> </p> <p> <b> altId</b> : 601847123</p> <p> <b> name</b> : Grahame Grieve</p> <p> <b> requestor</b> : true</p> </blockquote> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : <span> Source Role ID</span> </p> <p> <b> who</b> : <span/> </p> <p> <b> altId</b> : 6580</p> <p> <b> requestor</b> : false</p> <h3> Networks</h3> <table> <tr> <td> -</td> <td> <b> Address</b> </td> <td> <b> Type</b> </td> </tr> <tr> <td> *</td> <td> Workstation1.ehr.familyclinic.com</td> <td> 1</td> </tr> </table> </blockquote> <h3> Sources</h3> <table> <tr> <td> -</td> <td> <b> Site</b> </td> <td> <b> Observer</b> </td> <td> <b> Type</b> </td> </tr> <tr> <td> *</td> <td> Cloud</td> <td> <span/> </td> <td> <span> Web Server</span> </td> </tr> </table> <blockquote> <p> <b> entity</b> </p> <p> <b> what</b> : <a> Patient/example/_history/1</a> </p> <p> <b> type</b> : <span> Person</span> </p> <p> <b> role</b> : <span> Patient</span> </p> </blockquote> <blockquote> <p> <b> entity</b> </p> <p> <b> what</b> : <span/> </p> <p> <b> type</b> : <span> System Object</span> </p> <p> <b> role</b> : <span> Job Stream</span> </p> </blockquote> </div> </text> <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="2019-12-04T11:59:28.646+00:00"/> <outcome> <coding> <system value="http://terminology.hl7.org/CodeSystem/audit-event-outcome"/> <code value="0"/> <display value="Success"/> </coding> </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> <what> <reference value="Patient/example/_history/1"/> </what> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type"/> <code value="1"/> <display value="Person"/> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role"/> <code value="1"/> <display value="Patient"/> </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> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-entity-type"/> <code value="2"/> <display value="System Object"/> </type> <role> <system value="http://terminology.hl7.org/CodeSystem/object-role"/> <code value="21"/> <display value="Job Stream"/> </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.