MODS-Allergy
type: StructureDefinition
node role: treeRoot
id:
  v: MODS-Allergy
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition MODS-Allergy Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> MODS-Allergy 0..* Base MODS Allergy Instances of this logical model can be the target of a Reference #xD; subjectOfCare 1..1 Reference(MODS Subject of Care) Subject of care who is the focus of the record #xD; type 0..1 Coding The type of reaction experienced by the person (allergic, adverse, intolerance). Binding: MODS Allergy - Type of Reaction (required) #xD; causativeAgent 1..1 Coding 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'. Binding: UK Core Allergy Code (required) #xD; observer 0..1 Reference(MODS Care Worker) Care actor who made or recorded the observation. #xD; firstExperienced 0..1 dateTime 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) #xD; endDate 0..1 dateTime The date the allergy was diagnosed as ended #xD; comment 0..1 string Comment #xD; evidence 0..1 string Evidence #xD; reaction 0..* BackboneElement Reaction #xD; substance 0..1 Coding Substance Binding: UK Core Allergy Substance (required) #xD; description 0..1 Coding Description Binding: SNOMEDCTClinicalFindings (required) #xD; severity 0..1 Coding Severity Binding: MODS Allergy - Allergy Severity (required) #xD; route 0..1 Coding Route of exposure Binding: UK Core Substance Or Product Administration Route (required) #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics
    l: structuredefinition-type-characteristics
  value: Code
    v: can-be-target
url:
  v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Allergy
  l: MODS-Allergy
version:
  v: 0.1.0
name:
  v: MODSAllergy
title:
  v: MODS Allergy
status:
  v: draft
date:
  v: 2026-06-10T19:05:58+00:00
publisher:
  v: Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform
contact:
  name:
    v: Synanetics Ltd on behalf of DHSC/Social Care Interoperability Platform
  telecom:
    system:
      v: url
    value:
      v: https://synanetics.com
  telecom:
    system:
      v: email
description:
  v: MODS Definition: Details about the Subject of care's allergies or adverse reactions.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: GB
    display:
      v: United Kingdom of Great Britain and Northern Ireland
fhir version:
  v: 4.0.1
kind:
  v: logical
abstract:
  v: false
type:
  v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Allergy
  l: MODS-Allergy
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: MODS-Allergy
    path:
      v: MODS-Allergy
    short:
      v: MODS Allergy
    definition:
      v: MODS Definition: Details about the Subject of care's allergies or adverse reactions.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
  element:
    id:
      v: MODS-Allergy.subjectOfCare
    path:
      v: MODS-Allergy.subjectOfCare
    short:
      v: Subject of care who is the focus of the record
    definition:
      v: Subject of care who is the focus of the record
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: MODS-Allergy.subjectOfCare
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: Reference
        l: Reference
      target profile:
        v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCare
        l: MODS-SubjectOfCare
  element:
    id:
      v: MODS-Allergy.type
    path:
      v: MODS-Allergy.type
    short:
      v: The type of reaction experienced by the person (allergic, adverse, intolerance).
    definition:
      v: The type of reaction experienced by the person (allergic, adverse, intolerance).
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: MODS-Allergy.type
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: Coding
        l: Coding
    binding:
      strength:
        v: required
      value set:
        v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1
        l: MODS-TypeOfReaction-1
  element:
    id:
      v: MODS-Allergy.causativeAgent
    path:
      v: MODS-Allergy.causativeAgent
    short:
      v: 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:
      v: 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:
      v: 1
    max:
      v: 1
    base:
      path:
        v: MODS-Allergy.causativeAgent
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: Coding
        l: Coding
    binding:
      strength:
        v: required
      value set:
        v: https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode
        l: UKCore-AllergyCode
  element:
    id:
      v: MODS-Allergy.observer
    path:
      v: MODS-Allergy.observer
    short:
      v: Care actor who made or recorded the observation.
    definition:
      v: Care actor who made or recorded the observation.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: MODS-Allergy.observer
      min:
        v: 0
      max:
        v: 1

code:
  v: Reference
  l: Reference
target profile:
  v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-CareWorker
  l: MODS-CareWorker

id:
  v: MODS-Allergy.firstExperienced
path:
  v: MODS-Allergy.firstExperienced
short:
  v: 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:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.firstExperienced
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: MODS-Allergy.endDate
path:
  v: MODS-Allergy.endDate
short:
  v: The date the allergy was diagnosed as ended
definition:
  v: The date the allergy was diagnosed as ended
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.endDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: MODS-Allergy.comment
path:
  v: MODS-Allergy.comment
short:
  v: Comment
definition:
  v: Any further comments on the person's allergies or adverse reactions.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.comment
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: MODS-Allergy.evidence
path:
  v: MODS-Allergy.evidence
short:
  v: Evidence
definition:
  v: Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.evidence
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: MODS-Allergy.reaction
path:
  v: MODS-Allergy.reaction
short:
  v: Reaction
definition:
  v: Reaction
min:
  v: 0
max:
  v: *
base:
  path:
    v: MODS-Allergy.reaction
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: MODS-Allergy.reaction.id
path:
  v: MODS-Allergy.reaction.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: MODS-Allergy.reaction.extension
path:
  v: MODS-Allergy.reaction.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: MODS-Allergy.reaction.modifierExtension
path:
  v: MODS-Allergy.reaction.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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:
  v: 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:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: MODS-Allergy.reaction.substance
path:
  v: MODS-Allergy.reaction.substance
short:
  v: Substance
definition:
  v: Substance
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.reaction.substance
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance
    l: UKCore-AllergySubstance

id:
  v: MODS-Allergy.reaction.description
path:
  v: MODS-Allergy.reaction.description
short:
  v: Description
definition:
  v: Description
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.reaction.description
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/ValueSet/clinical-findings
    l: clinical-findings

id:
  v: MODS-Allergy.reaction.severity
path:
  v: MODS-Allergy.reaction.severity
short:
  v: Severity
definition:
  v: Severity
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.reaction.severity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1
    l: MODS-AllergySeverity-1

id:
  v: MODS-Allergy.reaction.route
path:
  v: MODS-Allergy.reaction.route
short:
  v: Route of exposure
definition:
  v: Route of exposure
min:
  v: 0
max:
  v: 1
base:
  path:
    v: MODS-Allergy.reaction.route
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute
    l: UKCore-SubstanceOrProductAdministrationRoute

element:
  id:
    v: MODS-Allergy
  path:
    v: MODS-Allergy
  short:
    v: MODS Allergy
  definition:
    v: MODS Definition: Details about the Subject of care's allergies or adverse reactions.
element:
  id:
    v: MODS-Allergy.subjectOfCare
  path:
    v: MODS-Allergy.subjectOfCare
  short:
    v: Subject of care who is the focus of the record
  definition:
    v: Subject of care who is the focus of the record
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-SubjectOfCare
      l: MODS-SubjectOfCare
element:
  id:
    v: MODS-Allergy.type
  path:
    v: MODS-Allergy.type
  short:
    v: The type of reaction experienced by the person (allergic, adverse, intolerance).
  definition:
    v: The type of reaction experienced by the person (allergic, adverse, intolerance).
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Coding
      l: Coding
  binding:
    strength:
      v: required
    value set:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-TypeOfReaction-1
      l: MODS-TypeOfReaction-1
element:
  id:
    v: MODS-Allergy.causativeAgent
  path:
    v: MODS-Allergy.causativeAgent
  short:
    v: 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:
    v: 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:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Coding
      l: Coding
  binding:
    strength:
      v: required
    value set:
      v: https://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode
      l: UKCore-AllergyCode
element:
  id:
    v: MODS-Allergy.observer
  path:
    v: MODS-Allergy.observer
  short:
    v: Care actor who made or recorded the observation.
  definition:
    v: Care actor who made or recorded the observation.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-CareWorker
      l: MODS-CareWorker
element:
  id:
    v: MODS-Allergy.firstExperienced
  path:
    v: MODS-Allergy.firstExperienced
  short:
    v: 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:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: MODS-Allergy.endDate
  path:
    v: MODS-Allergy.endDate
  short:
    v: The date the allergy was diagnosed as ended
  definition:
    v: The date the allergy was diagnosed as ended
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: MODS-Allergy.comment
  path:
    v: MODS-Allergy.comment
  short:
    v: Comment
  definition:
    v: Any further comments on the person's allergies or adverse reactions.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: MODS-Allergy.evidence
  path:
    v: MODS-Allergy.evidence
  short:
    v: Evidence
  definition:
    v: Results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: MODS-Allergy.reaction
  path:
    v: MODS-Allergy.reaction
  short:
    v: Reaction
  definition:
    v: Reaction
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: BackboneElement
      l: BackboneElement
element:
  id:
    v: MODS-Allergy.reaction.substance
  path:
    v: MODS-Allergy.reaction.substance
  short:
    v: Substance
  definition:
    v: Substance
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Coding
      l: Coding
  binding:
    strength:
      v: required
    value set:
      v: https://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance
      l: UKCore-AllergySubstance

id:
  v: MODS-Allergy.reaction.description
path:
  v: MODS-Allergy.reaction.description
short:
  v: Description
definition:
  v: Description
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/ValueSet/clinical-findings
    l: clinical-findings

id:
  v: MODS-Allergy.reaction.severity
path:
  v: MODS-Allergy.reaction.severity
short:
  v: Severity
definition:
  v: Severity
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/ValueSet/MODS-AllergySeverity-1
    l: MODS-AllergySeverity-1

id:
  v: MODS-Allergy.reaction.route
path:
  v: MODS-Allergy.reaction.route
short:
  v: Route of exposure
definition:
  v: Route of exposure
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute
    l: UKCore-SubstanceOrProductAdministrationRoute