Data Model Libraries
    Preparing search index...

    AdverseEventParticipantComponent Class

    FHIR Specification

    • Short: Who was involved in the adverse event or the potential adverse event and what they did
    • Definition: Indicates who or what participated in the adverse event and how they were involved.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    function_?: CodeableConcept

    AdverseEvent.participant.function Element

    FHIR Specification

    • Short: Type of involvement
    • Definition: Distinguishes the type of involvement of the actor in the adverse event, such as contributor or informant.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    actor: null | Reference

    AdverseEvent.participant.actor Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AdverseEventParticipantComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AdverseEventParticipantComponent

      AdverseEventParticipantComponent data model or undefined for AdverseEventParticipantComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Actor object value to the actor property.

      Parameters

      • value: undefined | null | Reference

        the actor object value

      Returns this

      this

      @ReferenceTargets('AdverseEvent.participant.actor', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','Device','RelatedPerson','ResearchSubject',])

      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