This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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 JSON (canonical form + also see JSON Format Specification)
RESTful create with TraceID
{ "resourceType" : "AuditEvent", "id" : "example-rest-create-traceID", "text" : { "status" : "extensions", "div" : "<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 "example-rest-create-traceID" </p></div><p><b>category</b>: Restful Operation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.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/4.0.0/CodeSystem-extra-security-role-type.html\">SecurityRoleType</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/4.0.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> "Peter CHALMERS"</p><p><b>role</b>: Patient <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.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/4.0.0/CodeSystem-object-role.html\">AuditEventEntityRole</a>#21)</span></p></blockquote></div>" }, "category" : [{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type", "code" : "rest", "display" : "Restful Operation" }] }], "code" : { "coding" : [{ "system" : "http://hl7.org/fhir/restful-interaction", "code" : "create", "display" : "create" }] }, "action" : "C", "recorded" : "2019-12-04T11:59:28.646+00:00", "outcome" : { "code" : { "system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome", "code" : "0", "display" : "Success" } }, "agent" : [{ "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type", "code" : "humanuser", "display" : "human user" }] }, "who" : { "identifier" : { "value" : "95" } }, "requestor" : true }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID", "valueIdentifier" : { "type" : { "text" : "process ID" }, "value" : "6580" } }], "type" : { "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110153", "display" : "Source Role ID" }] }, "who" : { "identifier" : { "system" : "urn:oid:2.16.840.1.113883.4.2", "value" : "2.16.840.1.113883.4.2" } }, "requestor" : false, "networkString" : "Workstation1.ehr.familyclinic.com" }], "source" : { "observer" : { "identifier" : { "value" : "hl7connect.healthintersections.com.au" } }, "type" : [{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/security-source-type", "code" : "3", "display" : "Web Server" }] }] }, "entity" : [{ "what" : { "reference" : "Patient/example/_history/1" }, "role" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/object-role", "code" : "1", "display" : "Patient" }] } }, { "what" : { "identifier" : { "type" : { "text" : "TraceID" }, "system" : "http://example.com/server", "value" : "6b507ee2d716780372c255df69ece653" } }, "role" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/object-role", "code" : "21", "display" : "Job Stream" }] } }] }
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.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0-draft-final generated on Wed, Mar 1, 2023 23:06+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change