Data Model Libraries
    Preparing search index...

    Class AllergyIntoleranceReactionComponent

    AllergyIntoleranceReactionComponent Class

    FHIR Specification

    • Short: Adverse Reaction Events linked to exposure to substance
    • Definition: Details about each adverse reaction event linked to exposure to the identified substance.

    FHIR AllergyIntolerance

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    substance? manifestation description? onset? reactionEventSeverityEnum severity? exposureRoute? note?

    Methods

    parse getSubstance setSubstance hasSubstance getManifestation setManifestation addManifestation hasManifestation getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getOnsetElement setOnsetElement hasOnsetElement getOnset setOnset hasOnset getSeverityEnumType setSeverityEnumType hasSeverityEnumType getSeverityElement setSeverityElement hasSeverityElement getSeverity setSeverity hasSeverity getExposureRoute setExposureRoute hasExposureRoute getNote setNote addNote hasNote 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 initManifestation initNote

    Constructors

    Properties

    substance?: CodeableConcept

    AllergyIntolerance.reaction.substance Element

    FHIR Specification

    • Short: Specific substance or pharmaceutical product considered to be responsible for event
    • Definition: Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
    • Comment: Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    manifestation: null | CodeableReference[]

    AllergyIntolerance.reaction.manifestation Element

    FHIR Specification

    • Short: Clinical symptoms/signs associated with the Event
    • Definition: Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
    • Comment: Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.
    • FHIR Type: CodeableReference
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    description?: StringType

    AllergyIntolerance.reaction.description Element

    FHIR Specification

    • Short: Description of the event as a whole
    • Definition: Text description about the reaction as a whole, including details of the manifestation if required.
    • Comment: Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the note field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    onset?: DateTimeType

    AllergyIntolerance.reaction.onset Element

    FHIR Specification

    • Short: Date(/time) when manifestations showed
    • Definition: Record of the date and/or time of the onset of the Reaction.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reactionEventSeverityEnum: ReactionEventSeverityEnum

    FHIR CodeSystem: ReactionEventSeverity

    ReactionEventSeverityEnum

    severity?: EnumCodeType

    AllergyIntolerance.reaction.severity Element

    FHIR Specification

    • Short: mild | moderate | severe (of event as a whole)
    • Definition: Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
    • Comment: It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ReactionEventSeverityEnum

    exposureRoute?: CodeableConcept

    AllergyIntolerance.reaction.exposureRoute Element

    FHIR Specification

    • Short: How the subject was exposed to the substance
    • Definition: Identification of the route by which the subject was exposed to the substance.
    • Comment: Coding of the route of exposure with a terminology should be used wherever possible.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    AllergyIntolerance.reaction.note Element

    FHIR Specification

    • Short: Text about event not captured in other fields
    • Definition: Additional text about the adverse reaction event not captured in other fields.
    • Comment: Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AllergyIntoleranceReactionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AllergyIntoleranceReactionComponent

      AllergyIntoleranceReactionComponent data model or undefined for AllergyIntoleranceReactionComponent

      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
    parsegetSubstancesetSubstancehasSubstancegetManifestationsetManifestationaddManifestationhasManifestationgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetOnsetElementsetOnsetElementhasOnsetElementgetOnsetsetOnsethasOnsetgetSeverityEnumTypesetSeverityEnumTypehasSeverityEnumTypegetSeverityElementsetSeverityElementhasSeverityElementgetSeveritysetSeverityhasSeveritygetExposureRoutesetExposureRoutehasExposureRoutegetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitManifestationinitNote