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 . Page versions: R5 R4B R4 R3 R2
Security Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Patient, Practitioner |
Raw XML (canonical form + also see XML Format Specification)
RESTful search operation (id = "example-search")
<?xml version="1.0" encoding="UTF-8"?> <AuditEvent xmlns="http://hl7.org/fhir"> <id value="example-search"/> <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> search</span> </p> <p> <b> action</b> : E</p> <p> <b> recorded</b> : 23 Aug. 2015, 9:42:24 am</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> hl7connect.healthintersections.com.au</span> </td> <td> <span> Web Server</span> </td> </tr> </table> <h3> Entities</h3> <table> <tr> <td> -</td> <td> <b> Type</b> </td> <td> <b> Role</b> </td> <td> <b> Query</b> </td> </tr> <tr> <td> *</td> <td> <span> System Object</span> </td> <td> <span> Query</span> </td> <td> aHR0cDovL2ZoaXItZGV2LmhlYWx0aGludGVyc2VjdGlvbnMuY29tLmF1L29wZW4vRW5jb3VudGVyP3BhcnRpY2lwYW50PTEz</td> </tr> </table> </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="search"/> <display value="search"/> </subtype> <action value="E"/> <recorded value="2015-08-22T23:42:24Z"/> <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> <display value="hl7connect.healthintersections.com.au"/> </observer> <type> <system value="http://terminology.hl7.org/CodeSystem/security-source-type"/> <code value="3"/> <display value="Web Server"/> </type> </source> <entity> <!-- HTTP GET encoded in base64Binary --> <!-- orignal example encoded here is --> <!-- "http://fhir-dev.healthintersections.com.au/open/Encounter?participant=13" --> <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="24"/> <display value="Query"/> </role> <query value="aHR0cDovL2ZoaXItZGV2LmhlYWx0aGludGVyc2VjdGlvbnMuY29tLmF1L29wZW4vRW5jb3VudGVyP3BhcnRpY2lwYW50PTEz"/> </entity> <!-- could include an .entity of the patient if possible --> </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.