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
| 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. |
| Short | MODS Allergy |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Subject of care who is the focus of the record |
| Control | 1..1 |
| Type | Reference(MODS Subject of Care) |
| 4. MODS-Allergy.type | |
| Definition | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Short | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Type of Reaction (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1) |
| Type | Coding |
| 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'. |
| Short | 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'. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Code (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode) |
| Type | Coding |
| 8. MODS-Allergy.observer | |
| Definition | Care actor who made or recorded the observation. |
| Short | Care actor who made or recorded the observation. |
| Control | 0..1 |
| Type | Reference(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) |
| Short | 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) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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 |
| Short | The date the allergy was diagnosed as ended |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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. |
| Short | Comment |
| Control | 0..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Evidence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. MODS-Allergy.reaction | |
| Definition | Reaction |
| Short | Reaction |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on MODS-Allergy.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Substance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Substance (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance) |
| Type | Coding |
| 28. MODS-Allergy.reaction.description | |
| Definition | Description |
| Short | Description |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SNOMEDCTClinicalFindings (required to http://hl7.org/fhir/ValueSet/clinical-findings) |
| Type | Coding |
| 30. MODS-Allergy.reaction.severity | |
| Definition | Severity |
| Short | Severity |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Allergy Severity (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1) |
| Type | Coding |
| 32. MODS-Allergy.reaction.route | |
| Definition | Route of exposure |
| Short | Route of exposure |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Substance Or Product Administration Route (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute) |
| Type | Coding |
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. |
| Short | MODS Allergy |
| Logical Model | Instances 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 |
| Short | Subject of care who is the focus of the record |
| Control | 1..1 |
| Type | Reference(MODS Subject of Care) |
| 4. MODS-Allergy.type | |
| Definition | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Short | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Type of Reaction (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1) |
| Type | Coding |
| 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'. |
| Short | 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'. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Code (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode) |
| Type | Coding |
| 8. MODS-Allergy.observer | |
| Definition | Care actor who made or recorded the observation. |
| Short | Care actor who made or recorded the observation. |
| Control | 0..1 |
| Type | Reference(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) |
| Short | 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) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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 |
| Short | The date the allergy was diagnosed as ended |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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. |
| Short | Comment |
| Control | 0..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Evidence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. MODS-Allergy.reaction | |
| Definition | Reaction |
| Short | Reaction |
| Control | 0..* |
| Type | BackboneElement |
| 20. MODS-Allergy.reaction.substance | |
| Definition | Substance |
| Short | Substance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Substance (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance) |
| Type | Coding |
| 22. MODS-Allergy.reaction.description | |
| Definition | Description |
| Short | Description |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SNOMEDCTClinicalFindings (required to http://hl7.org/fhir/ValueSet/clinical-findings) |
| Type | Coding |
| 24. MODS-Allergy.reaction.severity | |
| Definition | Severity |
| Short | Severity |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Allergy Severity (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1) |
| Type | Coding |
| 26. MODS-Allergy.reaction.route | |
| Definition | Route of exposure |
| Short | Route of exposure |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Substance Or Product Administration Route (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute) |
| Type | Coding |
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. |
| Short | MODS Allergy |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Subject of care who is the focus of the record |
| Control | 1..1 |
| Type | Reference(MODS Subject of Care) |
| 4. MODS-Allergy.type | |
| Definition | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Short | The type of reaction experienced by the person (allergic, adverse, intolerance). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Type of Reaction (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1) |
| Type | Coding |
| 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'. |
| Short | 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'. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Code (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode) |
| Type | Coding |
| 8. MODS-Allergy.observer | |
| Definition | Care actor who made or recorded the observation. |
| Short | Care actor who made or recorded the observation. |
| Control | 0..1 |
| Type | Reference(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) |
| Short | 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) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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 |
| Short | The date the allergy was diagnosed as ended |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This 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. |
| Short | Comment |
| Control | 0..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | Evidence |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. MODS-Allergy.reaction | |
| Definition | Reaction |
| Short | Reaction |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on MODS-Allergy.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Substance |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Allergy Substance (required to https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance) |
| Type | Coding |
| 28. MODS-Allergy.reaction.description | |
| Definition | Description |
| Short | Description |
| Control | 0..1 |
| Binding | The codes SHALL be taken from SNOMEDCTClinicalFindings (required to http://hl7.org/fhir/ValueSet/clinical-findings) |
| Type | Coding |
| 30. MODS-Allergy.reaction.severity | |
| Definition | Severity |
| Short | Severity |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MODS Allergy - Allergy Severity (required to https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1) |
| Type | Coding |
| 32. MODS-Allergy.reaction.route | |
| Definition | Route of exposure |
| Short | Route of exposure |
| Control | 0..1 |
| Binding | The codes SHALL be taken from UK Core Substance Or Product Administration Route (required to https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute) |
| Type | Coding |