Data Model Libraries
    Preparing search index...

    Class AuditEvent

    AuditEvent Class

    A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.

    FHIR Specification

    • Short: Record of an event
    • Definition: A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
    • Comment: Based on IHE-ATNA.
    • FHIR Version: 5.0.0

    FHIR AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    category? code auditEventActionEnum action? auditEventSeverityEnum severity? occurred? recorded outcome? authorization? basedOn? patient? encounter? agent source entity?

    Methods

    parse getCategory setCategory addCategory hasCategory getCode setCode hasCode getActionEnumType setActionEnumType hasActionEnumType getActionElement setActionElement hasActionElement getAction setAction hasAction getSeverityEnumType setSeverityEnumType hasSeverityEnumType getSeverityElement setSeverityElement hasSeverityElement getSeverity setSeverity hasSeverity getOccurred setOccurred hasOccurred getOccurredPeriod hasOccurredPeriod getOccurredDateTimeType hasOccurredDateTimeType getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getOutcome setOutcome hasOutcome getAuthorization setAuthorization addAuthorization hasAuthorization getBasedOn setBasedOn addBasedOn hasBasedOn getPatient setPatient hasPatient getEncounter setEncounter hasEncounter 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 initCategory initAuthorization initBasedOn initAgent initEntity

    Constructors

    Properties

    category?: CodeableConcept[]

    AuditEvent.category Element

    FHIR Specification

    • Short: Type/identifier of event
    • Definition: Classification of the type of event.
    • Requirements: Codes that classify the general type of event that happened.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code: null | CodeableConcept

    AuditEvent.code Element

    FHIR Specification

    • Short: Specific type of event
    • Definition: Describes what happened. The most specific code for the event.
    • Requirements: This field enables queries of messages by implementation-defined event categories.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • 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

    auditEventSeverityEnum: AuditEventSeverityEnum

    FHIR CodeSystem: AuditEventSeverity

    AuditEventSeverityEnum

    severity?: EnumCodeType

    AuditEvent.severity Element

    FHIR Specification

    • Short: emergency | alert | critical | error | warning | notice | informational | debug
    • Definition: Indicates and enables segmentation of various severity including debugging from critical.
    • Comment: ATNA will map this to the SYSLOG PRI element.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AuditEventSeverityEnum

    occurred?: IDataType

    AuditEvent.occurred[x] Element

    @ChoiceDataTypesMeta('AuditEvent.occurred[x]', ['Period','dateTime',]

    FHIR Specification

    • Short: When the activity occurred
    • Definition: The time or period during which the activity occurred.
    • Comment: The time or period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
    • FHIR Types: 'Period', 'dateTime',
    • 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
    outcome?: AuditEventOutcomeComponent

    AuditEvent.outcome Element

    FHIR Specification

    • Short: Whether the event succeeded or failed
    • Definition: Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.
    • 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.
    • Requirements: when a code is given there must be one code from the given codeSystem, and may be other equivilant codes from other codeSystems (for example http response codes such as 2xx, 4xx, or 5xx).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authorization?: CodeableConcept[]

    AuditEvent.authorization Element

    FHIR Specification

    • Short: Authorization related to the event
    • Definition: The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
    • Comment: Use AuditEvent.agent.authorization when you know that it is specific to the agent, otherwise use AuditEvent.authorization. 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.
    • Requirements: Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    AuditEvent.basedOn Element

    FHIR Specification

    patient?: Reference

    AuditEvent.patient Element

    FHIR Specification

    • Short: The patient is the subject of the data used/created/updated/deleted during the activity
    • Definition: The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.
    • Requirements: When the .patient is populated it shall be accurate to the subject of the used data. The .patient shall not be populated when the used data used/created/updated/deleted (.entity) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    encounter?: Reference

    AuditEvent.encounter Element

    FHIR Specification

    • Short: Encounter within which this event occurred or which the event is tightly associated
    • Definition: 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).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    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. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
    • 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: true
    source: null | AuditEventSourceComponent

    AuditEvent.source Element

    FHIR Specification

    • Short: Audit Event Reporter
    • Definition: The actor that is reporting the event.
    • Comment: Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.
    • Requirements: The event is reported by one source.
    • FHIR Type: BackboneElement
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    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: true

    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 Reference array value to the basedOn property.

      Parameters

      • value: undefined | Reference[]

        the basedOn array value

      Returns this

      this

      @ReferenceTargets('AuditEvent.basedOn', ['CarePlan','DeviceRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest','Task',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the basedOn array property.

      Parameters

      • value: undefined | Reference

        the basedOn value

      Returns this

      this

      @ReferenceTargets('AuditEvent.basedOn', ['CarePlan','DeviceRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest','Task',])

      InvalidTypeError for invalid data type or reference value

    • 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
    parsegetCategorysetCategoryaddCategoryhasCategorygetCodesetCodehasCodegetActionEnumTypesetActionEnumTypehasActionEnumTypegetActionElementsetActionElementhasActionElementgetActionsetActionhasActiongetSeverityEnumTypesetSeverityEnumTypehasSeverityEnumTypegetSeverityElementsetSeverityElementhasSeverityElementgetSeveritysetSeverityhasSeveritygetOccurredsetOccurredhasOccurredgetOccurredPeriodhasOccurredPeriodgetOccurredDateTimeTypehasOccurredDateTimeTypegetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetOutcomesetOutcomehasOutcomegetAuthorizationsetAuthorizationaddAuthorizationhasAuthorizationgetBasedOnsetBasedOnaddBasedOnhasBasedOngetPatientsetPatienthasPatientgetEncountersetEncounterhasEncountergetAgentsetAgentaddAgenthasAgentgetSourcesetSourcehasSourcegetEntitysetEntityaddEntityhasEntityfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitCategoryinitAuthorizationinitBasedOninitAgentinitEntity