AuditEvent - FHIR Resource (stu3)


This AuditEvent Resource uses the FHIR API standard for access and structure.

Validate an AuditEvent FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
actionfalsecode# Type of action performed during the event
agenttrueData Type# Actor involved in the event
entitytrueData Type# Data or objects used
outcomefalsecode# Whether the event succeeded or failed
outcomeDescfalsestring# Description of the event outcome
purposeOfEventtrueCodeableConcept# The purposeOfUse of the event
recordedfalseinstant# Time when the event occurred on source
sourcefalseData Type# Audit Event Reporter
subtypetrueCoding# More specific type/id for the event
typefalseCoding# Type/identifier of event

AuditEvent Example

{
  "source": {
    "identifier": {
      "value": "Grahame's Laptop"
    },
    "type": [
      {
        "code": "110122",
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "display": "Login"
      }
    ],
    "site": "Development"
  },
  "resourceType": "AuditEvent",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Application Start for under service login &quot;Grahame&quot; (id: Grahame's Test HL7Connect)</div>"
  },
  "recorded": "2012-10-25T22:04:27+11:00",
  "agent": [
    {
      "userId": {
        "value": "Grahame"
      },
      "role": [
        {
          "text": "Service User (Logon)"
        }
      ],
      "network": {
        "type": "2",
        "address": "127.0.0.1"
      },
      "requestor": false
    },
    {
      "userId": {
        "value": "2.16.840.1.113883.4.2|2.16.840.1.113883.4.2"
      },
      "role": [
        {
          "coding": [
            {
              "code": "110153",
              "system": "http://dicom.nema.org/resources/ontology/DCM",
              "display": "Source Role ID"
            }
          ]
        }
      ],
      "requestor": false,
      "network": {
        "type": "1",
        "address": "Workstation1.ehr.familyclinic.com"
      },
      "altId": "6580"
    }
  ],
  "entity": [
    {
      "role": {
        "code": "4",
        "system": "http://hl7.org/fhir/object-role",
        "display": "Domain Resource"
      },
      "identifier": {
        "type": {
          "text": "Dell Serial Number",
          "coding": [
            {
              "code": "SNO",
              "system": "http://hl7.org/fhir/identifier-type"
            }
          ]
        },
        "value": "ABCDEF"
      },
      "type": {
        "code": "4",
        "system": "http://hl7.org/fhir/object-type",
        "display": "Other"
      },
      "lifecycle": {
        "code": "6",
        "system": "http://hl7.org/fhir/dicom-audit-lifecycle",
        "display": "Access / Use"
      },
      "name": "Grahame's Laptop"
    }
  ],
  "subtype": [
    {
      "code": "110120",
      "system": "http://dicom.nema.org/resources/ontology/DCM",
      "display": "Application Start"
    }
  ],
  "action": "E",
  "outcome": "0",
  "type": {
    "code": "110100",
    "system": "http://dicom.nema.org/resources/ontology/DCM",
    "display": "Application Activity"
  },
  "id": "example"
}

AuditEvent Structure


  
{
  "resourceType" : "AuditEvent",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "type" : { Coding }, // R!  Type/identifier of event
  "subtype" : [{ Coding }], // More specific type/id for the event
  "action" : "<code>", // Type of action performed during the event
  "recorded" : "<instant>", // R!  Time when the event occurred on source
  "outcome" : "<code>", // Whether the event succeeded or failed
  "outcomeDesc" : "<string>", // Description of the event outcome
  "purposeOfEvent" : [{ CodeableConcept }], // The purposeOfUse of the event
  "agent" : [{ // R!  Actor involved in the event
    "role" : [{ CodeableConcept }], // Agent role in the event
    "reference" : { Reference(Practitioner|Organization|Device|Patient|
    RelatedPerson) }, // Direct reference to resource
    "userId" : { Identifier }, // Unique identifier for the user
    "altId" : "<string>", // Alternative User id e.g. authentication
    "name" : "<string>", // Human-meaningful name for the agent
    "requestor" : <boolean>, // R!  Whether user is initiator
    "location" : { Reference(Location) }, // Where
    "policy" : ["<uri>"], // Policy that authorized event
    "media" : { Coding }, // Type of media
    "network" : { // Logical network location for application activity
      "address" : "<string>", // Identifier for the network access point of the user device
      "type" : "<code>" // The type of network access point
    },
    "purposeOfUse" : [{ CodeableConcept }] // Reason given for this user
  }],
  "source" : { // R!  Audit Event Reporter
    "site" : "<string>", // Logical source location within the enterprise
    "identifier" : { Identifier }, // R!  The identity of source detecting the event
    "type" : [{ Coding }] // The type of source where event originated
  },
  "entity" : [{ // Data or objects used
    "identifier" : { Identifier }, // Specific instance of object
    "reference" : { Reference(Any) }, // Specific instance of resource
    "type" : { Coding }, // Type of entity involved
    "role" : { Coding }, // What role the entity played
    "lifecycle" : { Coding }, // Life-cycle stage for the entity
    "securityLabel" : [{ Coding }], // Security labels on the entity
    "name" : "<string>", // C? Descriptor for entity
    "description" : "<string>", // Descriptive text
    "query" : "<base64Binary>", // C? Query parameters
    "detail" : [{ // Additional Information about the entity
      "type" : "<string>", // R!  Name of the property
      "value" : "<base64Binary>" // R!  Property value
    }]
  }]
}


 

AuditEvent Search Parameters

The following search parameters can be used to query AuditEvent resources. Just submit the like so:

https://api.1up.health/fhir/stu3/AuditEvent?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actiontextaction
addresstextagent.network.address
agentreferenceagent.reference
agent-nametextagent.name
agent-roletextagent.role
altidtextagent.altId
datedaterecorded
entityreferenceentity.reference
entity-idtextentity.identifier
entity-nametextentity.name
entity-roletextentity.role
entity-typetextentity.type
outcometextoutcome
patientreferenceagent.reference, entity.reference
policyuriagent.policy
sitetextsource.site
sourcetextsource.identifier
subtypetextsubtype
typetexttype
usertextagent.userId