Data Model Libraries
    Preparing search index...

    Class AllergyIntolerance

    AllergyIntolerance Class

    Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

    To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.

    FHIR Specification

    • Short: Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
    • Definition: Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.
    • Comment: Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.
    • FHIR Version: 5.0.0

    FHIR AllergyIntolerance

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? clinicalStatus? verificationStatus? type_? allergyIntoleranceCategoryEnum category? allergyIntoleranceCriticalityEnum criticality? code? patient encounter? onset? recordedDate? participant? lastOccurrence? note? reaction?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getClinicalStatus setClinicalStatus hasClinicalStatus getVerificationStatus setVerificationStatus hasVerificationStatus getType setType hasType getCategoryEnumType setCategoryEnumType addCategoryEnumType hasCategoryEnumType getCategoryElement setCategoryElement addCategoryElement hasCategoryElement getCategory setCategory addCategory hasCategory getCriticalityEnumType setCriticalityEnumType hasCriticalityEnumType getCriticalityElement setCriticalityElement hasCriticalityElement getCriticality setCriticality hasCriticality getCode setCode hasCode getPatient setPatient hasPatient getEncounter setEncounter hasEncounter getOnset setOnset hasOnset getOnsetDateTimeType hasOnsetDateTimeType getOnsetAge hasOnsetAge getOnsetPeriod hasOnsetPeriod getOnsetRange hasOnsetRange getOnsetStringType hasOnsetStringType getRecordedDateElement setRecordedDateElement hasRecordedDateElement getRecordedDate setRecordedDate hasRecordedDate getParticipant setParticipant addParticipant hasParticipant getLastOccurrenceElement setLastOccurrenceElement hasLastOccurrenceElement getLastOccurrence setLastOccurrence hasLastOccurrence getNote setNote addNote hasNote getReaction setReaction addReaction hasReaction 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 initIdentifier initCategory initParticipant initNote initReaction

    Constructors

    Properties

    identifier?: Identifier[]

    AllergyIntolerance.identifier Element

    FHIR Specification

    • Short: External ids for this item
    • Definition: Business identifiers assigned to this AllergyIntolerance 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 AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    clinicalStatus?: CodeableConcept

    AllergyIntolerance.clinicalStatus Element

    FHIR Specification

    • Short: active | inactive | resolved
    • Definition: The clinical status of the allergy or intolerance.
    • Comment: AllergyIntolerance.clinicalStatus should be present if verificationStatus is not entered-in-error and the AllergyIntolerance.code isn't negated (No Known Allergy, No Drug Allergy, No Food Allergy, No Latex Allergy). Refer to discussion if clinicalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
    • isSummary: true
    verificationStatus?: CodeableConcept

    AllergyIntolerance.verificationStatus Element

    FHIR Specification

    • Short: unconfirmed | presumed | confirmed | refuted | entered-in-error
    • Definition: Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute.
    • Comment: The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    AllergyIntolerance.type Element

    FHIR Specification

    • Short: allergy | intolerance - Underlying mechanism (if known)
    • Definition: Identification of the underlying physiological mechanism for the reaction risk.
    • Comment: Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    allergyIntoleranceCategoryEnum: AllergyIntoleranceCategoryEnum

    FHIR CodeSystem: AllergyIntoleranceCategory

    AllergyIntoleranceCategoryEnum

    category?: EnumCodeType[]

    AllergyIntolerance.category Element

    FHIR Specification

    • Short: food | medication | environment | biologic
    • Definition: Category of the identified substance.
    • Comment: This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AllergyIntoleranceCategoryEnum

    allergyIntoleranceCriticalityEnum: AllergyIntoleranceCriticalityEnum

    FHIR CodeSystem: AllergyIntoleranceCriticality

    AllergyIntoleranceCriticalityEnum

    criticality?: EnumCodeType

    AllergyIntolerance.criticality Element

    FHIR Specification

    • Short: low | high | unable-to-assess
    • Definition: Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
    • Comment: The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AllergyIntoleranceCriticalityEnum

    code?: CodeableConcept

    AllergyIntolerance.code Element

    FHIR Specification

    • Short: Code that identifies the allergy or intolerance
    • Definition: Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). 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: It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    patient: null | Reference

    AllergyIntolerance.patient Element

    FHIR Specification

    • Short: Who the allergy or intolerance is for
    • Definition: The patient who has the allergy or intolerance.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    AllergyIntolerance.encounter Element

    FHIR Specification

    • Short: Encounter when the allergy or intolerance was asserted
    • Definition: The encounter when the allergy or intolerance was asserted.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    onset?: IDataType

    AllergyIntolerance.onset[x] Element

    @ChoiceDataTypesMeta('AllergyIntolerance.onset[x]', ['dateTime','Age','Period','Range','string',]

    FHIR Specification

    • Short: When allergy or intolerance was identified
    • Definition: Estimated or actual date, date-time, or age when allergy or intolerance was identified.
    • Comment: Age is generally used when the patient reports an age at which the AllergyIntolerance was noted. Period is generally used to convey an imprecise onset that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old).
    • FHIR Types: 'dateTime', 'Age', 'Period', 'Range', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recordedDate?: DateTimeType

    AllergyIntolerance.recordedDate Element

    FHIR Specification

    • Short: Date allergy or intolerance was first recorded
    • Definition: The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
    • Comment: When onset date is unknown, recordedDate can be used to establish if the allergy or intolerance was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    participant?: AllergyIntoleranceParticipantComponent[]

    AllergyIntolerance.participant Element

    FHIR Specification

    • Short: Who or what participated in the activities related to the allergy or intolerance and how they were involved
    • Definition: Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    lastOccurrence?: DateTimeType

    AllergyIntolerance.lastOccurrence Element

    FHIR Specification

    • Short: Date(/time) of last known occurrence of a reaction
    • Definition: Represents the date and/or time of the last known occurrence of a reaction event.
    • Comment: This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the AllergyIntolerance.note element should be used.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    AllergyIntolerance.note Element

    FHIR Specification

    • Short: Additional text not captured in other fields
    • Definition: Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
    • Comment: For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reaction?: AllergyIntoleranceReactionComponent[]

    AllergyIntolerance.reaction Element

    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 Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AllergyIntolerance

      • OptionaloptSourceField: string

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

      Returns undefined | AllergyIntolerance

      AllergyIntolerance data model or undefined for AllergyIntolerance

      JsonError if the provided JSON is not a valid JSON object

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetClinicalStatussetClinicalStatushasClinicalStatusgetVerificationStatussetVerificationStatushasVerificationStatusgetTypesetTypehasTypegetCategoryEnumTypesetCategoryEnumTypeaddCategoryEnumTypehasCategoryEnumTypegetCategoryElementsetCategoryElementaddCategoryElementhasCategoryElementgetCategorysetCategoryaddCategoryhasCategorygetCriticalityEnumTypesetCriticalityEnumTypehasCriticalityEnumTypegetCriticalityElementsetCriticalityElementhasCriticalityElementgetCriticalitysetCriticalityhasCriticalitygetCodesetCodehasCodegetPatientsetPatienthasPatientgetEncountersetEncounterhasEncountergetOnsetsetOnsethasOnsetgetOnsetDateTimeTypehasOnsetDateTimeTypegetOnsetAgehasOnsetAgegetOnsetPeriodhasOnsetPeriodgetOnsetRangehasOnsetRangegetOnsetStringTypehasOnsetStringTypegetRecordedDateElementsetRecordedDateElementhasRecordedDateElementgetRecordedDatesetRecordedDatehasRecordedDategetParticipantsetParticipantaddParticipanthasParticipantgetLastOccurrenceElementsetLastOccurrenceElementhasLastOccurrenceElementgetLastOccurrencesetLastOccurrencehasLastOccurrencegetNotesetNoteaddNotehasNotegetReactionsetReactionaddReactionhasReactionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitParticipantinitNoteinitReaction