AuditEvent - FHIR Resource (r4)
This AuditEvent Resource uses the FHIR API standard for access and structure.
Validate an AuditEvent FHIR Resource (r4)
AuditEvent Attributes
AttributeField is listTypeDescription
Description: Type/identifier of event
FHIR Version: r4
Attribute Type : Coding
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110100",
"display": "Application Activity"
}Learn more about the (AuditEvent) type FHIR attribute
Description: More specific type/id for the event
FHIR Version: r4
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subtype": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110120",
"display": "Application Start"
}
]Learn more about the (AuditEvent) subtype FHIR attribute
Description: Type of action performed during the event
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"action": "E"Learn more about the (AuditEvent) action FHIR attribute
Description: When the activity occurred
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (AuditEvent) period FHIR attribute
Description: Time when the event was recorded
FHIR Version: r4
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recorded": "2012-10-25T22:04:27+11:00"Learn more about the (AuditEvent) recorded FHIR attribute
Description: Whether the event succeeded or failed
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcome": "0"Learn more about the (AuditEvent) outcome FHIR attribute
Description: Description of the event outcome
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcomeDesc": Learn more about the (AuditEvent) outcomeDesc FHIR attribute
Description: The purposeOfUse of the event
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purposeOfEvent": Learn more about the (AuditEvent) purposeOfEvent FHIR attribute
Description: Actor involved in the event
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code": "humanuser",
"display": "human user"
}
]
},
"role": [
{
"text": "Service User (Logon)"
}
],
"who": {
"identifier": {
"value": "Grahame"
}
},
"requestor": false,
"network": {
"address": "127.0.0.1",
"type": "2"
}
},
{
"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"
}
}
]Learn more about the (AuditEvent) agent FHIR attribute
Description: Audit Event Reporter
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"source": {
"site": "Development",
"observer": {
"display": "Grahame's Laptop"
},
"type": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110122",
"display": "Login"
}
]
}Learn more about the (AuditEvent) source FHIR attribute
Description: Data or objects used
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"entity": [
{
"what": {
"identifier": {
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SNO"
}
],
"text": "Dell Serial Number"
},
"value": "ABCDEF"
}
},
"type": {
"system": "http://terminology.hl7.org/CodeSystem/audit-entity-type",
"code": "4",
"display": "Other"
},
"role": {
"system": "http://terminology.hl7.org/CodeSystem/object-role",
"code": "4",
"display": "Domain Resource"
},
"lifecycle": {
"system": "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle",
"code": "6",
"display": "Access / Use"
},
"name": "Grahame's Laptop"
}
]Learn more about the (AuditEvent) entity FHIR attribute
AuditEvent Example
{
"resourceType": "AuditEvent",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Application Start for under service login "Grahame" (id: Grahame's Test HL7Connect)</div>"
},
"type": {
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110100",
"display": "Application Activity"
},
"subtype": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110120",
"display": "Application Start"
}
],
"action": "E",
"recorded": "2012-10-25T22:04:27+11:00",
"outcome": "0",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code": "humanuser",
"display": "human user"
}
]
},
"role": [
{
"text": "Service User (Logon)"
}
],
"who": {
"identifier": {
"value": "Grahame"
}
},
"requestor": false,
"network": {
"address": "127.0.0.1",
"type": "2"
}
},
{
"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"
}
}
],
"source": {
"site": "Development",
"observer": {
"display": "Grahame's Laptop"
},
"type": [
{
"system": "http://dicom.nema.org/resources/ontology/DCM",
"code": "110122",
"display": "Login"
}
]
},
"entity": [
{
"what": {
"identifier": {
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SNO"
}
],
"text": "Dell Serial Number"
},
"value": "ABCDEF"
}
},
"type": {
"system": "http://terminology.hl7.org/CodeSystem/audit-entity-type",
"code": "4",
"display": "Other"
},
"role": {
"system": "http://terminology.hl7.org/CodeSystem/object-role",
"code": "4",
"display": "Domain Resource"
},
"lifecycle": {
"system": "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle",
"code": "6",
"display": "Access / Use"
},
"name": "Grahame's Laptop"
}
]
}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
"period" : { Period }, // When the activity occurred
"recorded" : "<instant>", // R! Time when the event was recorded
"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
"type" : { CodeableConcept }, // How agent participated
"role" : [{ CodeableConcept }], // Agent role in the event
"who" : { Reference(PractitionerRole|Practitioner|Organization|Device|
Patient|RelatedPerson) }, // Identifier of who
"altId" : "<string>", // Alternative User identity
"name" : "<string>", // Human friendly 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
"observer" : { Reference(PractitionerRole|Practitioner|Organization|Device|
Patient|RelatedPerson) }, // R! The identity of source detecting the event
"type" : [{ Coding }] // The type of source where event originated
},
"entity" : [{ // Data or objects used
"what" : { 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[x]: Property value. One of these 2:
"valueString" : "<string>"
"valueBase64Binary" : "<base64Binary>"
}]
}]
}
AuditEvent Search Parameters
The following search parameters can be used to query AuditEvent resources. Just submit them like so:
https://api.1up.health/fhir/r4/AuditEvent?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
action | text | action |
address | text | agent.network.address |
agent | reference | agent.who |
agent-name | text | agent.name |
agent-role | text | agent.role |
altid | text | agent.altId |
date | date | recorded |
entity | reference | entity.what |
entity-name | text | entity.name |
entity-role | text | entity.role |
entity-type | text | entity.type |
outcome | text | outcome |
patient | reference | agent.who.where |
policy | uri | agent.policy |
site | text | source.site |
source | reference | source.observer |
subtype | text | subtype |
type | text | type |
