Data Model Libraries
    Preparing search index...

    Class AuditEventAgentComponent

    AuditEventAgentComponent Class

    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 AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? role? who? altId? name? requestor location? policy? media? network? purposeOfUse?

    Methods

    parse getType setType hasType getRole setRole addRole hasRole getWho setWho hasWho getAltIdElement setAltIdElement hasAltIdElement getAltId setAltId hasAltId getNameElement setNameElement hasNameElement getName setName hasName getRequestorElement setRequestorElement hasRequestorElement getRequestor setRequestor hasRequestor getLocation setLocation hasLocation getPolicyElement setPolicyElement addPolicyElement hasPolicyElement getPolicy setPolicy addPolicy hasPolicy getMedia setMedia hasMedia getNetwork setNetwork hasNetwork getPurposeOfUse setPurposeOfUse addPurposeOfUse hasPurposeOfUse fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initRole initPolicy initPurposeOfUse

    Constructors

    Properties

    Private Optionaltype_

    type_?: CodeableConcept

    AuditEvent.agent.type Element

    FHIR Specification

    • Short: How agent participated
    • Definition: Specification of the participation type the user plays when performing the event.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    role?: CodeableConcept[]

    AuditEvent.agent.role Element

    FHIR Specification

    • Short: Agent role in the event
    • Definition: 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.
    • Comment: Should be roles relevant to the event. Should not be an exhaustive list of roles.
    • Requirements: This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    who?: Reference

    AuditEvent.agent.who Element

    FHIR Specification

    altId?: StringType

    AuditEvent.agent.altId Element

    FHIR Specification

    • Short: Alternative User identity
    • Definition: 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.
    • Requirements: In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name?: StringType

    AuditEvent.agent.name Element

    FHIR Specification

    • Short: Human friendly name for the agent
    • Definition: Human-meaningful name for the agent.
    • Requirements: The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requestor: null | BooleanType

    AuditEvent.agent.requestor Element

    FHIR Specification

    • Short: Whether user is initiator
    • Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.
    • Comment: There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
    • Requirements: This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    location?: Reference

    AuditEvent.agent.location Element

    FHIR Specification

    policy?: UriType[]

    AuditEvent.agent.policy Element

    FHIR Specification

    • Short: Policy that authorized event
    • Definition: 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.
    • Comment: For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
    • Requirements: This value is used retrospectively to determine the authorization policies.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    media?: Coding

    AuditEvent.agent.media Element

    FHIR Specification

    • Short: Type of media
    • Definition: Type of media involved. Used when the event is about exporting/importing onto media.
    • Requirements: Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    network?: AuditEventAgentNetworkComponent

    AuditEvent.agent.network Element

    FHIR Specification

    • Short: Logical network location for application activity
    • Definition: Logical network location for application activity, if the activity has a network location.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    purposeOfUse?: CodeableConcept[]

    AuditEvent.agent.purposeOfUse Element

    FHIR Specification

    • Short: Reason given for this user
    • Definition: The reason (purpose of use), specific to this agent, that was used during the event being recorded.
    • Comment: Use AuditEvent.agent.purposeOfUse when you know that 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: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEventAgentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AuditEventAgentComponent

      AuditEventAgentComponent data model or undefined for AuditEventAgentComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Who object value to the who property.

      Parameters

      • value: undefined | Reference

        the who object value

      Returns this

      this

      @ReferenceTargets('AuditEvent.agent.who', ['PractitionerRole','Practitioner','Organization','Device','Patient','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetTypesetTypehasTypegetRolesetRoleaddRolehasRolegetWhosetWhohasWhogetAltIdElementsetAltIdElementhasAltIdElementgetAltIdsetAltIdhasAltIdgetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetRequestorElementsetRequestorElementhasRequestorElementgetRequestorsetRequestorhasRequestorgetLocationsetLocationhasLocationgetPolicyElementsetPolicyElementaddPolicyElementhasPolicyElementgetPolicysetPolicyaddPolicyhasPolicygetMediasetMediahasMediagetNetworksetNetworkhasNetworkgetPurposeOfUsesetPurposeOfUseaddPurposeOfUsehasPurposeOfUsefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitRoleinitPolicyinitPurposeOfUse