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? role? securityLabel? query? detail? agent?

    Methods

    parse getWhat setWhat hasWhat getRole setRole hasRole getSecurityLabel setSecurityLabel addSecurityLabel hasSecurityLabel getQueryElement setQueryElement hasQueryElement getQuery setQuery hasQuery getDetail setDetail addDetail hasDetail getAgent setAgent addAgent hasAgent 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 initAgent

    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. This is allowed to be a Parameters resource.
    • Comment: Use .what.display when all you have is a string (e.g. ParticipantObjectName).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    role?: CodeableConcept

    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: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    securityLabel?: CodeableConcept[]

    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: CodeableConcept
    • Cardinality: 0..*
    • 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, 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. The DICOM AuditMessage schema does not support both .name and .query being populated.
    • 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
    agent?: AuditEventAgentComponent[]

    AuditEvent.entity.agent Element

    FHIR Specification

    • Short: Entity is attributed to this agent
    • Definition: The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.
    • Comment: A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.
    • 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