Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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

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

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

Raw Turtle (+ also see Turtle/RDF Format Specification)

RESTful create with TraceID

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:AuditEvent;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example-rest-create-traceID"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ];
     fhir:Narrative.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 &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/3.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>: 04/12/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 success = '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/3.1.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>AlternativeUserID</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/3.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=\"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=\"codesystem-object-role.html\">AuditEventEntityRole</a>#21)</span></p></blockquote></div>"
  ];
  fhir:AuditEvent.category [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/audit-event-type" ];
       fhir:Coding.code [ fhir:value "rest" ];
       fhir:Coding.display [ fhir:value "Restful Operation" ]
     ]
  ];
  fhir:AuditEvent.code [
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://hl7.org/fhir/restful-interaction" ];
       fhir:Coding.code [ fhir:value "create" ];
       fhir:Coding.display [ fhir:value "create" ]
     ]
  ];
  fhir:AuditEvent.action [ fhir:value "C"];
  fhir:AuditEvent.recorded [ fhir:value "2019-12-04T11:59:28.646+00:00"^^xsd:dateTime];
  fhir:AuditEvent.outcome [
     fhir:AuditEvent.outcome.code [
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/audit-event-outcome" ];
       fhir:Coding.code [ fhir:value "success" ];
       fhir:Coding.display [ fhir:value "Success" ]
     ]
  ];
  fhir:AuditEvent.agent [
     fhir:index 0;
     fhir:AuditEvent.agent.type [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/extra-security-role-type" ];
         fhir:Coding.code [ fhir:value "humanuser" ];
         fhir:Coding.display [ fhir:value "human user" ]
       ]
     ];
     fhir:AuditEvent.agent.who [
       fhir:Reference.identifier [
         fhir:Identifier.value [ fhir:value "95" ]
       ]
     ];
     fhir:AuditEvent.agent.requestor [ fhir:value "true"^^xsd:boolean ]
  ], [
     fhir:index 1;
     fhir:Element.extension [
       fhir:index 0;
       fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID" ];
       fhir:Extension.valueIdentifier [
         fhir:Identifier.type [
           fhir:CodeableConcept.text [ fhir:value "process ID" ]
         ];
         fhir:Identifier.value [ fhir:value "6580" ]
       ]
     ];
     fhir:AuditEvent.agent.type [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://dicom.nema.org/resources/ontology/DCM" ];
         fhir:Coding.code [ fhir:value "110153" ];
         fhir:Coding.display [ fhir:value "Source Role ID" ]
       ]
     ];
     fhir:AuditEvent.agent.who [
       fhir:Reference.identifier [
         fhir:Identifier.system [ fhir:value "urn:oid:2.16.840.1.113883.4.2" ];
         fhir:Identifier.value [ fhir:value "2.16.840.1.113883.4.2" ]
       ]
     ];
     fhir:AuditEvent.agent.requestor [ fhir:value "false"^^xsd:boolean ];
     fhir:AuditEvent.agent.networkString [ fhir:value "Workstation1.ehr.familyclinic.com" ]
  ];
  fhir:AuditEvent.source [
     fhir:AuditEvent.source.observer [
       fhir:Reference.identifier [
         fhir:Identifier.value [ fhir:value "hl7connect.healthintersections.com.au" ]
       ]
     ];
     fhir:AuditEvent.source.type [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/security-source-type" ];
         fhir:Coding.code [ fhir:value "3" ];
         fhir:Coding.display [ fhir:value "Web Server" ]
       ]
     ]
  ];
  fhir:AuditEvent.entity [
     fhir:index 0;
     fhir:AuditEvent.entity.what [
       fhir:Reference.reference [ fhir:value "Patient/example/_history/1" ]
     ];
     fhir:AuditEvent.entity.role [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/object-role" ];
         fhir:Coding.code [ fhir:value "1" ];
         fhir:Coding.display [ fhir:value "Patient" ]
       ]
     ]
  ], [
     fhir:index 1;
     fhir:AuditEvent.entity.what [
       fhir:Reference.identifier [
         fhir:Identifier.type [
           fhir:CodeableConcept.text [ fhir:value "TraceID" ]
         ];
         fhir:Identifier.system [ fhir:value "http://example.com/server" ];
         fhir:Identifier.value [ fhir:value "6b507ee2d716780372c255df69ece653" ]
       ]
     ];
     fhir:AuditEvent.entity.role [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/object-role" ];
         fhir:Coding.code [ fhir:value "21" ];
         fhir:Coding.display [ fhir:value "Job Stream" ]
       ]
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


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.