Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). 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

Audit-event-example-vread.json

Example AuditEvent/example-rest (JSON)

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

Raw JSON ( canonical form + also see JSON Format Specification )

RESTful vread Operation 

{
  "resourceType": "AuditEvent",
  "id": "example-rest",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example-rest</p><p><b>type</b>: Restful Operation (Details: http://terminology.hl7.org/CodeSystem/audit-event-type code rest = 'RESTful Operation', stated as 'Restful Operation')</p><p><b>subtype</b>: vread (Details: http://hl7.org/fhir/restful-interaction code vread = 'vread', stated as 'vread')</p><p><b>action</b>: R</p><p><b>recorded</b>: 20/06/2013 11:42:24 PM</p><p><b>outcome</b>: 0</p><blockquote><p><b>agent</b></p><p><b>type</b>: human user <span>(Details : {http://terminology.hl7.org/CodeSystem/extra-security-role-type code 'humanuser' = 'human user', given as 'human user'})</span></p><p><b>who</b>: </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>: Source Role ID <span>(Details : {DICOM code '110153' = 'Source Role ID', given as 'Source Role ID'})</span></p><p><b>who</b>: </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/><td>Web Server (Details: http://terminology.hl7.org/CodeSystem/security-source-type code 3 = 'Web Server', stated as 'Web Server')</td></tr></table><h3>Entities</h3><table><tr><td>-</td><td><b>What</b></td><td><b>Type</b></td><td><b>Lifecycle</b></td></tr><tr><td>*</td><td><a>Patient/example/_history/1</a></td><td>System Object (Details: http://terminology.hl7.org/CodeSystem/audit-entity-type code 2 = 'System Object', stated as 'System Object')</td><td>Access / Use (Details: http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle code 6 = 'Access / Use', stated as 'Access / Use')</td></tr></table></div>"

  "resourceType" : "AuditEvent",
  "id" : "example-rest",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: AuditEvent</b><a name=\"example-rest\"> </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&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/5.1.0/CodeSystem-audit-event-type.html\">Audit Event ID</a>#rest)</span></p><p><b>code</b>: vread <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-restful-interaction.html\">FHIR Restful Interactions</a>#vread)</span></p><p><b>action</b>: R</p><p><b>recorded</b>: 21 June 2013, 9:42:24 am</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/5.1.0/CodeSystem-extra-security-role-type.html\">Security Role Type</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:\u00a06580</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/5.1.0/CodeSystem-security-source-type.html\">Audit Event Source Type</a>#3)</span></td></tr></table><h3>Entities</h3><table class=\"grid\"><tr><td>-</td><td><b>What</b></td><td><b>Role</b></td></tr><tr><td>*</td><td><a href=\"patient-example.html\">Patient/example/_history/1</a> &quot;Peter CHALMERS&quot;</td><td>Patient <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-object-role.html\">AuditEventEntityRole</a>#1)</span></td></tr></table></div>"

  },
  "type": {
    "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "code": "rest",
    "display": "Restful Operation"

  "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" : "vread",
      "display" : "vread"
    }]

  },
  "subtype": [
    {
      "system": "http://hl7.org/fhir/restful-interaction",
      "code": "vread",
      "display": "vread"

  "action" : "R",
  "recorded" : "2013-06-20T23:42:24Z",
  "outcome" : {
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome",
      "code" : "0",
      "display" : "Success"

    }
  ],
  "action": "R",
  "recorded": "2013-06-20T23:42:24Z",
  "outcome": "0",
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
            "code": "humanuser",
            "display": "human user"
          }
        ]
      },
      "who": {
        "identifier": {
          "value": "95"
        }
      },
      "altId": "601847123",
      "name": "Grahame Grieve",
      "requestor": true

  },
  "agent" : [{
    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
        "code" : "humanuser",
        "display" : "human user"
      }]

    },
    {
      "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"
        }
      },
      "altId": "6580",
      "requestor": false,
      "network": {
        "address": "Workstation1.ehr.familyclinic.com",
        "type": "1"

    "who" : {
      "identifier" : {
        "value" : "95"

      }
    }
  ],
  "source": {
    "site": "Cloud",
    "observer": {
      "identifier": {
        "value": "hl7connect.healthintersections.com.au"

    },
    "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"
      }]

    },
    "type": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
        "code": "3",
        "display": "Web Server"

    "who" : {
      "identifier" : {
        "system" : "urn:oid:2.16.840.1.113883.4.2",
        "value" : "2.16.840.1.113883.4.2"

      }
    ]
  },
  "entity": [
    {
      "what": {
        "reference": "Patient/example/_history/1"
      },
      "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-entity-type",
        "code": "2",
        "display": "System Object"
      },
      "lifecycle": {
        "system": "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle",
        "code": "6",
        "display": "Access / Use"

    },
    "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"
      }]

    }
  ]

  }]

}

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.