AuditEvent - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
eventfalseData Type What was done
objecttrueData Type Specific instances of data or objects that have been accessed
participanttrueData Type A person, a hardware device or software process
sourcefalseData Type Application systems and processes

AuditEvent Structure


  
{
  "resourceType" : "AuditEvent",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "event" : { // R!  What was done
    "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
    "dateTime" : "<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" : [{ Coding }] // The purposeOfUse of the event
  },
  "participant" : [{ // R!  A person, a hardware device or software process
    "role" : [{ CodeableConcept }], // User roles (e.g. local RBAC codes)
    "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 user
    "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" : [{ Coding }] // Reason given for this user
  }],
  "source" : { // R!  Application systems and processes
    "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
  },
  "object" : [{ // Specific instances of data or objects that have been accessed
    "identifier" : { Identifier }, // Specific instance of object (e.g. versioned)
    "reference" : { Reference(Any) }, // Specific instance of resource (e.g. versioned)
    "type" : { Coding }, // Type of object involved
    "role" : { Coding }, // What role the Object played
    "lifecycle" : { Coding }, // Life-cycle stage for the object
    "securityLabel" : [{ Coding }], // Security labels applied to the object
    "name" : "<string>", // C? Instance-specific descriptor for Object
    "description" : "<string>", // Descriptive text
    "query" : "<base64Binary>", // C? Actual query for object
    "detail" : [{ // Additional Information about the Object
      "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/dstu2/AuditEvent?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actiontextevent.action
addresstextparticipant.network.address
altidtextparticipant.altId
datedateevent.dateTime
desctextobject.name
identitytextobject.identifier
nametextparticipant.name
object-typetextobject.type
participantreferenceparticipant.reference
patientreferenceparticipant.reference, AuditEvent.object.reference
policyuriparticipant.policy
referencereferenceobject.reference
sitetextsource.site
sourcetextsource.identifier
subtypetextevent.subtype
typetextevent.type
usertextparticipant.userId