Data Model Libraries
    Preparing search index...

    Class AuditEventEntityComponent

    AuditEventEntityComponent Class

    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 AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    what? type_? role? lifecycle? securityLabel? name? description? query? detail?

    Methods

    parse getWhat setWhat hasWhat getType setType hasType getRole setRole hasRole getLifecycle setLifecycle hasLifecycle getSecurityLabel setSecurityLabel addSecurityLabel hasSecurityLabel getNameElement setNameElement hasNameElement getName setName hasName getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getQueryElement setQueryElement hasQueryElement getQuery setQuery hasQuery getDetail setDetail addDetail hasDetail fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initSecurityLabel initDetail

    Constructors

    Properties

    what?: Reference

    AuditEvent.entity.what Element

    FHIR Specification

    • Short: Specific instance of resource
    • Definition: Identifies a specific instance of the entity. The reference should be version specific.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: Coding

    AuditEvent.entity.type Element

    FHIR Specification

    • Short: Type of entity involved
    • Definition: The type of the object that was involved in this audit event.
    • Comment: This value is distinct from the user's role or any user relationship to the entity.
    • Requirements: To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    role?: Coding

    AuditEvent.entity.role Element

    FHIR Specification

    • Short: What role the entity played
    • Definition: Code representing the role the entity played in the event being audited.
    • Requirements: For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lifecycle?: Coding

    AuditEvent.entity.lifecycle Element

    FHIR Specification

    • Short: Life-cycle stage for the entity
    • Definition: Identifier for the data life-cycle stage for the entity.
    • Comment: This can be used to provide an audit trail for data, over time, as it passes through the system.
    • Requirements: Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    securityLabel?: Coding[]

    AuditEvent.entity.securityLabel Element

    FHIR Specification

    • Short: Security labels on the entity
    • Definition: Security labels for the identified entity.
    • Comment: Copied from entity meta security tags.
    • Requirements: This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    name?: StringType

    AuditEvent.entity.name Element

    FHIR Specification

    • Short: Descriptor for entity
    • Definition: A name of the entity in the audit event.
    • Comment: This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.
    • Requirements: Use only where entity can't be identified with an identifier.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    AuditEvent.entity.description Element

    FHIR Specification

    • Short: Descriptive text
    • Definition: Text that describes the entity in more detail.
    • Requirements: Use only where entity can't be identified with an identifier.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    query?: Base64BinaryType

    AuditEvent.entity.query Element

    FHIR Specification

    • Short: Query parameters
    • Definition: The query parameters for a query-type entities.
    • Comment: The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.
    • Requirements: For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    detail?: AuditEventEntityDetailComponent[]

    AuditEvent.entity.detail Element

    FHIR Specification

    • Short: Additional Information about the entity
    • Definition: Tagged value pairs for conveying additional information about the entity.
    • Requirements: Implementation-defined data about specific details of the object accessed or used.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEventEntityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AuditEventEntityComponent

      AuditEventEntityComponent data model or undefined for AuditEventEntityComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; 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
    parsegetWhatsetWhathasWhatgetTypesetTypehasTypegetRolesetRolehasRolegetLifecyclesetLifecyclehasLifecyclegetSecurityLabelsetSecurityLabeladdSecurityLabelhasSecurityLabelgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetQueryElementsetQueryElementhasQueryElementgetQuerysetQueryhasQuerygetDetailsetDetailaddDetailhasDetailfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitSecurityLabelinitDetail