HL7 Europe Base and Core FHIR IG
2.0.1-ci - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 2.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base-r5/ and changes regularly. See the Directory of published versions

Resource Profile: AllergyIntoleranceEuCore - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the allergyIntolerance-eu-core resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. AllergyIntolerance
Definition

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

ShortAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
Comments

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.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesAllergy, Intolerance, Adverse Reaction
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. AllergyIntolerance.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. AllergyIntolerance.language
Definition

The base language in which the resource is written.

ShortLanguage of the allergy or intolerance contentLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. AllergyIntolerance.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. AllergyIntolerance.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. AllergyIntolerance.extension:abatement
    Slice Nameabatement
    Definition

    The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.

    ShortWhen the allergy or intolerance resolved
    Comments

    Age is generally used when the patient reports an age at which the AllergyIntolerance was abated. Period is generally used to convey an imprecise abatement date that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old). If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.

    Control0..1
    TypeExtension(Abatement) (Extension Type: Choice of: dateTime, Age, Period, Range, string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. AllergyIntolerance.extension:abatement.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..0*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on AllergyIntolerance.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 14. AllergyIntolerance.extension:abatement.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
      16. AllergyIntolerance.extension:abatement.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      This element is affected by the following invariants: ext-1
      TypeChoice of: dateTime, Age, Period, Range, string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Duration, canonical, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, code, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 18. AllergyIntolerance.extension:abatement.value[x]:valueDateTime
        Slice NamevalueDateTime
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortEnd dateValue of extension
        Control0..1
        This element is affected by the following invariants: ext-1
        TypedateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortExtensionAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife
          Slice NameperiodOfLife
          Definition

          Extensions used to indicate a time period in a person's life as a reference to a coded value for that life period.

          ShortMany: Periods of Life
          Control0..1
          TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          24. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.extension
          Definition

          An Extension


          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortExtensionAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..0*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 26. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
            28. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.value[x]
            Definition

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

            ShortValue of extension
            Control0..1
            This element is affected by the following invariants: ext-1
            BindingThe codes SHOULD be taken from For codes, see Periods of Life
            (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. AllergyIntolerance.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            32. AllergyIntolerance.identifier
            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.

            ShortBusiness identifier for the allergy or intoleranceExternal ids for this item
            Comments

            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.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Requirements

            Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            34. AllergyIntolerance.clinicalStatus
            Definition

            The clinical status of the allergy or intolerance.

            ShortCurrent allergy or Intolerance statusactive | inactive | resolved
            Comments

            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.

            Control0..1
            BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0
            (required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0)

            The clinical status of the allergy or intolerance.

            TypeCodeableConcept
            Is Modifiertrue because This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. AllergyIntolerance.verificationStatus
            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.

            ShortCertaintyunconfirmed | presumed | confirmed | refuted | entered-in-error
            Comments

            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.

            Control0..1
            BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatushttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0
            (required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0)

            Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

            TypeCodeableConcept
            Is Modifiertrue because 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.
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. AllergyIntolerance.type
            Definition

            Identification of the underlying physiological mechanism for the reaction risk.

            ShortType of propensityallergy | intolerance - Underlying mechanism (if known)
            Comments

            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.

            Control0..1
            BindingThe codes SHOULD be taken from AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|5.0.0
            (preferred to http://hl7.org/fhir/ValueSet/allergy-intolerance-type|5.0.0)

            Identification of the underlying physiological mechanism for a Reaction Risk.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Alternate NamesCategory, Class
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. AllergyIntolerance.criticality
            Definition

            Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

            ShortCriticalitylow | high | unable-to-assess
            Comments

            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.

            Control0..1
            BindingThe codes SHALL be taken from AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|5.0.0
            (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|5.0.0)

            Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Alternate NamesSeverity, Seriousness, Contra-indication, Risk
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. AllergyIntolerance.code
            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.

            ShortCode that identifies the allergy or intolerance
            Comments

            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.

            Control10..1
            BindingThe codes SHOULD be taken from For example codes, see Allergies & Intolerances - IPS .http://hl7.org/fhir/ValueSet/allergyintolerance-code|5.0.0
            (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergies-intolerances-uv-ips)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Alternate NamesCode
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. AllergyIntolerance.patient
            Definition

            The patient who has the allergy or intolerance.

            ShortWho the allergy or intolerance concernsWho the allergy or intolerance is for
            Control1..1
            TypeReference(Patient (EU core), Patient)
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Alternate NamesPatient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. AllergyIntolerance.onset[x]
            Definition

            Estimated or actual date, date-time, or age when allergy or intolerance was identified.

            ShortDate of onset of the allergy or intoleranceWhen allergy or intolerance was identified
            Comments

            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).

            Control0..1
            TypeChoice of: dateTime, Age, Period, Range, string
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 48. AllergyIntolerance.onset[x]:onsetDateTime
              Slice NameonsetDateTime
              Definition

              Estimated or actual date, date-time, or age when allergy or intolerance was identified.

              ShortOnset dateWhen allergy or intolerance was identified
              Comments

              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).

              Control0..1
              TypedateTime, string, Period, Range, Age
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. AllergyIntolerance.onset[x]:onsetDateTime.extension
              Definition

              An Extension


              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortExtensionAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 52. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife
                Slice NameperiodOfLife
                Definition

                Extensions used to indicate a time period in a person's life as a reference to a coded value for that life period.

                ShortMany: Periods of Life
                Control0..1
                TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                54. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.extension
                Definition

                An Extension


                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortExtensionAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..0*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 56. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
                  58. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.value[x]
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control0..1
                  This element is affected by the following invariants: ext-1
                  BindingThe codes SHOULD be taken from For codes, see Periods of Life
                  (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. AllergyIntolerance.recordedDate
                  Definition

                  The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

                  ShortDate when the allergy or intolerance was recordedDate allergy or intolerance was first recorded
                  Comments

                  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.

                  Control0..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                  Guidance on how to interpret the contents of this table can be foundhere

                  0. AllergyIntolerance
                  2. AllergyIntolerance.language
                  ShortLanguage of the allergy or intolerance content
                  4. AllergyIntolerance.extension
                  SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 6. AllergyIntolerance.extension:abatement
                    Slice Nameabatement
                    Control0..1
                    TypeExtension(Abatement) (Extension Type: Choice of: dateTime, Age, Period, Range, string)
                    8. AllergyIntolerance.extension:abatement.value[x]
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 10. AllergyIntolerance.extension:abatement.value[x]:valueDateTime
                      Slice NamevalueDateTime
                      ShortEnd date
                      Control0..1
                      TypedateTime
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      12. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension
                      SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 14. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife
                        Slice NameperiodOfLife
                        Control0..1
                        TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
                        16. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.value[x]
                        BindingThe codes SHOULD be taken from Periods of Life
                        (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        18. AllergyIntolerance.identifier
                        ShortBusiness identifier for the allergy or intolerance
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        20. AllergyIntolerance.clinicalStatus
                        ShortCurrent allergy or Intolerance status
                        22. AllergyIntolerance.verificationStatus
                        ShortCertainty
                        24. AllergyIntolerance.type
                        ShortType of propensity
                        26. AllergyIntolerance.criticality
                        ShortCriticality
                        28. AllergyIntolerance.code
                        Control1..?
                        BindingThe codes SHOULD be taken from Allergies & Intolerances - IPS .
                        (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergies-intolerances-uv-ips)
                        30. AllergyIntolerance.patient
                        ShortWho the allergy or intolerance concerns
                        TypeReference(Patient (EU core))
                        32. AllergyIntolerance.onset[x]
                        ShortDate of onset of the allergy or intolerance
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 34. AllergyIntolerance.onset[x]:onsetDateTime
                          Slice NameonsetDateTime
                          ShortOnset date
                          Control0..1
                          TypedateTime
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          36. AllergyIntolerance.onset[x]:onsetDateTime.extension
                          SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 38. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife
                            Slice NameperiodOfLife
                            Control0..1
                            TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
                            40. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.value[x]
                            BindingThe codes SHOULD be taken from Periods of Life
                            (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            42. AllergyIntolerance.recordedDate
                            ShortDate when the allergy or intolerance was recorded
                            44. AllergyIntolerance.participant
                            46. AllergyIntolerance.participant.actor
                            ShortWho or what participated in the activities related to the allergy (e.g. asserter, reporter)
                            48. AllergyIntolerance.note
                            50. AllergyIntolerance.note.text
                            ShortAdditional information about the allergy or intolerance
                            52. AllergyIntolerance.reaction
                            54. AllergyIntolerance.reaction.substance
                            BindingFor example codes, see eHDSI Allergen No Drug .
                            (example to http://terminology.ehdsi.eu/ValueSet/eHDSIAllergenNoDrug)
                            56. AllergyIntolerance.reaction.manifestation
                            BindingThe codes SHOULD be taken from Allergy Reaction - IPS .
                            (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips)
                            58. AllergyIntolerance.reaction.onset
                            ShortReaction onset
                            60. AllergyIntolerance.reaction.severity
                            ShortReaction severity

                            Guidance on how to interpret the contents of this table can be foundhere

                            0. AllergyIntolerance
                            Definition

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

                            ShortAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
                            Comments

                            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.

                            Control0..*
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate NamesAllergy, Intolerance, Adverse Reaction
                            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                            dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                            dom-6: A resource should have narrative for robust management (text.`div`.exists())
                            2. AllergyIntolerance.id
                            Definition

                            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                            ShortLogical id of this artifact
                            Comments

                            Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                            Control0..1
                            Typeid
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            4. AllergyIntolerance.meta
                            Definition

                            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                            ShortMetadata about the resource
                            Control0..1
                            TypeMeta
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            6. AllergyIntolerance.implicitRules
                            Definition

                            A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                            ShortA set of rules under which this content was created
                            Comments

                            Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                            Control0..1
                            Typeuri
                            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            8. AllergyIntolerance.language
                            Definition

                            The base language in which the resource is written.

                            ShortLanguage of the allergy or intolerance content
                            Comments

                            Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                            Control0..1
                            BindingThe codes SHALL be taken from AllLanguages
                            (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                            IETF language tag for a human language

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            10. AllergyIntolerance.text
                            Definition

                            A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                            ShortText summary of the resource, for human interpretation
                            Comments

                            Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                            Control0..1
                            This element is affected by the following invariants: dom-6
                            TypeNarrative
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namesnarrative, html, xhtml, display
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            12. AllergyIntolerance.contained
                            Definition

                            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                            ShortContained, inline Resources
                            Comments

                            This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

                            Control0..*
                            This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                            TypeResource
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namesinline resources, anonymous resources, contained resources
                            14. AllergyIntolerance.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 16. AllergyIntolerance.extension:abatement
                              Slice Nameabatement
                              Definition

                              The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.

                              ShortWhen the allergy or intolerance resolved
                              Comments

                              Age is generally used when the patient reports an age at which the AllergyIntolerance was abated. Period is generally used to convey an imprecise abatement date that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old). If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.

                              Control0..1
                              TypeExtension(Abatement) (Extension Type: Choice of: dateTime, Age, Period, Range, string)
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              18. AllergyIntolerance.extension:abatement.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              20. AllergyIntolerance.extension:abatement.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..0
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on AllergyIntolerance.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 22. AllergyIntolerance.extension:abatement.url
                                Definition

                                Source of the definition for the extension code - a logical name or a URL.

                                Shortidentifies the meaning of the extension
                                Comments

                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                Fixed Valuehttp://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
                                24. AllergyIntolerance.extension:abatement.value[x]
                                Definition

                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                ShortValue of extension
                                Control1..1
                                This element is affected by the following invariants: ext-1
                                TypeChoice of: dateTime, Age, Period, Range, string
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • type @ $this
                                • 26. AllergyIntolerance.extension:abatement.value[x]:valueDateTime
                                  Slice NamevalueDateTime
                                  Definition

                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                  ShortEnd date
                                  Control0..1
                                  This element is affected by the following invariants: ext-1
                                  TypedateTime
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  28. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.id
                                  Definition

                                  unique id for the element within a resource (for internal references)

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  30. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 32. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife
                                    Slice NameperiodOfLife
                                    Definition

                                    Extensions used to indicate a time period in a person's life as a reference to a coded value for that life period.

                                    ShortMany: Periods of Life
                                    Control0..1
                                    TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    34. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.id
                                    Definition

                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    36. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..0
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on AllergyIntolerance.extension.value[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 38. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.url
                                      Definition

                                      Source of the definition for the extension code - a logical name or a URL.

                                      Shortidentifies the meaning of the extension
                                      Comments

                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                      Control1..1
                                      Typeuri
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      Fixed Valuehttp://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
                                      40. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.extension:periodOfLife.value[x]
                                      Definition

                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                      ShortValue of extension
                                      Control0..1
                                      This element is affected by the following invariants: ext-1
                                      BindingThe codes SHOULD be taken from Periods of Life
                                      (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
                                      TypeCodeableConcept
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      42. AllergyIntolerance.extension:abatement.value[x]:valueDateTime.value
                                      Definition

                                      The actual value

                                      ShortPrimitive value for dateTime
                                      Control0..1
                                      TypedateTime
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      44. AllergyIntolerance.modifierExtension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                      ShortExtensions that cannot be ignored
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      46. AllergyIntolerance.identifier
                                      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.

                                      ShortBusiness identifier for the allergy or intolerance
                                      Comments

                                      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.

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..*
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

                                      Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      48. AllergyIntolerance.clinicalStatus
                                      Definition

                                      The clinical status of the allergy or intolerance.

                                      ShortCurrent allergy or Intolerance status
                                      Comments

                                      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.

                                      Control0..1
                                      BindingThe codes SHALL be taken from AllergyIntoleranceClinicalStatusCodes
                                      (required to http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0)

                                      The clinical status of the allergy or intolerance.

                                      TypeCodeableConcept
                                      Is Modifiertrue because This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      50. AllergyIntolerance.verificationStatus
                                      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.

                                      ShortCertainty
                                      Comments

                                      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.

                                      Control0..1
                                      BindingThe codes SHALL be taken from AllergyIntoleranceVerificationStatus
                                      (required to http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0)

                                      Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

                                      TypeCodeableConcept
                                      Is Modifiertrue because 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.
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      52. AllergyIntolerance.type
                                      Definition

                                      Identification of the underlying physiological mechanism for the reaction risk.

                                      ShortType of propensity
                                      Comments

                                      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.

                                      Control0..1
                                      BindingThe codes SHOULD be taken from AllergyIntoleranceType
                                      (preferred to http://hl7.org/fhir/ValueSet/allergy-intolerance-type|5.0.0)

                                      Identification of the underlying physiological mechanism for a Reaction Risk.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesCategory, Class
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      54. AllergyIntolerance.category
                                      Definition

                                      Category of the identified substance.

                                      Shortfood | medication | environment | biologic
                                      Comments

                                      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.

                                      Control0..*
                                      BindingThe codes SHALL be taken from AllergyIntoleranceCategory
                                      (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-category|5.0.0)

                                      Category of an identified substance associated with allergies or intolerances.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesCategory, Type, Reaction Type, Class
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      56. AllergyIntolerance.criticality
                                      Definition

                                      Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

                                      ShortCriticality
                                      Comments

                                      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.

                                      Control0..1
                                      BindingThe codes SHALL be taken from AllergyIntoleranceCriticality
                                      (required to http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|5.0.0)

                                      Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesSeverity, Seriousness, Contra-indication, Risk
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      58. AllergyIntolerance.code
                                      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.

                                      ShortCode that identifies the allergy or intolerance
                                      Comments

                                      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.

                                      Control1..1
                                      BindingThe codes SHOULD be taken from Allergies & Intolerances - IPS .
                                      (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergies-intolerances-uv-ips)
                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesCode
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      60. AllergyIntolerance.patient
                                      Definition

                                      The patient who has the allergy or intolerance.

                                      ShortWho the allergy or intolerance concerns
                                      Control1..1
                                      TypeReference(Patient (EU core))
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Alternate NamesPatient
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      62. AllergyIntolerance.encounter
                                      Definition

                                      The encounter when the allergy or intolerance was asserted.

                                      ShortEncounter when the allergy or intolerance was asserted
                                      Control0..1
                                      TypeReference(Encounter)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      64. AllergyIntolerance.onset[x]
                                      Definition

                                      Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                      ShortDate of onset of the allergy or intolerance
                                      Comments

                                      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).

                                      Control0..1
                                      TypeChoice of: dateTime, Age, Period, Range, string
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • type @ $this
                                      • 66. AllergyIntolerance.onset[x]:onsetDateTime
                                        Slice NameonsetDateTime
                                        Definition

                                        Estimated or actual date, date-time, or age when allergy or intolerance was identified.

                                        ShortOnset date
                                        Comments

                                        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).

                                        Control0..1
                                        TypedateTime
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supportfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        68. AllergyIntolerance.onset[x]:onsetDateTime.id
                                        Definition

                                        unique id for the element within a resource (for internal references)

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        70. AllergyIntolerance.onset[x]:onsetDateTime.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 72. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife
                                          Slice NameperiodOfLife
                                          Definition

                                          Extensions used to indicate a time period in a person's life as a reference to a coded value for that life period.

                                          ShortMany: Periods of Life
                                          Control0..1
                                          TypeExtension(Many: Periods of Life) (Extension Type: CodeableConcept)
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          74. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.id
                                          Definition

                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          76. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..0
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on AllergyIntolerance.onset[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 78. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies the meaning of the extension
                                            Comments

                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            Fixed Valuehttp://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
                                            80. AllergyIntolerance.onset[x]:onsetDateTime.extension:periodOfLife.value[x]
                                            Definition

                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                            ShortValue of extension
                                            Control0..1
                                            This element is affected by the following invariants: ext-1
                                            BindingThe codes SHOULD be taken from Periods of Life
                                            (preferred to http://hl7.eu/fhir/base-r5/ValueSet/periodsOfLife-eu)
                                            TypeCodeableConcept
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            82. AllergyIntolerance.onset[x]:onsetDateTime.value
                                            Definition

                                            The actual value

                                            ShortPrimitive value for dateTime
                                            Control0..1
                                            TypedateTime
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            84. AllergyIntolerance.recordedDate
                                            Definition

                                            The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

                                            ShortDate when the allergy or intolerance was recorded
                                            Comments

                                            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.

                                            Control0..1
                                            TypedateTime
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            86. AllergyIntolerance.participant
                                            Definition

                                            Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.

                                            ShortWho or what participated in the activities related to the allergy or intolerance and how they were involved
                                            Control0..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            88. AllergyIntolerance.participant.id
                                            Definition

                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            90. AllergyIntolerance.participant.extension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                            ShortAdditional content defined by implementations
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            92. AllergyIntolerance.participant.modifierExtension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                            ShortExtensions that cannot be ignored even if unrecognized
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                            Summarytrue
                                            Requirements

                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                            Alternate Namesextensions, user content, modifiers
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            94. AllergyIntolerance.participant.function
                                            Definition

                                            Distinguishes the type of involvement of the actor in the activities related to the allergy or intolerance.

                                            ShortType of involvement
                                            Control0..1
                                            BindingUnless not suitable, these codes SHALL be taken from ParticipationRoleType
                                            (extensible to http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0)
                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            96. AllergyIntolerance.participant.actor
                                            Definition

                                            Indicates who or what participated in the activities related to the allergy or intolerance.

                                            ShortWho or what participated in the activities related to the allergy (e.g. asserter, reporter)
                                            Control1..1
                                            TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Device, Organization, CareTeam)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            98. AllergyIntolerance.lastOccurrence
                                            Definition

                                            Represents the date and/or time of the last known occurrence of a reaction event.

                                            ShortDate(/time) of last known occurrence of a reaction
                                            Comments

                                            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.

                                            Control0..1
                                            TypedateTime
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            100. AllergyIntolerance.note
                                            Definition

                                            Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

                                            ShortAdditional text not captured in other fields
                                            Comments

                                            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.

                                            Control0..*
                                            TypeAnnotation
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            102. AllergyIntolerance.note.id
                                            Definition

                                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            104. AllergyIntolerance.note.extension
                                            Definition

                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                            ShortAdditional content defined by implementations
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on AllergyIntolerance.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 106. AllergyIntolerance.note.author[x]
                                              Definition

                                              The individual responsible for making the annotation.

                                              ShortIndividual responsible for the annotation
                                              Comments

                                              Organization is used when there's no need for specific attribution as to who made the comment.

                                              Control0..1
                                              TypeChoice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              108. AllergyIntolerance.note.time
                                              Definition

                                              Indicates when this particular annotation was made.

                                              ShortWhen the annotation was made
                                              Control0..1
                                              TypedateTime
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              110. AllergyIntolerance.note.text
                                              Definition

                                              The text of the annotation in markdown format.

                                              ShortAdditional information about the allergy or intolerance
                                              Control1..1
                                              Typemarkdown
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              112. AllergyIntolerance.reaction
                                              Definition

                                              Details about each adverse reaction event linked to exposure to the identified substance.

                                              ShortAdverse Reaction Events linked to exposure to substance
                                              Control0..*
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              114. AllergyIntolerance.reaction.id
                                              Definition

                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              116. AllergyIntolerance.reaction.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              118. AllergyIntolerance.reaction.modifierExtension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                              ShortExtensions that cannot be ignored even if unrecognized
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                              Summarytrue
                                              Requirements

                                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                              Alternate Namesextensions, user content, modifiers
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              120. AllergyIntolerance.reaction.substance
                                              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.

                                              ShortSpecific substance or pharmaceutical product considered to be responsible for event
                                              Comments

                                              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'.

                                              Control0..1
                                              BindingFor example codes, see eHDSI Allergen No Drug .
                                              (example to http://terminology.ehdsi.eu/ValueSet/eHDSIAllergenNoDrug)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              122. AllergyIntolerance.reaction.manifestation
                                              Definition

                                              Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

                                              ShortClinical symptoms/signs associated with the Event
                                              Comments

                                              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.

                                              Control1..*
                                              BindingThe codes SHOULD be taken from Allergy Reaction - IPS .
                                              (preferred to http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips)
                                              TypeCodeableReference(Observation)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate NamesSymptoms, Signs
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              124. AllergyIntolerance.reaction.description
                                              Definition

                                              Text description about the reaction as a whole, including details of the manifestation if required.

                                              ShortDescription of the event as a whole
                                              Comments

                                              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.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate NamesNarrative, Text
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              126. AllergyIntolerance.reaction.onset
                                              Definition

                                              Record of the date and/or time of the onset of the Reaction.

                                              ShortReaction onset
                                              Control0..1
                                              TypedateTime
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              128. AllergyIntolerance.reaction.severity
                                              Definition

                                              Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

                                              ShortReaction severity
                                              Comments

                                              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.

                                              Control0..1
                                              BindingThe codes SHALL be taken from AllergyIntoleranceSeverity
                                              (required to http://hl7.org/fhir/ValueSet/reaction-event-severity|5.0.0)

                                              Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              130. AllergyIntolerance.reaction.exposureRoute
                                              Definition

                                              Identification of the route by which the subject was exposed to the substance.

                                              ShortHow the subject was exposed to the substance
                                              Comments

                                              Coding of the route of exposure with a terminology should be used wherever possible.

                                              Control0..1
                                              BindingFor example codes, see SNOMEDCTRouteCodes
                                              (example to http://hl7.org/fhir/ValueSet/route-codes|5.0.0)

                                              A coded concept describing the route or physiological path of exposure to a substance.

                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              132. AllergyIntolerance.reaction.note
                                              Definition

                                              Additional text about the adverse reaction event not captured in other fields.

                                              ShortText about event not captured in other fields
                                              Comments

                                              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.

                                              Control0..*
                                              TypeAnnotation
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))