Sparked Logical Models
0.0.1 - CI Build Australia (AUS)

Sparked Logical Models, published by CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/logical-model-web/ and changes regularly. See the Directory of published versions

Logical Model: AdverseReactionRisk - Detailed Descriptions

Draft as of 2023-09-11

Definitions for the AdverseReactionRisk logical model.

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

0. AdverseReactionRisk
Definition

Clinical assessment of the propensity for an individual to experience a harmful or undesirable physiological response if exposed, or re-exposed, to a substance.

ShortAdverse Reaction Risk
Comments

Purpose

To record the clinical assessment of the propensity for an individual to experience an adverse reaction if exposed, or re-exposed, to a specified substance or class of substances.

Misuse

Not to be used for recording physiological reactions to physical agents, such as heat, cold, sunlight, vibration, exercise activity, by infectious agents or food contaminants. Use a specific archetype for EVALUATION.problem/diagnosis or CLUSTER.symptom/sign for this purpose.

Not to be used to record adverse events, including failures of clinical process, interventions or products. For example: abnormal use, incorrect dosage or maladministration of an agent or substance; mislabelling; harm or injury caused by an intervention or procedure; overdose/poisoning etc. Use a specific archetype for the purpose.

Not to be used to record an adverse reaction where the substance is unknown. Use EVALUATION.problem_diagnosis or CLUSTER.symptom_sign to record as part of the health record until a possible substance is identified.

Not to be used to record reactions to transfusions of blood products. Use a specific archetype for this purpose.

Not to be used for recording 'alerts'. Use EVALUATION.precaution, EVALUATION.contraindication or related archetypes for this purpose.

Not to be used for recording failed therapy.

Not to be used for the explicit recording of an absence (or negative presence) of a reaction to 'any substances' or to identified substances, for example ‘No known allergies or adverse reactions’ or ‘No known allergies to Penicillin’. Use the EVALUATION.exclusion_global or EVALUATION.exclusion_specific archetypes to express a positive statement of adverse reaction exclusion.

Not to be used for the explicit recording that no information was able to be obtained about the adverse reaction status of a patient. Use the EVALUATION.absence archetype to record that a positive statement that information was not able to be obtained, for example, if a non-cooperative patient refuses to answer questions.

Considerations

Use to record a clinical assessment of a propensity for an adverse reaction upon future exposure to a specified substance or class of substances including, but not limited to, incipients and excipients in medicinal preparations, biological products, metal salts, and organic chemical compounds.

This archetype is intended to provide a single place within the health record to document the propensity for the full range of reactions, from trivial to life-threatening:

  • immune-mediated: Types I-IV (including allergic reactions and hypersensitivities); or
  • non-immune-mediated: including pseudo-allergic reactions, side effects, intolerances, and drug toxicities. In clinical practice distinguishing between immune-mediated and non-immune-mediated reactions can be difficult. Identification of the type of reaction is not a proxy for seriousness or risk of harm to the patient.

Where a propensity is identified, information or evidence about one or more reaction events can be recorded using the CLUSTER.adverse_reaction_event archetype in the 'Reaction event summary' SLOT.

Identification of the severity of the manifestation of the reaction, recorded in the CLUSTER.adverse_reaction_event archetype, can inform the 'Criticality' of the adverse reaction risk. For example, experiencing anaphylaxis on first exposure to a substance would warrant setting a 'Criticality' of 'high', due to the high risk that anaphylaxis is likely to recur on second and subsequent exposures.

This archetype has been designed to allow the recording of information about a specific substance (amoxycillin, oysters, or bee sting venom) or, alternatively, a class of substance (e.g. Penicillins). If a class of substance is recorded, identification of the exact substance can be recorded on a per-reaction basis using the CLUSTER.adverse_reaction_event archetype.

Use to record information about the positive presence of the risk of an adverse reaction:

  • to support the direct clinical care of an individual;
  • as part of a managed adverse reaction or allergy/intolerance list;
  • to support the exchange of information about the propensity and events related to adverse reactions;
  • to inform adverse reaction reporting; and
  • to assist with computerised knowledge-based activities such as clinical decision support and alerts.

The risk of an adverse reaction event or manifestation must always propose a causative substance or class of substance. If there is a degree of uncertainty that a specific substance is the cause, the level of uncertainty can be recorded using the ‘Verification status’ data element. If more than one possible substance may have caused a reaction/manifestation, each substance should be recorded using a separate instance of this adverse reaction risk archetype with the ‘Verification status’ set to an initial state of ‘Unconfirmed’ so that adverse reaction checking can be activated in clinical systems. If the substance is later proven not to be causal then the ‘Verification status’ can be modified to ‘Refuted’ - for example, after allergy testing.

Control0..*
Is Modifierfalse
Must Supporttrue
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Alternate Namesreaction
2. AdverseReactionRisk.Protocol
Definition

@ internal @

ShortProtocol
Control0..1
TypeBackboneElement
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. AdverseReactionRisk.Protocol.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
6. AdverseReactionRisk.Protocol.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 manageable, 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 AdverseReactionRisk.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. AdverseReactionRisk.Protocol.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 manageable, 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())
    10. AdverseReactionRisk.Protocol.Lastupdated
    Definition

    Date when the propensity or the reaction event was updated.

    ShortLast updated
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    12. AdverseReactionRisk.Protocol.Extension
    Definition

    Additional information required to capture local content or to align with other reference models/formalisms.

    ShortExtension
    Comments

    Considerations

    For example: local information requirements or additional metadata to align with FHIR equivalents.

    Control0..1
    TypeReference
    Must Supporttrue
    14. AdverseReactionRisk.Data
    Definition

    @ internal @

    ShortData
    Control0..1
    TypeBackboneElement
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. AdverseReactionRisk.Data.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
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    18. AdverseReactionRisk.Data.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 manageable, 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 AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. AdverseReactionRisk.Data.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 manageable, 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())
      22. AdverseReactionRisk.Data.Substance
      Definition

      Identification of a substance, or substance class, that is considered to put the individual at risk of an adverse reaction event.

      ShortSubstance
      Comments

      Considerations

      Both an individual substance and a substance class are valid entries in 'Substance'. A substance may be a compound of simpler substances, for example a medicinal product. It is strongly recommended that the 'Substance' is coded with a terminology capable of triggering decision support, where possible. For example: Snomed CT, DM+D, RxNorm, NDFRT, ATC, New Zealand Universal List of Medicines and Australian Medicines Terminology. Free text entry should only be used if there is no appropriate terminology available.

      Control1..1
      TypeCodeableConcept
      Must Supporttrue
      24. AdverseReactionRisk.Data.Activeinactivestatus
      Definition

      Status about whether the adverse reaction risk statement is active or inactive.

      ShortActiveinactivestatus
      Control0..1
      TypeCoding
      Must Supporttrue
      26. AdverseReactionRisk.Data.Verificationstatus
      Definition

      Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction.

      ShortVerification status
      Comments

      Considerations

      Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology.

      Control0..1
      TypeCoding
      Must Supporttrue
      28. AdverseReactionRisk.Data.Criticality
      Definition

      An indication of the potential for critical system organ damage or life threatening consequence.

      ShortCriticality
      Comments

      Considerations

      This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      30. AdverseReactionRisk.Data.Category
      Definition

      Category of the identified 'Substance'.

      ShortCategory
      Comments

      Considerations

      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.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      32. AdverseReactionRisk.Data.Onsetoflastreaction
      Definition

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

      ShortOnset of last reaction
      Comments

      Considerations

      For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

      Control0..1
      TypeChoice of: dateTime, string
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      34. AdverseReactionRisk.Data.Onsetoffirstreaction
      Definition

      The onset of the first known occurrence of a reaction event.

      ShortOnset of first reaction
      Comments

      Considerations

      For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

      Control0..1
      TypeChoice of: dateTime, string
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      36. AdverseReactionRisk.Data.Reactionmechanism
      Definition

      Identification of the underlying physiological mechanism for the adverse reaction.

      ShortReaction mechanism
      Comments

      Considerations

      Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk.

      Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity.

      It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      38. AdverseReactionRisk.Data.Reactioneventsummary
      Definition

      Summary details about each adverse reaction event linked to exposure to the identified 'Substance'.

      ShortReaction event summary
      Control0..*
      TypeReference(Adverse Reaction Event)
      Must Supporttrue
      40. AdverseReactionRisk.Data.Comment
      Definition

      Additional narrative about the propensity for the adverse reaction, not captured in other fields.

      ShortComment
      Comments

      Considerations

      For example: including reason for flagging a 'Criticality' 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.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue

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

      0. AdverseReactionRisk
      Definition

      Clinical assessment of the propensity for an individual to experience a harmful or undesirable physiological response if exposed, or re-exposed, to a substance.

      ShortAdverse Reaction Risk
      Comments

      Purpose

      To record the clinical assessment of the propensity for an individual to experience an adverse reaction if exposed, or re-exposed, to a specified substance or class of substances.

      Misuse

      Not to be used for recording physiological reactions to physical agents, such as heat, cold, sunlight, vibration, exercise activity, by infectious agents or food contaminants. Use a specific archetype for EVALUATION.problem/diagnosis or CLUSTER.symptom/sign for this purpose.

      Not to be used to record adverse events, including failures of clinical process, interventions or products. For example: abnormal use, incorrect dosage or maladministration of an agent or substance; mislabelling; harm or injury caused by an intervention or procedure; overdose/poisoning etc. Use a specific archetype for the purpose.

      Not to be used to record an adverse reaction where the substance is unknown. Use EVALUATION.problem_diagnosis or CLUSTER.symptom_sign to record as part of the health record until a possible substance is identified.

      Not to be used to record reactions to transfusions of blood products. Use a specific archetype for this purpose.

      Not to be used for recording 'alerts'. Use EVALUATION.precaution, EVALUATION.contraindication or related archetypes for this purpose.

      Not to be used for recording failed therapy.

      Not to be used for the explicit recording of an absence (or negative presence) of a reaction to 'any substances' or to identified substances, for example ‘No known allergies or adverse reactions’ or ‘No known allergies to Penicillin’. Use the EVALUATION.exclusion_global or EVALUATION.exclusion_specific archetypes to express a positive statement of adverse reaction exclusion.

      Not to be used for the explicit recording that no information was able to be obtained about the adverse reaction status of a patient. Use the EVALUATION.absence archetype to record that a positive statement that information was not able to be obtained, for example, if a non-cooperative patient refuses to answer questions.

      Considerations

      Use to record a clinical assessment of a propensity for an adverse reaction upon future exposure to a specified substance or class of substances including, but not limited to, incipients and excipients in medicinal preparations, biological products, metal salts, and organic chemical compounds.

      This archetype is intended to provide a single place within the health record to document the propensity for the full range of reactions, from trivial to life-threatening:

      • immune-mediated: Types I-IV (including allergic reactions and hypersensitivities); or
      • non-immune-mediated: including pseudo-allergic reactions, side effects, intolerances, and drug toxicities. In clinical practice distinguishing between immune-mediated and non-immune-mediated reactions can be difficult. Identification of the type of reaction is not a proxy for seriousness or risk of harm to the patient.

      Where a propensity is identified, information or evidence about one or more reaction events can be recorded using the CLUSTER.adverse_reaction_event archetype in the 'Reaction event summary' SLOT.

      Identification of the severity of the manifestation of the reaction, recorded in the CLUSTER.adverse_reaction_event archetype, can inform the 'Criticality' of the adverse reaction risk. For example, experiencing anaphylaxis on first exposure to a substance would warrant setting a 'Criticality' of 'high', due to the high risk that anaphylaxis is likely to recur on second and subsequent exposures.

      This archetype has been designed to allow the recording of information about a specific substance (amoxycillin, oysters, or bee sting venom) or, alternatively, a class of substance (e.g. Penicillins). If a class of substance is recorded, identification of the exact substance can be recorded on a per-reaction basis using the CLUSTER.adverse_reaction_event archetype.

      Use to record information about the positive presence of the risk of an adverse reaction:

      • to support the direct clinical care of an individual;
      • as part of a managed adverse reaction or allergy/intolerance list;
      • to support the exchange of information about the propensity and events related to adverse reactions;
      • to inform adverse reaction reporting; and
      • to assist with computerised knowledge-based activities such as clinical decision support and alerts.

      The risk of an adverse reaction event or manifestation must always propose a causative substance or class of substance. If there is a degree of uncertainty that a specific substance is the cause, the level of uncertainty can be recorded using the ‘Verification status’ data element. If more than one possible substance may have caused a reaction/manifestation, each substance should be recorded using a separate instance of this adverse reaction risk archetype with the ‘Verification status’ set to an initial state of ‘Unconfirmed’ so that adverse reaction checking can be activated in clinical systems. If the substance is later proven not to be causal then the ‘Verification status’ can be modified to ‘Refuted’ - for example, after allergy testing.

      Control0..*
      Must Supporttrue
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      Alternate Namesreaction
      2. AdverseReactionRisk.Protocol
      Definition

      @ internal @

      ShortProtocol
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      4. AdverseReactionRisk.Protocol.Lastupdated
      Definition

      Date when the propensity or the reaction event was updated.

      ShortLast updated
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      6. AdverseReactionRisk.Protocol.Extension
      Definition

      Additional information required to capture local content or to align with other reference models/formalisms.

      ShortExtension
      Comments

      Considerations

      For example: local information requirements or additional metadata to align with FHIR equivalents.

      Control0..1
      TypeReference
      Must Supporttrue
      8. AdverseReactionRisk.Data
      Definition

      @ internal @

      ShortData
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      10. AdverseReactionRisk.Data.Substance
      Definition

      Identification of a substance, or substance class, that is considered to put the individual at risk of an adverse reaction event.

      ShortSubstance
      Comments

      Considerations

      Both an individual substance and a substance class are valid entries in 'Substance'. A substance may be a compound of simpler substances, for example a medicinal product. It is strongly recommended that the 'Substance' is coded with a terminology capable of triggering decision support, where possible. For example: Snomed CT, DM+D, RxNorm, NDFRT, ATC, New Zealand Universal List of Medicines and Australian Medicines Terminology. Free text entry should only be used if there is no appropriate terminology available.

      Control1..1
      TypeCodeableConcept
      Must Supporttrue
      12. AdverseReactionRisk.Data.Activeinactivestatus
      Definition

      Status about whether the adverse reaction risk statement is active or inactive.

      ShortActiveinactivestatus
      Control0..1
      TypeCoding
      Must Supporttrue
      14. AdverseReactionRisk.Data.Verificationstatus
      Definition

      Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction.

      ShortVerification status
      Comments

      Considerations

      Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology.

      Control0..1
      TypeCoding
      Must Supporttrue
      16. AdverseReactionRisk.Data.Criticality
      Definition

      An indication of the potential for critical system organ damage or life threatening consequence.

      ShortCriticality
      Comments

      Considerations

      This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      18. AdverseReactionRisk.Data.Category
      Definition

      Category of the identified 'Substance'.

      ShortCategory
      Comments

      Considerations

      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.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      20. AdverseReactionRisk.Data.Onsetoflastreaction
      Definition

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

      ShortOnset of last reaction
      Comments

      Considerations

      For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

      Control0..1
      TypeChoice of: dateTime, string
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      22. AdverseReactionRisk.Data.Onsetoffirstreaction
      Definition

      The onset of the first known occurrence of a reaction event.

      ShortOnset of first reaction
      Comments

      Considerations

      For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

      Control0..1
      TypeChoice of: dateTime, string
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      24. AdverseReactionRisk.Data.Reactionmechanism
      Definition

      Identification of the underlying physiological mechanism for the adverse reaction.

      ShortReaction mechanism
      Comments

      Considerations

      Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk.

      Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity.

      It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute.

      Control0..1
      TypeCodeableConcept
      Must Supporttrue
      26. AdverseReactionRisk.Data.Reactioneventsummary
      Definition

      Summary details about each adverse reaction event linked to exposure to the identified 'Substance'.

      ShortReaction event summary
      Control0..*
      TypeReference(Adverse Reaction Event)
      Must Supporttrue
      28. AdverseReactionRisk.Data.Comment
      Definition

      Additional narrative about the propensity for the adverse reaction, not captured in other fields.

      ShortComment
      Comments

      Considerations

      For example: including reason for flagging a 'Criticality' 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.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue

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

      0. AdverseReactionRisk
      Definition

      Clinical assessment of the propensity for an individual to experience a harmful or undesirable physiological response if exposed, or re-exposed, to a substance.

      ShortAdverse Reaction Risk
      Comments

      Purpose

      To record the clinical assessment of the propensity for an individual to experience an adverse reaction if exposed, or re-exposed, to a specified substance or class of substances.

      Misuse

      Not to be used for recording physiological reactions to physical agents, such as heat, cold, sunlight, vibration, exercise activity, by infectious agents or food contaminants. Use a specific archetype for EVALUATION.problem/diagnosis or CLUSTER.symptom/sign for this purpose.

      Not to be used to record adverse events, including failures of clinical process, interventions or products. For example: abnormal use, incorrect dosage or maladministration of an agent or substance; mislabelling; harm or injury caused by an intervention or procedure; overdose/poisoning etc. Use a specific archetype for the purpose.

      Not to be used to record an adverse reaction where the substance is unknown. Use EVALUATION.problem_diagnosis or CLUSTER.symptom_sign to record as part of the health record until a possible substance is identified.

      Not to be used to record reactions to transfusions of blood products. Use a specific archetype for this purpose.

      Not to be used for recording 'alerts'. Use EVALUATION.precaution, EVALUATION.contraindication or related archetypes for this purpose.

      Not to be used for recording failed therapy.

      Not to be used for the explicit recording of an absence (or negative presence) of a reaction to 'any substances' or to identified substances, for example ‘No known allergies or adverse reactions’ or ‘No known allergies to Penicillin’. Use the EVALUATION.exclusion_global or EVALUATION.exclusion_specific archetypes to express a positive statement of adverse reaction exclusion.

      Not to be used for the explicit recording that no information was able to be obtained about the adverse reaction status of a patient. Use the EVALUATION.absence archetype to record that a positive statement that information was not able to be obtained, for example, if a non-cooperative patient refuses to answer questions.

      Considerations

      Use to record a clinical assessment of a propensity for an adverse reaction upon future exposure to a specified substance or class of substances including, but not limited to, incipients and excipients in medicinal preparations, biological products, metal salts, and organic chemical compounds.

      This archetype is intended to provide a single place within the health record to document the propensity for the full range of reactions, from trivial to life-threatening:

      • immune-mediated: Types I-IV (including allergic reactions and hypersensitivities); or
      • non-immune-mediated: including pseudo-allergic reactions, side effects, intolerances, and drug toxicities. In clinical practice distinguishing between immune-mediated and non-immune-mediated reactions can be difficult. Identification of the type of reaction is not a proxy for seriousness or risk of harm to the patient.

      Where a propensity is identified, information or evidence about one or more reaction events can be recorded using the CLUSTER.adverse_reaction_event archetype in the 'Reaction event summary' SLOT.

      Identification of the severity of the manifestation of the reaction, recorded in the CLUSTER.adverse_reaction_event archetype, can inform the 'Criticality' of the adverse reaction risk. For example, experiencing anaphylaxis on first exposure to a substance would warrant setting a 'Criticality' of 'high', due to the high risk that anaphylaxis is likely to recur on second and subsequent exposures.

      This archetype has been designed to allow the recording of information about a specific substance (amoxycillin, oysters, or bee sting venom) or, alternatively, a class of substance (e.g. Penicillins). If a class of substance is recorded, identification of the exact substance can be recorded on a per-reaction basis using the CLUSTER.adverse_reaction_event archetype.

      Use to record information about the positive presence of the risk of an adverse reaction:

      • to support the direct clinical care of an individual;
      • as part of a managed adverse reaction or allergy/intolerance list;
      • to support the exchange of information about the propensity and events related to adverse reactions;
      • to inform adverse reaction reporting; and
      • to assist with computerised knowledge-based activities such as clinical decision support and alerts.

      The risk of an adverse reaction event or manifestation must always propose a causative substance or class of substance. If there is a degree of uncertainty that a specific substance is the cause, the level of uncertainty can be recorded using the ‘Verification status’ data element. If more than one possible substance may have caused a reaction/manifestation, each substance should be recorded using a separate instance of this adverse reaction risk archetype with the ‘Verification status’ set to an initial state of ‘Unconfirmed’ so that adverse reaction checking can be activated in clinical systems. If the substance is later proven not to be causal then the ‘Verification status’ can be modified to ‘Refuted’ - for example, after allergy testing.

      Control0..*
      Is Modifierfalse
      Must Supporttrue
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      Alternate Namesreaction
      2. AdverseReactionRisk.Protocol
      Definition

      @ internal @

      ShortProtocol
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. AdverseReactionRisk.Protocol.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
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      6. AdverseReactionRisk.Protocol.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 manageable, 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 AdverseReactionRisk.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 8. AdverseReactionRisk.Protocol.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 manageable, 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())
        10. AdverseReactionRisk.Protocol.Lastupdated
        Definition

        Date when the propensity or the reaction event was updated.

        ShortLast updated
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        12. AdverseReactionRisk.Protocol.Extension
        Definition

        Additional information required to capture local content or to align with other reference models/formalisms.

        ShortExtension
        Comments

        Considerations

        For example: local information requirements or additional metadata to align with FHIR equivalents.

        Control0..1
        TypeReference
        Must Supporttrue
        14. AdverseReactionRisk.Data
        Definition

        @ internal @

        ShortData
        Control0..1
        TypeBackboneElement
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. AdverseReactionRisk.Data.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
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        18. AdverseReactionRisk.Data.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 manageable, 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 AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. AdverseReactionRisk.Data.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 manageable, 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())
          22. AdverseReactionRisk.Data.Substance
          Definition

          Identification of a substance, or substance class, that is considered to put the individual at risk of an adverse reaction event.

          ShortSubstance
          Comments

          Considerations

          Both an individual substance and a substance class are valid entries in 'Substance'. A substance may be a compound of simpler substances, for example a medicinal product. It is strongly recommended that the 'Substance' is coded with a terminology capable of triggering decision support, where possible. For example: Snomed CT, DM+D, RxNorm, NDFRT, ATC, New Zealand Universal List of Medicines and Australian Medicines Terminology. Free text entry should only be used if there is no appropriate terminology available.

          Control1..1
          TypeCodeableConcept
          Must Supporttrue
          24. AdverseReactionRisk.Data.Activeinactivestatus
          Definition

          Status about whether the adverse reaction risk statement is active or inactive.

          ShortActiveinactivestatus
          Control0..1
          TypeCoding
          Must Supporttrue
          26. AdverseReactionRisk.Data.Verificationstatus
          Definition

          Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction.

          ShortVerification status
          Comments

          Considerations

          Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology.

          Control0..1
          TypeCoding
          Must Supporttrue
          28. AdverseReactionRisk.Data.Criticality
          Definition

          An indication of the potential for critical system organ damage or life threatening consequence.

          ShortCriticality
          Comments

          Considerations

          This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value.

          Control0..1
          TypeCodeableConcept
          Must Supporttrue
          30. AdverseReactionRisk.Data.Category
          Definition

          Category of the identified 'Substance'.

          ShortCategory
          Comments

          Considerations

          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.

          Control0..1
          TypeCodeableConcept
          Must Supporttrue
          32. AdverseReactionRisk.Data.Onsetoflastreaction
          Definition

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

          ShortOnset of last reaction
          Comments

          Considerations

          For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

          Control0..1
          TypeChoice of: dateTime, string
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          34. AdverseReactionRisk.Data.Onsetoffirstreaction
          Definition

          The onset of the first known occurrence of a reaction event.

          ShortOnset of first reaction
          Comments

          Considerations

          For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year.

          Control0..1
          TypeChoice of: dateTime, string
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          36. AdverseReactionRisk.Data.Reactionmechanism
          Definition

          Identification of the underlying physiological mechanism for the adverse reaction.

          ShortReaction mechanism
          Comments

          Considerations

          Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk.

          Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity.

          It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute.

          Control0..1
          TypeCodeableConcept
          Must Supporttrue
          38. AdverseReactionRisk.Data.Reactioneventsummary
          Definition

          Summary details about each adverse reaction event linked to exposure to the identified 'Substance'.

          ShortReaction event summary
          Control0..*
          TypeReference(Adverse Reaction Event)
          Must Supporttrue
          40. AdverseReactionRisk.Data.Comment
          Definition

          Additional narrative about the propensity for the adverse reaction, not captured in other fields.

          ShortComment
          Comments

          Considerations

          For example: including reason for flagging a 'Criticality' 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.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue