6.4.12 JSON Schema for AuditEvent

Security Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Patient, Practitioner

This is a representation of the json schema for AuditEvent, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/AuditEvent",
  "$ref": "#/definitions/AuditEvent",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "AuditEvent": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "resourceType": {
          "description": "This is a AuditEvent resource",
          "const": "AuditEvent"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "type": {
          "description": "Identifier for a family of the event.  For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "subtype": {
          "description": "Identifier for the category of event.",
          "items": {
            "$ref": "Coding.schema.json#/definitions/Coding"
          },
          "type": "array"
        },
        "action": {
          "description": "Indicator for type of action performed during the event that generated the audit.",
          "$ref": "#/definitions/code"
        },
        "_action": {
          "description": "Extensions for action",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "severity": {
          "description": "Indicates and enables segmentation of various severity including debugging from critical.",
          "$ref": "#/definitions/code"
        },
        "_severity": {
          "description": "Extensions for severity",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "period": {
          "description": "The period during which the activity occurred.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "recorded": {
          "description": "The time when the event was recorded.",
          "$ref": "#/definitions/instant"
        },
        "_recorded": {
          "description": "Extensions for recorded",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "outcome": {
          "description": "Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "purposeOfEvent": {
          "description": "The purposeOfUse (reason) that was used during the event being recorded.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "basedOn": {
          "description": "Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "encounter": {
          "description": "This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "agent": {
          "description": "An actor taking an active role in the event or activity that is logged.",
          "items": {
            "$ref": "#/definitions/AuditEvent_Agent"
          },
          "type": "array"
        },
        "source": {
          "description": "The system that is reporting the event.",
          "$ref": "#/definitions/AuditEvent_Source"
        },
        "entity": {
          "description": "Specific instances of data or objects that have been accessed.",
          "items": {
            "$ref": "#/definitions/AuditEvent_Entity"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "agent",
        "source",
        "type",
        "resourceType"
      ]
    },
    "AuditEvent_Agent": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "type": {
          "description": "Specification of the participation type the user plays when performing the event.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "role": {
          "description": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "who": {
          "description": "Reference to who this agent is that was involved in the event.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "altId": {
          "description": "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.",
          "$ref": "#/definitions/string"
        },
        "_altId": {
          "description": "Extensions for altId",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "name": {
          "description": "Human-meaningful name for the agent.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "requestor": {
          "description": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
          "$ref": "#/definitions/boolean"
        },
        "_requestor": {
          "description": "Extensions for requestor",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "location": {
          "description": "Where the event occurred.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "policy": {
          "description": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
          "items": {
            "$ref": "#/definitions/uri"
          },
          "type": "array"
        },
        "_policy": {
          "description": "Extensions for policy",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "media": {
          "description": "Type of media involved. Used when the event is about exporting/importing onto media.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "network": {
          "description": "Logical network location for application activity, if the activity has a network location.",
          "$ref": "#/definitions/AuditEvent_Network"
        },
        "purposeOfUse": {
          "description": "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "AuditEvent_Network": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "address": {
          "description": "An identifier for the network access point of the user device for the audit event.",
          "$ref": "#/definitions/string"
        },
        "_address": {
          "description": "Extensions for address",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "An identifier for the type of network access point that originated the audit event.",
          "$ref": "#/definitions/code"
        },
        "_type": {
          "description": "Extensions for type",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "AuditEvent_Source": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "site": {
          "description": "Logical source location within the healthcare enterprise network.  For example, a hospital or other provider location within a multi-entity provider group.",
          "$ref": "#/definitions/string"
        },
        "_site": {
          "description": "Extensions for site",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "observer": {
          "description": "Identifier of the source where the event was detected.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "type": {
          "description": "Code specifying the type of source where event originated.",
          "items": {
            "$ref": "Coding.schema.json#/definitions/Coding"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "observer"
      ]
    },
    "AuditEvent_Entity": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "what": {
          "description": "Identifies a specific instance of the entity. The reference should be version specific.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "type": {
          "description": "The type of the object that was involved in this audit event.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "role": {
          "description": "Code representing the role the entity played in the event being audited.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "lifecycle": {
          "description": "Identifier for the data life-cycle stage for the entity.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "securityLabel": {
          "description": "Security labels for the identified entity.",
          "items": {
            "$ref": "Coding.schema.json#/definitions/Coding"
          },
          "type": "array"
        },
        "name": {
          "description": "A name of the entity in the audit event.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "query": {
          "description": "The query parameters for a query-type entities.",
          "$ref": "#/definitions/base64Binary"
        },
        "_query": {
          "description": "Extensions for query",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "detail": {
          "description": "Tagged value pairs for conveying additional information about the entity.",
          "items": {
            "$ref": "#/definitions/AuditEvent_Detail"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "AuditEvent_Detail": {
      "description": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "type": {
          "description": "The type of extra detail provided in the value.",
          "$ref": "#/definitions/string"
        },
        "_type": {
          "description": "Extensions for type",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueString": {
          "description": "The  value of the extra detail.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_valueString": {
          "description": "Extensions for valueString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueBase64Binary": {
          "description": "The  value of the extra detail.",
          "pattern": "^(\\s*([0-9a-zA-Z*\\/*\\+\\\u003d]){4}\\s*)+$",
          "type": "string"
        },
        "_valueBase64Binary": {
          "description": "Extensions for valueBase64Binary",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}