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. 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 AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? role? who requestor? location? policy? network? authorization?

    Methods

    parse getType setType hasType getRole setRole addRole hasRole getWho setWho hasWho getRequestorElement setRequestorElement hasRequestorElement getRequestor setRequestor hasRequestor getLocation setLocation hasLocation getPolicyElement setPolicyElement addPolicyElement hasPolicyElement getPolicy setPolicy addPolicy hasPolicy getNetwork setNetwork hasNetwork getNetworkReference hasNetworkReference getNetworkUriType hasNetworkUriType getNetworkStringType hasNetworkStringType getAuthorization setAuthorization addAuthorization hasAuthorization 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 initAuthorization

    Constructors

    Properties

    Private Optionaltype_

    type_?: CodeableConcept

    AuditEvent.agent.type Element

    FHIR Specification

    • Short: How agent participated
    • Definition: The Functional Role of the user when performing the event.
    • Comment: For example: assembler, author, prescriber, signer, investigator, etc.
    • Requirements: Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
    • 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 structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
    • Comment: For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
    • Requirements: Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    who: null | Reference

    AuditEvent.agent.who Element

    FHIR Specification

    requestor?: 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: 0..1
    • isModifier: false
    • isSummary: true
    location?: Reference

    AuditEvent.agent.location Element

    FHIR Specification

    • Short: The agent location when the event occurred
    • Definition: Where the agent location is known, the agent location when the event occurred.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    policy?: UriType[]

    AuditEvent.agent.policy Element

    FHIR Specification

    • Short: Policy that authorized the agent participation in the event
    • Definition: Where the policy(ies) are known that authorized the agent participation in the event. 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
    network?: IDataType

    AuditEvent.agent.network[x] Element

    @ChoiceDataTypesMeta('AuditEvent.agent.network[x]', ['Reference','uri','string',]

    FHIR Specification

    • Short: This agent network location for the activity
    • Definition: When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
    • Comment: When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
    • Requirements: When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
    • FHIR Types: 'Reference', 'uri', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    authorization?: CodeableConcept[]

    AuditEvent.agent.authorization Element

    FHIR Specification

    • Short: Allowable authorization for this agent
    • Definition: The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
    • Comment: Use AuditEvent.agent.authorization when you know that 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: 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 | null | Reference

        the who object value

      Returns this

      this

      @ReferenceTargets('AuditEvent.agent.who', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','Device','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
    parsegetTypesetTypehasTypegetRolesetRoleaddRolehasRolegetWhosetWhohasWhogetRequestorElementsetRequestorElementhasRequestorElementgetRequestorsetRequestorhasRequestorgetLocationsetLocationhasLocationgetPolicyElementsetPolicyElementaddPolicyElementhasPolicyElementgetPolicysetPolicyaddPolicyhasPolicygetNetworksetNetworkhasNetworkgetNetworkReferencehasNetworkReferencegetNetworkUriTypehasNetworkUriTypegetNetworkStringTypehasNetworkStringTypegetAuthorizationsetAuthorizationaddAuthorizationhasAuthorizationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitRoleinitPolicyinitAuthorization