This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
Release
5
Snapshot
#1).
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"/>: Restful Operation (Details: http://terminology.hl7.org/CodeSystem/audit-event-type code rest = 'RESTful Operation', stated as 'Restful Operation'): search (Details: http://hl7.org/fhir/restful-interaction code search = 'search', stated as 'search')(Details : {http://terminology.hl7.org/CodeSystem/extra-security-role-type code 'humanuser' = 'human user', given as 'human user'})Web Server (Details: http://terminology.hl7.org/CodeSystem/security-source-type code 3 = 'Web Server', stated as 'Web Server')System Object (Details: http://terminology.hl7.org/CodeSystem/audit-entity-type code 2 = 'System Object', stated as 'System Object')Query (Details: http://terminology.hl7.org/CodeSystem/object-role code 24 = 'Query', stated as 'Query')<text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative</b> </p> <div> <p> Resource "example-search" </p> </div> <p> <b> category</b> : Restful Operation <span> (<a> Audit Event ID</a> #rest)</span> </p> <p> <b> code</b> : search <span> (<a> FHIR Restful Interactions</a> #search)</span> </p> <p> <b> action</b> : E</p> <p> <b> recorded</b> : 23 Aug. 2015, 9:42:24 am</p> <h3> Outcomes</h3> <table> <tr> <td> -</td> <td> <b> Code</b> </td> </tr> <tr> <td> *</td> <td> Success (Details: http://terminology.hl7.org/CodeSystem/audit-event-outcome code success = 'Success', stated as 'Success')</td> </tr> </table> <blockquote> <p> <b> agent</b> </p> <p> <b> type</b> : human user <span> (<a> SecurityRoleType</a> #humanuser)</span> </p> <p> <b> who</b> : <span> : Grahame Grieve</span> </p> <p> <b> requestor</b> : true</p> </blockquote> <blockquote> <p> <b> agent</b> </p> <p> <b> AlternativeUserID</b> : process ID: 6580</p> <p> <b> type</b> : Source Role ID <span> (<a> 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> <tr> <td> -</td> <td> <b> Observer</b> </td> <td> <b> Type</b> </td> </tr> <tr> <td> *</td> <td> <span> : hl7connect.healthintersections.com.au</span> </td> <td> Web Server <span> (<a> Audit Event Source Type</a> #3)</span> </td> </tr> </table> <h3> Entities</h3> <table> <tr> <td> -</td> <td> <b> Role</b> </td> <td> <b> Query</b> </td> </tr> <tr> <td> *</td> <td> Query <span> (<a> AuditEventEntityRole</a> #24)</span> </td> <td> aHR0cDovL2ZoaXItZGV2LmhlYWx0aGludGVyc2VjdGlvbnMuY29tLmF1L29wZW4vRW5jb3VudGVyP3BhcnRpY2lwYW50PTEz</td> </tr> </table> </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="search"/> <display value="search"/> </coding> </code> <action value="E"/> <recorded value="2015-08-22T23:42:24Z"/><outcome> <code> <system value="http://terminology.hl7.org/CodeSystem/audit-event-outcome"/> <code value="success"/> <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> <display value="Grahame Grieve"/> </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><display value="hl7connect.healthintersections.com.au"/> </observer> <type><coding> <system value="http://terminology.hl7.org/CodeSystem/security-source-type"/> <code value="3"/> <display value="Web Server"/> </coding> </type> </source> <entity> <!-- HTTP GET encoded in base64Binary --> <!-- orignal example encoded here is --> <!-- "http://fhir-dev.healthintersections.com.au/open/Encounter?participant=13" --><role><coding> <system value="http://terminology.hl7.org/CodeSystem/object-role"/> <code value="24"/> <display value="Query"/> </coding> </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.