Data Model Libraries
    Preparing search index...

    AdverseEventSuspectEntityComponent Class

    FHIR Specification

    • Short: The suspected agent causing the adverse event
    • Definition: Describes the entity that is suspected to have caused the adverse event.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    instance_: null | Reference

    AdverseEvent.suspectEntity.instance Element

    FHIR Specification

    AdverseEvent.suspectEntity.causality Element

    FHIR Specification

    • Short: Information on the possible cause of the event
    • Definition: Information on the possible cause of the event.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AdverseEventSuspectEntityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AdverseEventSuspectEntityComponent

      AdverseEventSuspectEntityComponent data model or undefined for AdverseEventSuspectEntityComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Instance object value to the instance_ property.

      Parameters

      • value: undefined | null | Reference

        the instance_ object value

      Returns this

      this

      @ReferenceTargets('AdverseEvent.suspectEntity.instance', ['Immunization','Procedure','Substance','Medication','MedicationAdministration','MedicationStatement','Device',])

      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