Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4

Auditevent-example-error.ttl

Example AuditEvent/example-error (Turtle)

Security Work Group Maturity Level : N/A Standards Status : Informative Compartments : Device , Patient , Practitioner

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

Audit of a transaction that was failed resulting in OperationOutcome 

@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 -------------------------------------------------------------------

<http://hl7.org/fhir/AuditEvent/example-error> a fhir:AuditEvent;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example-error"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">Recording that an error has happened due to a client requesting that an Observation resource be Created on the Patient endpoint. Note that the OperationOutcome from failed transaction is recorded as an AuditEvent.entity.</div>"
  ];
  fhir:DomainResource.contained [
     a fhir:OperationOutcome;
     fhir:index 0;
     fhir:Resource.id [ fhir:value "o1" ];
     fhir:OperationOutcome.issue [
       fhir:index 0;
       fhir:OperationOutcome.issue.severity [ fhir:value "error" ];
       fhir:OperationOutcome.issue.code [ fhir:value "invalid" ];
       fhir:OperationOutcome.issue.details [
         fhir:CodeableConcept.text [ fhir:value "Invalid pointer operation" ]
       ]
     ]
  ];
  fhir:AuditEvent.type [
     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.subtype [
     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 "2017-09-07T23:42:24Z"^^xsd:dateTime];
  fhir:AuditEvent.outcome [ fhir:value "8"];
  fhir:AuditEvent.outcomeDesc [ fhir:value "Invalid request to create an Operation resource on the Patient endpoint."];
  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.altId [ fhir:value "601847123" ];
     fhir:AuditEvent.agent.name [ fhir:value "Grahame Grieve" ];
     fhir:AuditEvent.agent.requestor [ fhir:value "true"^^xsd:boolean ]
  ], [
     fhir:index 1;
     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" ]

[a fhir:AuditEvent ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "example-error"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">Recording that an error has happened due to a client requesting that an Observation resource be Created on the Patient endpoint. Note that the OperationOutcome from failed transaction is recorded as an AuditEvent.entity.</div>"
  ] ; # 
  fhir:contained ( [
     a fhir:OperationOutcome ;
     fhir:id [ fhir:v "o1" ] ;
     fhir:issue ( [
       fhir:severity [ fhir:v "error" ] ;
       fhir:code [ fhir:v "invalid" ] ;
       fhir:details [
         fhir:text [ fhir:v "Invalid pointer operation" ]

       ]
     ];
     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" ]

     ] )
  ] ) ; #   contained OperationOutcome from failed transaction  
  fhir:category ( [
     fhir:coding ( [
       fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/audit-event-type"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "rest" ] ;
       fhir:display [ fhir:v "Restful Operation" ]
     ] )
  ] ) ; # 
  fhir:code [
     fhir:coding ( [
       fhir:system [ fhir:v "http://hl7.org/fhir/restful-interaction"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "create" ] ;
       fhir:display [ fhir:v "create" ]
     ] )
  ] ; # 
  fhir:action [ fhir:v "C"] ; # 
  fhir:recorded [ fhir:v "2017-09-07T23:42:24Z"^^xsd:dateTime] ; # 
  fhir:outcome [
     fhir:code [
       fhir:system [ fhir:v "http://hl7.org/fhir/issue-severity"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "error" ] ;
       fhir:display [ fhir:v "Error" ]
     ] ;
     fhir:detail ( [
       fhir:text [ fhir:v "Invalid request to create an Operation resource on the Patient endpoint." ]
     ] )
  ] ; # 
  fhir:agent ( [
     fhir:type [
       fhir:coding ( [
         fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/extra-security-role-type"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "humanuser" ] ;
         fhir:display [ fhir:v "human user" ]
       ] )
     ] ;
     fhir:who [
       fhir:identifier [
         fhir:value [ fhir:v "95" ]
       ] ;
       fhir:display [ fhir:v "Grahame Grieve" ]
     ] ;
     fhir:requestor [ fhir:v "true"^^xsd:boolean ]
  ] [
     fhir:extension ( [
       fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID"^^xsd:anyURI ] ;
       fhir:value [
         a fhir:Identifier ;
         fhir:type [
           fhir:text [ fhir:v "process ID" ]
         ] ;
         fhir:value [ fhir:v "6580" ]

       ]
     ];
     fhir:AuditEvent.agent.altId [ fhir:value "6580" ];
     fhir:AuditEvent.agent.requestor [ fhir:value "false"^^xsd:boolean ];
     fhir:AuditEvent.agent.network [
       fhir:AuditEvent.agent.network.address [ fhir:value "Workstation1.ehr.familyclinic.com" ];
       fhir:AuditEvent.agent.network.type [ fhir:value "1" ]
     ]
  ];
  fhir:AuditEvent.source [
     fhir:AuditEvent.source.site [ fhir:value "Cloud" ];
     fhir:AuditEvent.source.observer [
       fhir:Reference.identifier [
         fhir:Identifier.value [ fhir:value "hl7connect.healthintersections.com.au" ]

     ] ) ; #   Source active participant, the software making the . AlternativeUserId - Process ID  
     fhir:type [
       fhir:coding ( [
         fhir:system [ fhir:v "http://dicom.nema.org/resources/ontology/DCM"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "110153" ] ;
         fhir:display [ fhir:v "Source Role ID" ]
       ] )
     ] ;
     fhir:who [
       fhir:identifier [
         fhir:system [ fhir:v "urn:oid:2.16.840.1.113883.4.2"^^xsd:anyURI ] ;
         fhir:value [ fhir:v "2.16.840.1.113883.4.2" ]

       ]
     ];
     fhir:AuditEvent.source.type [
       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.type [
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/audit-entity-type" ];
       fhir:Coding.code [ fhir:value "2" ];
       fhir:Coding.display [ fhir:value "System Object" ]
     ];
     fhir:AuditEvent.entity.detail [
       fhir:index 0;
       fhir:AuditEvent.entity.detail.type [ fhir:value "requested transaction" ];
       fhir:AuditEvent.entity.detail.valueString [ fhir:value "http POST ....." ]
     ]
  ], [
     fhir:index 1;
     fhir:AuditEvent.entity.what [
       fhir:Reference.reference [ fhir:value "#o1" ]
     ];
     fhir:AuditEvent.entity.type [
       fhir:Coding.system [ fhir:value "http://hl7.org/fhir/resource-types" ];
       fhir:Coding.code [ fhir:value "OperationOutcome" ];
       fhir:Coding.display [ fhir:value "OperationOutcome" ]
     ];
     fhir:AuditEvent.entity.description [ fhir:value "transaction failed" ]
  ] .

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

<http://hl7.org/fhir/AuditEvent/example-error.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://build.fhir.org/AuditEvent/example-error.ttl> .

     ] ;
     fhir:requestor [ fhir:v "false"^^xsd:boolean ] ;
     fhir:network [ fhir:v "Workstation1.ehr.familyclinic.com" ]
  ] ) ; # 
  fhir:source [
     fhir:observer [
       fhir:identifier [
         fhir:value [ fhir:v "hl7connect.healthintersections.com.au" ]
       ] ;
       fhir:display [ fhir:v "Cloud" ]
     ] ;
     fhir:type ( [
       fhir:coding ( [
         fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/security-source-type"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "3" ] ;
         fhir:display [ fhir:v "Web Server" ]
       ] )
     ] )
  ] ; # 
  fhir:entity ( [
     fhir:what [
       fhir:reference [ fhir:v "#o1" ] ;
       fhir:display [ fhir:v "transaction failed" ]
     ] #   record the OperationOutcome returned to the client  
  ] )] . # 


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

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.