Data Model Libraries
    Preparing search index...

    Class AuditEventSourceComponent

    AuditEventSourceComponent Class

    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 AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    site? observer type_?

    Methods

    parse getSite setSite hasSite getObserver setObserver hasObserver getType setType addType hasType 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 initType

    Constructors

    Properties

    site?: Reference

    AuditEvent.source.site Element

    FHIR Specification

    • Short: Logical source location within the enterprise
    • Definition: Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
    • Requirements: This value differentiates among the sites in a multi-site enterprise health information system.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    observer: null | Reference

    AuditEvent.source.observer Element

    FHIR Specification

    Private Optionaltype_

    type_?: CodeableConcept[]

    AuditEvent.source.type Element

    FHIR Specification

    • Short: The type of source where event originated
    • Definition: Code specifying the type of source where event originated.
    • Requirements: This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEventSourceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AuditEventSourceComponent

      AuditEventSourceComponent data model or undefined for AuditEventSourceComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Observer object value to the observer property.

      Parameters

      • value: undefined | null | Reference

        the observer object value

      Returns this

      this

      @ReferenceTargets('AuditEvent.source.observer', ['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