Social Care Interoperability Platform FHIR Implementation Guide
Version: 0.1.0, Status: draft

Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: MODSAllergy - Detailed Descriptions

Draft as of 2026-06-10

Definitions for the MODS-Allergy logical model.

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

0. MODS-Allergy
Definition

MODS Definition: Details about the Subject of care's allergies or adverse reactions.

ShortMODS Allergy
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MODS-Allergy.subjectOfCare
Definition

Subject of care who is the focus of the record

ShortSubject of care who is the focus of the record
Control1..1
TypeReference(MODS Subject of Care)
4. MODS-Allergy.type
Definition

The type of reaction experienced by the person (allergic, adverse, intolerance).

ShortThe type of reaction experienced by the person (allergic, adverse, intolerance).
Control0..1
BindingThe codes SHALL be taken from MODS Allergy - Type of Reaction
(required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1)
TypeCoding
6. MODS-Allergy.causativeAgent
Definition

The agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.

ShortThe agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.
Control1..1
BindingThe codes SHALL be taken from UK Core Allergy Code
(required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode)
TypeCoding
8. MODS-Allergy.observer
Definition

Care actor who made or recorded the observation.

ShortCare actor who made or recorded the observation.
Control0..1
TypeReference(MODS Care Worker)
10. MODS-Allergy.firstExperienced
Definition

When the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)

ShortWhen the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. MODS-Allergy.endDate
Definition

The date the allergy was diagnosed as ended

ShortThe date the allergy was diagnosed as ended
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. MODS-Allergy.comment
Definition

Any further comments on the person's allergies or adverse reactions.

ShortComment
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. MODS-Allergy.evidence
Definition

Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.

ShortEvidence
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. MODS-Allergy.reaction
Definition

Reaction

ShortReaction
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. MODS-Allergy.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. MODS-Allergy.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 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 MODS-Allergy.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 24. MODS-Allergy.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 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())
    26. MODS-Allergy.reaction.substance
    Definition

    Substance

    ShortSubstance
    Control0..1
    BindingThe codes SHALL be taken from UK Core Allergy Substance
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance)
    TypeCoding
    28. MODS-Allergy.reaction.description
    Definition

    Description

    ShortDescription
    Control0..1
    BindingThe codes SHALL be taken from SNOMEDCTClinicalFindings
    (required to http://hl7.org/fhir/ValueSet/clinical-findings)
    TypeCoding
    30. MODS-Allergy.reaction.severity
    Definition

    Severity

    ShortSeverity
    Control0..1
    BindingThe codes SHALL be taken from MODS Allergy - Allergy Severity
    (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1)
    TypeCoding
    32. MODS-Allergy.reaction.route
    Definition

    Route of exposure

    ShortRoute of exposure
    Control0..1
    BindingThe codes SHALL be taken from UK Core Substance Or Product Administration Route
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute)
    TypeCoding

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

    0. MODS-Allergy
    Definition

    MODS Definition: Details about the Subject of care's allergies or adverse reactions.

    ShortMODS Allergy
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. MODS-Allergy.subjectOfCare
    Definition

    Subject of care who is the focus of the record

    ShortSubject of care who is the focus of the record
    Control1..1
    TypeReference(MODS Subject of Care)
    4. MODS-Allergy.type
    Definition

    The type of reaction experienced by the person (allergic, adverse, intolerance).

    ShortThe type of reaction experienced by the person (allergic, adverse, intolerance).
    Control0..1
    BindingThe codes SHALL be taken from MODS Allergy - Type of Reaction
    (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1)
    TypeCoding
    6. MODS-Allergy.causativeAgent
    Definition

    The agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.

    ShortThe agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.
    Control1..1
    BindingThe codes SHALL be taken from UK Core Allergy Code
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode)
    TypeCoding
    8. MODS-Allergy.observer
    Definition

    Care actor who made or recorded the observation.

    ShortCare actor who made or recorded the observation.
    Control0..1
    TypeReference(MODS Care Worker)
    10. MODS-Allergy.firstExperienced
    Definition

    When the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)

    ShortWhen the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. MODS-Allergy.endDate
    Definition

    The date the allergy was diagnosed as ended

    ShortThe date the allergy was diagnosed as ended
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. MODS-Allergy.comment
    Definition

    Any further comments on the person's allergies or adverse reactions.

    ShortComment
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. MODS-Allergy.evidence
    Definition

    Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.

    ShortEvidence
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. MODS-Allergy.reaction
    Definition

    Reaction

    ShortReaction
    Control0..*
    TypeBackboneElement
    20. MODS-Allergy.reaction.substance
    Definition

    Substance

    ShortSubstance
    Control0..1
    BindingThe codes SHALL be taken from UK Core Allergy Substance
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance)
    TypeCoding
    22. MODS-Allergy.reaction.description
    Definition

    Description

    ShortDescription
    Control0..1
    BindingThe codes SHALL be taken from SNOMEDCTClinicalFindings
    (required to http://hl7.org/fhir/ValueSet/clinical-findings)
    TypeCoding
    24. MODS-Allergy.reaction.severity
    Definition

    Severity

    ShortSeverity
    Control0..1
    BindingThe codes SHALL be taken from MODS Allergy - Allergy Severity
    (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1)
    TypeCoding
    26. MODS-Allergy.reaction.route
    Definition

    Route of exposure

    ShortRoute of exposure
    Control0..1
    BindingThe codes SHALL be taken from UK Core Substance Or Product Administration Route
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute)
    TypeCoding

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

    0. MODS-Allergy
    Definition

    MODS Definition: Details about the Subject of care's allergies or adverse reactions.

    ShortMODS Allergy
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. MODS-Allergy.subjectOfCare
    Definition

    Subject of care who is the focus of the record

    ShortSubject of care who is the focus of the record
    Control1..1
    TypeReference(MODS Subject of Care)
    4. MODS-Allergy.type
    Definition

    The type of reaction experienced by the person (allergic, adverse, intolerance).

    ShortThe type of reaction experienced by the person (allergic, adverse, intolerance).
    Control0..1
    BindingThe codes SHALL be taken from MODS Allergy - Type of Reaction
    (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1)
    TypeCoding
    6. MODS-Allergy.causativeAgent
    Definition

    The agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.

    ShortThe agent such as food, drug or substances that has caused or may cause an allergy, intolerance or adverse reaction in this person Or 'No known drug allergies or adverse reactions' Or 'Information not available'.
    Control1..1
    BindingThe codes SHALL be taken from UK Core Allergy Code
    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode)
    TypeCoding
    8. MODS-Allergy.observer
    Definition

    Care actor who made or recorded the observation.

    ShortCare actor who made or recorded the observation.
    Control0..1
    TypeReference(MODS Care Worker)
    10. MODS-Allergy.firstExperienced
    Definition

    When the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)

    ShortWhen the reaction was first experienced i.e this may not be the first this has happened. May be a date or partial date (e.g. year) or text (e.g. during childhood)
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. MODS-Allergy.endDate
    Definition

    The date the allergy was diagnosed as ended

    ShortThe date the allergy was diagnosed as ended
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. MODS-Allergy.comment
    Definition

    Any further comments on the person's allergies or adverse reactions.

    ShortComment
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. MODS-Allergy.evidence
    Definition

    Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.

    ShortEvidence
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. MODS-Allergy.reaction
    Definition

    Reaction

    ShortReaction
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. MODS-Allergy.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
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    22. MODS-Allergy.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 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 MODS-Allergy.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. MODS-Allergy.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 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())
      26. MODS-Allergy.reaction.substance
      Definition

      Substance

      ShortSubstance
      Control0..1
      BindingThe codes SHALL be taken from UK Core Allergy Substance
      (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance)
      TypeCoding
      28. MODS-Allergy.reaction.description
      Definition

      Description

      ShortDescription
      Control0..1
      BindingThe codes SHALL be taken from SNOMEDCTClinicalFindings
      (required to http://hl7.org/fhir/ValueSet/clinical-findings)
      TypeCoding
      30. MODS-Allergy.reaction.severity
      Definition

      Severity

      ShortSeverity
      Control0..1
      BindingThe codes SHALL be taken from MODS Allergy - Allergy Severity
      (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1)
      TypeCoding
      32. MODS-Allergy.reaction.route
      Definition

      Route of exposure

      ShortRoute of exposure
      Control0..1
      BindingThe codes SHALL be taken from UK Core Substance Or Product Administration Route
      (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute)
      TypeCoding