Data Model Libraries
    Preparing search index...

    Class AdverseEvent

    AdverseEvent Class

    Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

    FHIR Specification

    • Short: Medical care, research study or other healthcare event causing physical injury
    • Definition: Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
    • FHIR Version: 4.0.1

    FHIR AdverseEvent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? adverseEventActualityEnum actuality category? event? subject encounter? date? detected? recordedDate? resultingCondition? location? seriousness? severity? outcome? recorder? contributor? suspectEntity? subjectMedicalHistory? referenceDocument? study?

    Methods

    parse getIdentifier setIdentifier hasIdentifier getActualityEnumType setActualityEnumType hasActualityEnumType getActualityElement setActualityElement hasActualityElement getActuality setActuality hasActuality getCategory setCategory addCategory hasCategory getEvent setEvent hasEvent getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getDateElement setDateElement hasDateElement getDate setDate hasDate getDetectedElement setDetectedElement hasDetectedElement getDetected setDetected hasDetected getRecordedDateElement setRecordedDateElement hasRecordedDateElement getRecordedDate setRecordedDate hasRecordedDate getResultingCondition setResultingCondition addResultingCondition hasResultingCondition getLocation setLocation hasLocation getSeriousness setSeriousness hasSeriousness getSeverity setSeverity hasSeverity getOutcome setOutcome hasOutcome getRecorder setRecorder hasRecorder getContributor setContributor addContributor hasContributor getSuspectEntity setSuspectEntity addSuspectEntity hasSuspectEntity getSubjectMedicalHistory setSubjectMedicalHistory addSubjectMedicalHistory hasSubjectMedicalHistory getReferenceDocument setReferenceDocument addReferenceDocument hasReferenceDocument getStudy setStudy addStudy hasStudy fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initCategory initResultingCondition initContributor initSuspectEntity initSubjectMedicalHistory initReferenceDocument initStudy

    Constructors

    Properties

    identifier?: Identifier

    AdverseEvent.identifier Element

    FHIR Specification

    • Short: Business identifier for the event
    • Definition: Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the adverse event as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    adverseEventActualityEnum: AdverseEventActualityEnum

    FHIR CodeSystem: AdverseEventActuality

    AdverseEventActualityEnum

    actuality: null | EnumCodeType

    AdverseEvent.actuality Element

    FHIR Specification

    • Short: actual | potential
    • Definition: Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it has a potential code that indicates the adverse event did not actually happen.
    • isSummary: true

    CodeSystem Enumeration: AdverseEventActualityEnum

    category?: CodeableConcept[]

    AdverseEvent.category Element

    FHIR Specification

    • Short: product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment
    • Definition: The overall type of event, intended for search and filtering purposes.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    event?: CodeableConcept

    AdverseEvent.event Element

    FHIR Specification

    • Short: Type of the event itself in relation to the subject
    • Definition: This element defines the specific type of event that occurred or that was prevented from occurring.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    AdverseEvent.subject Element

    FHIR Specification

    encounter?: Reference

    AdverseEvent.encounter Element

    FHIR Specification

    • Short: Encounter created as part of
    • Definition: The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
    • Comment: This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. For example, if a medication administration was considered an adverse event because it resulted in a rash, then the encounter when the medication administration was given is the context. If the patient reports the AdverseEvent during a second encounter, that second encounter is not the context.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    AdverseEvent.date Element

    FHIR Specification

    • Short: When the event occurred
    • Definition: The date (and perhaps time) when the adverse event occurred.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    detected?: DateTimeType

    AdverseEvent.detected Element

    FHIR Specification

    • Short: When the event was detected
    • Definition: Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    recordedDate?: DateTimeType

    AdverseEvent.recordedDate Element

    FHIR Specification

    • Short: When the event was recorded
    • Definition: The date on which the existence of the AdverseEvent was first recorded.
    • Comment: The recordedDate represents the date when this particular AdverseEvent record was created in the system, not the date of the most recent update. The date of the last record modification can be retrieved from the resource metadata.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resultingCondition?: Reference[]

    AdverseEvent.resultingCondition Element

    FHIR Specification

    • Short: Effect on the subject due to this event
    • Definition: Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    location?: Reference

    AdverseEvent.location Element

    FHIR Specification

    • Short: Location where adverse event occurred
    • Definition: The information about where the adverse event occurred.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    seriousness?: CodeableConcept

    AdverseEvent.seriousness Element

    FHIR Specification

    • Short: Seriousness of the event
    • Definition: Assessment whether this event was of real importance.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    severity?: CodeableConcept

    AdverseEvent.severity Element

    FHIR Specification

    • Short: mild | moderate | severe
    • Definition: Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    outcome?: CodeableConcept

    AdverseEvent.outcome Element

    FHIR Specification

    • Short: resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
    • Definition: Describes the type of outcome from the adverse event.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    recorder?: Reference

    AdverseEvent.recorder Element

    FHIR Specification

    contributor?: Reference[]

    AdverseEvent.contributor Element

    FHIR Specification

    • Short: Who was involved in the adverse event or the potential adverse event
    • Definition: Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    suspectEntity?: AdverseEventSuspectEntityComponent[]

    AdverseEvent.suspectEntity Element

    FHIR Specification

    • Short: The suspected agent causing the adverse event
    • Definition: Describes the entity that is suspected to have caused the adverse event.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subjectMedicalHistory?: Reference[]

    AdverseEvent.subjectMedicalHistory Element

    FHIR Specification

    referenceDocument?: Reference[]

    AdverseEvent.referenceDocument Element

    FHIR Specification

    study?: Reference[]

    AdverseEvent.study Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AdverseEvent

      • OptionaloptSourceField: string

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

      Returns undefined | AdverseEvent

      AdverseEvent data model or undefined for AdverseEvent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the subjectMedicalHistory property.

      Parameters

      • value: undefined | Reference[]

        the subjectMedicalHistory array value

      Returns this

      this

      @ReferenceTargets('AdverseEvent.subjectMedicalHistory', ['Condition','Observation','AllergyIntolerance','FamilyMemberHistory','Immunization','Procedure','Media','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the subjectMedicalHistory array property.

      Parameters

      • value: undefined | Reference

        the subjectMedicalHistory value

      Returns this

      this

      @ReferenceTargets('AdverseEvent.subjectMedicalHistory', ['Condition','Observation','AllergyIntolerance','FamilyMemberHistory','Immunization','Procedure','Media','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifierhasIdentifiergetActualityEnumTypesetActualityEnumTypehasActualityEnumTypegetActualityElementsetActualityElementhasActualityElementgetActualitysetActualityhasActualitygetCategorysetCategoryaddCategoryhasCategorygetEventsetEventhasEventgetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetDetectedElementsetDetectedElementhasDetectedElementgetDetectedsetDetectedhasDetectedgetRecordedDateElementsetRecordedDateElementhasRecordedDateElementgetRecordedDatesetRecordedDatehasRecordedDategetResultingConditionsetResultingConditionaddResultingConditionhasResultingConditiongetLocationsetLocationhasLocationgetSeriousnesssetSeriousnesshasSeriousnessgetSeveritysetSeverityhasSeveritygetOutcomesetOutcomehasOutcomegetRecordersetRecorderhasRecordergetContributorsetContributoraddContributorhasContributorgetSuspectEntitysetSuspectEntityaddSuspectEntityhasSuspectEntitygetSubjectMedicalHistorysetSubjectMedicalHistoryaddSubjectMedicalHistoryhasSubjectMedicalHistorygetReferenceDocumentsetReferenceDocumentaddReferenceDocumenthasReferenceDocumentgetStudysetStudyaddStudyhasStudyfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitCategoryinitResultingConditioninitContributorinitSuspectEntityinitSubjectMedicalHistoryinitReferenceDocumentinitStudy