{ "resourceType" : "StructureDefinition", "id" : "MODS-Allergy", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition MODS-Allergy

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" MODS-Allergy 0..*BaseMODS Allergy
Instances of this logical model can be the target of a Reference
\".\"\".\"\".\" subjectOfCare 1..1Reference(MODS Subject of Care)Subject of care who is the focus of the record
\".\"\".\"\".\" type 0..1CodingThe type of reaction experienced by the person (allergic, adverse, intolerance).
Binding: MODS Allergy - Type of Reaction (required)
\".\"\".\"\".\" causativeAgent 1..1CodingThe 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'.
Binding: UK Core Allergy Code (required)
\".\"\".\"\".\" observer 0..1Reference(MODS Care Worker)Care actor who made or recorded the observation.
\".\"\".\"\".\" firstExperienced 0..1dateTimeWhen 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)
\".\"\".\"\".\" endDate 0..1dateTimeThe date the allergy was diagnosed as ended
\".\"\".\"\".\" comment 0..1stringComment
\".\"\".\"\".\" evidence 0..1stringEvidence
\".\"\".\"\".\" reaction 0..*BackboneElementReaction
\".\"\".\"\".\"\".\" substance 0..1CodingSubstance
Binding: UK Core Allergy Substance (required)
\".\"\".\"\".\"\".\" description 0..1CodingDescription
Binding: SNOMEDCTClinicalFindings (required)
\".\"\".\"\".\"\".\" severity 0..1CodingSeverity
Binding: MODS Allergy - Allergy Severity (required)
\".\"\".\"\".\"\".\" route 0..1CodingRoute of exposure
Binding: UK Core Substance Or Product Administration Route (required)

\"doco\" Documentation for this format
" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics", "valueCode" : "can-be-target" }], "url" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Allergy", "version" : "0.1.0", "name" : "MODSAllergy", "title" : "MODS Allergy", "status" : "draft", "date" : "2026-06-10T19:05:58+00:00", "publisher" : "Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform", "contact" : [{ "name" : "Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform", "telecom" : [{ "system" : "url", "value" : "https://synanetics.com" }, { "system" : "email", "value" : "info@synanetics.com" }] }], "description" : "MODS Definition: Details about the Subject of care's allergies or adverse reactions.", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "GB", "display" : "United Kingdom of Great Britain and Northern Ireland" }] }], "fhirVersion" : "4.0.1", "kind" : "logical", "abstract" : false, "type" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Allergy", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base", "derivation" : "specialization", "snapshot" : { "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString" : "4.0.1" }], "element" : [{ "id" : "MODS-Allergy", "path" : "MODS-Allergy", "short" : "MODS Allergy", "definition" : "MODS Definition: Details about the Subject of care's allergies or adverse reactions.", "min" : 0, "max" : "*", "base" : { "path" : "Base", "min" : 0, "max" : "*" }, "isModifier" : false }, { "id" : "MODS-Allergy.subjectOfCare", "path" : "MODS-Allergy.subjectOfCare", "short" : "Subject of care who is the focus of the record", "definition" : "Subject of care who is the focus of the record", "min" : 1, "max" : "1", "base" : { "path" : "MODS-Allergy.subjectOfCare", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCare"] }] }, { "id" : "MODS-Allergy.type", "path" : "MODS-Allergy.type", "short" : "The type of reaction experienced by the person (allergic, adverse, intolerance).", "definition" : "The type of reaction experienced by the person (allergic, adverse, intolerance).", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.type", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1" } }, { "id" : "MODS-Allergy.causativeAgent", "path" : "MODS-Allergy.causativeAgent", "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'.", "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'.", "min" : 1, "max" : "1", "base" : { "path" : "MODS-Allergy.causativeAgent", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" } }, { "id" : "MODS-Allergy.observer", "path" : "MODS-Allergy.observer", "short" : "Care actor who made or recorded the observation.", "definition" : "Care actor who made or recorded the observation.", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.observer", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-CareWorker"] }] }, { "id" : "MODS-Allergy.firstExperienced", "path" : "MODS-Allergy.firstExperienced", "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)", "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)", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.firstExperienced", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }] }, { "id" : "MODS-Allergy.endDate", "path" : "MODS-Allergy.endDate", "short" : "The date the allergy was diagnosed as ended", "definition" : "The date the allergy was diagnosed as ended", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.endDate", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }] }, { "id" : "MODS-Allergy.comment", "path" : "MODS-Allergy.comment", "short" : "Comment", "definition" : "Any further comments on the person's allergies or adverse reactions.", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.comment", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "MODS-Allergy.evidence", "path" : "MODS-Allergy.evidence", "short" : "Evidence", "definition" : "Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.evidence", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "MODS-Allergy.reaction", "path" : "MODS-Allergy.reaction", "short" : "Reaction", "definition" : "Reaction", "min" : 0, "max" : "*", "base" : { "path" : "MODS-Allergy.reaction", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }] }, { "id" : "MODS-Allergy.reaction.id", "path" : "MODS-Allergy.reaction.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "MODS-Allergy.reaction.extension", "path" : "MODS-Allergy.reaction.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "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.", "comment" : "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "MODS-Allergy.reaction.modifierExtension", "path" : "MODS-Allergy.reaction.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment" : "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.", "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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "MODS-Allergy.reaction.substance", "path" : "MODS-Allergy.reaction.substance", "short" : "Substance", "definition" : "Substance", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.reaction.substance", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" } }, { "id" : "MODS-Allergy.reaction.description", "path" : "MODS-Allergy.reaction.description", "short" : "Description", "definition" : "Description", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.reaction.description", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" } }, { "id" : "MODS-Allergy.reaction.severity", "path" : "MODS-Allergy.reaction.severity", "short" : "Severity", "definition" : "Severity", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.reaction.severity", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1" } }, { "id" : "MODS-Allergy.reaction.route", "path" : "MODS-Allergy.reaction.route", "short" : "Route of exposure", "definition" : "Route of exposure", "min" : 0, "max" : "1", "base" : { "path" : "MODS-Allergy.reaction.route", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" } }] }, "differential" : { "element" : [{ "id" : "MODS-Allergy", "path" : "MODS-Allergy", "short" : "MODS Allergy", "definition" : "MODS Definition: Details about the Subject of care's allergies or adverse reactions." }, { "id" : "MODS-Allergy.subjectOfCare", "path" : "MODS-Allergy.subjectOfCare", "short" : "Subject of care who is the focus of the record", "definition" : "Subject of care who is the focus of the record", "min" : 1, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCare"] }] }, { "id" : "MODS-Allergy.type", "path" : "MODS-Allergy.type", "short" : "The type of reaction experienced by the person (allergic, adverse, intolerance).", "definition" : "The type of reaction experienced by the person (allergic, adverse, intolerance).", "min" : 0, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1" } }, { "id" : "MODS-Allergy.causativeAgent", "path" : "MODS-Allergy.causativeAgent", "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'.", "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'.", "min" : 1, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode" } }, { "id" : "MODS-Allergy.observer", "path" : "MODS-Allergy.observer", "short" : "Care actor who made or recorded the observation.", "definition" : "Care actor who made or recorded the observation.", "min" : 0, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-CareWorker"] }] }, { "id" : "MODS-Allergy.firstExperienced", "path" : "MODS-Allergy.firstExperienced", "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)", "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)", "min" : 0, "max" : "1", "type" : [{ "code" : "dateTime" }] }, { "id" : "MODS-Allergy.endDate", "path" : "MODS-Allergy.endDate", "short" : "The date the allergy was diagnosed as ended", "definition" : "The date the allergy was diagnosed as ended", "min" : 0, "max" : "1", "type" : [{ "code" : "dateTime" }] }, { "id" : "MODS-Allergy.comment", "path" : "MODS-Allergy.comment", "short" : "Comment", "definition" : "Any further comments on the person's allergies or adverse reactions.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "MODS-Allergy.evidence", "path" : "MODS-Allergy.evidence", "short" : "Evidence", "definition" : "Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "MODS-Allergy.reaction", "path" : "MODS-Allergy.reaction", "short" : "Reaction", "definition" : "Reaction", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "MODS-Allergy.reaction.substance", "path" : "MODS-Allergy.reaction.substance", "short" : "Substance", "definition" : "Substance", "min" : 0, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance" } }, { "id" : "MODS-Allergy.reaction.description", "path" : "MODS-Allergy.reaction.description", "short" : "Description", "definition" : "Description", "min" : 0, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings" } }, { "id" : "MODS-Allergy.reaction.severity", "path" : "MODS-Allergy.reaction.severity", "short" : "Severity", "definition" : "Severity", "min" : 0, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1" } }, { "id" : "MODS-Allergy.reaction.route", "path" : "MODS-Allergy.reaction.route", "short" : "Route of exposure", "definition" : "Route of exposure", "min" : 0, "max" : "1", "type" : [{ "code" : "Coding" }], "binding" : { "strength" : "required", "valueSet" : "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" } }] } }