Data Model Libraries
    Preparing search index...

    Class AuditEventOutcomeComponent

    AuditEventOutcomeComponent Class

    FHIR Specification

    • Short: Whether the event succeeded or failed
    • Definition: Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.
    • Comment: In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
    • Requirements: when a code is given there must be one code from the given codeSystem, and may be other equivilant codes from other codeSystems (for example http response codes such as 2xx, 4xx, or 5xx).

    FHIR AuditEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    code detail?

    Methods

    parse getCode setCode hasCode getDetail setDetail addDetail hasDetail 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 initDetail

    Constructors

    Properties

    code: null | Coding

    AuditEvent.outcome.code Element

    FHIR Specification

    • Short: Whether the event succeeded or failed
    • Definition: Indicates whether the event succeeded or failed.
    • Comment: In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
    • Requirements: when a code is given there must be one code from the given codeSystem.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    detail?: CodeableConcept[]

    AuditEvent.outcome.detail Element

    FHIR Specification

    • Short: Additional outcome detail
    • Definition: Additional details about the error. This may be a text description of the error or a system code that identifies the error.
    • Comment: A human readable description of the error issue SHOULD be placed in details.text.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AuditEventOutcomeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AuditEventOutcomeComponent

      AuditEventOutcomeComponent data model or undefined for AuditEventOutcomeComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods