Data Model Libraries
    Preparing search index...

    AuditEventEntityDetailComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | StringType

    AuditEvent.entity.detail.type Element

    FHIR Specification

    • Short: Name of the property
    • Definition: The type of extra detail provided in the value.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | IDataType

    AuditEvent.entity.detail.value[x] Element

    @ChoiceDataTypesMeta('AuditEvent.entity.detail.value[x]', ['string','base64Binary',]

    FHIR Specification

    • Short: Property value
    • Definition: The value of the extra detail.
    • Comment: The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. 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: Should not duplicate the entity value unless absolutely necessary.
    • FHIR Types: 'string', 'base64Binary',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEventEntityDetailComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AuditEventEntityDetailComponent

      AuditEventEntityDetailComponent data model or undefined for AuditEventEntityDetailComponent

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