Data Model Libraries
    Preparing search index...

    Class AuditEvent

    AuditEvent Class

    A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

    FHIR Specification

    • Short: Event record kept for security purposes
    • Definition: A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
    • Comment: Based on IHE-ATNA.
    • FHIR Version: 4.0.1

    FHIR AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_ subtype? auditEventActionEnum action? period? recorded auditEventOutcomeEnum outcome? outcomeDesc? purposeOfEvent? agent source entity?

    Methods

    parse getType setType hasType getSubtype setSubtype addSubtype hasSubtype getActionEnumType setActionEnumType hasActionEnumType getActionElement setActionElement hasActionElement getAction setAction hasAction getPeriod setPeriod hasPeriod getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getOutcomeEnumType setOutcomeEnumType hasOutcomeEnumType getOutcomeElement setOutcomeElement hasOutcomeElement getOutcome setOutcome hasOutcome getOutcomeDescElement setOutcomeDescElement hasOutcomeDescElement getOutcomeDesc setOutcomeDesc hasOutcomeDesc getPurposeOfEvent setPurposeOfEvent addPurposeOfEvent hasPurposeOfEvent getAgent setAgent addAgent hasAgent getSource setSource hasSource getEntity setEntity addEntity hasEntity fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initSubtype initPurposeOfEvent initAgent initEntity

    Constructors

    Properties

    Privatetype_

    type_: null | Coding

    AuditEvent.type Element

    FHIR Specification

    • Short: Type/identifier of event
    • Definition: 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.
    • Requirements: This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subtype?: Coding[]

    AuditEvent.subtype Element

    FHIR Specification

    • Short: More specific type/id for the event
    • Definition: Identifier for the category of event.
    • Requirements: This field enables queries of messages by implementation-defined event categories.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    auditEventActionEnum: AuditEventActionEnum

    FHIR CodeSystem: AuditEventAction

    AuditEventActionEnum

    action?: EnumCodeType

    AuditEvent.action Element

    FHIR Specification

    • Short: Type of action performed during the event
    • Definition: Indicator for type of action performed during the event that generated the audit.
    • Requirements: This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AuditEventActionEnum

    period?: Period

    AuditEvent.period Element

    FHIR Specification

    • Short: When the activity occurred
    • Definition: The period during which the activity occurred.
    • Comment: The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recorded: null | InstantType

    AuditEvent.recorded Element

    FHIR Specification

    • Short: Time when the event was recorded
    • Definition: The time when the event was recorded.
    • Comment: In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
    • Requirements: This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.
    • FHIR Type: instant
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    auditEventOutcomeEnum: AuditEventOutcomeEnum

    FHIR CodeSystem: AuditEventOutcome

    AuditEventOutcomeEnum

    outcome?: EnumCodeType

    AuditEvent.outcome Element

    FHIR Specification

    • Short: Whether the event succeeded or failed
    • Definition: Indicates whether the event succeeded or failed.
    • Comment: In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AuditEventOutcomeEnum

    outcomeDesc?: StringType

    AuditEvent.outcomeDesc Element

    FHIR Specification

    • Short: Description of the event outcome
    • Definition: A free text description of the outcome of the event.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    purposeOfEvent?: CodeableConcept[]

    AuditEvent.purposeOfEvent Element

    FHIR Specification

    • Short: The purposeOfUse of the event
    • Definition: The purposeOfUse (reason) that was used during the event being recorded.
    • Comment: Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    agent: null | AuditEventAgentComponent[]

    AuditEvent.agent Element

    FHIR Specification

    • Short: Actor involved in the event
    • Definition: An actor taking an active role in the event or activity that is logged.
    • Comment: Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
    • Requirements: An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    source: null | AuditEventSourceComponent

    AuditEvent.source Element

    FHIR Specification

    • Short: Audit Event Reporter
    • Definition: The system that is reporting the event.
    • Comment: Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.
    • Requirements: The event is reported by one source.
    • FHIR Type: BackboneElement
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    entity?: AuditEventEntityComponent[]

    AuditEvent.entity Element

    FHIR Specification

    • Short: Data or objects used
    • Definition: Specific instances of data or objects that have been accessed.
    • Comment: Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
    • Requirements: The event may have other entities involved.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided AuditEvent JSON to instantiate the AuditEvent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEvent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to AuditEvent

      Returns undefined | AuditEvent

      AuditEvent data model or undefined for AuditEvent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetTypesetTypehasTypegetSubtypesetSubtypeaddSubtypehasSubtypegetActionEnumTypesetActionEnumTypehasActionEnumTypegetActionElementsetActionElementhasActionElementgetActionsetActionhasActiongetPeriodsetPeriodhasPeriodgetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetOutcomeEnumTypesetOutcomeEnumTypehasOutcomeEnumTypegetOutcomeElementsetOutcomeElementhasOutcomeElementgetOutcomesetOutcomehasOutcomegetOutcomeDescElementsetOutcomeDescElementhasOutcomeDescElementgetOutcomeDescsetOutcomeDeschasOutcomeDescgetPurposeOfEventsetPurposeOfEventaddPurposeOfEventhasPurposeOfEventgetAgentsetAgentaddAgenthasAgentgetSourcesetSourcehasSourcegetEntitysetEntityaddEntityhasEntityfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitSubtypeinitPurposeOfEventinitAgentinitEntity