PackagesCanonicalsLogsProblems
    Packages
    xtehr.eu.ehds.models@0.3.0
    http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAllergyIntolerance
{
  "description": "Model for allergy or intolerance.",
  "_filename": "StructureDefinition-EHDSAllergyIntolerance.json",
  "package_name": "xtehr.eu.ehds.models",
  "date": "2026-02-06T19:30:52+01:00",
  "derivation": "specialization",
  "publisher": "Xt-EHR",
  "fhirVersion": "5.0.0",
  "name": "EHDSAllergyIntolerance",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAllergyIntolerance",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Allergy intolerance model",
  "package_version": "0.3.0",
  "snapshot": {
    "element": [ {
      "path": "EHDSAllergyIntolerance",
      "min": 0,
      "definition": "Model for allergy or intolerance.",
      "isModifier": false,
      "short": "Allergy intolerance model",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "EHDSAllergyIntolerance",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "EHDSAllergyIntolerance.header",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header"
      },
      "path": "EHDSAllergyIntolerance.header",
      "type": [ {
        "code": "Base"
      } ],
      "short": "Basic metadata for this information",
      "definition": "Basic metadata for this information"
    }, {
      "id": "EHDSAllergyIntolerance.header.subject",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header.subject"
      },
      "path": "EHDSAllergyIntolerance.header.subject",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"
      } ],
      "short": "Patient/subject information",
      "definition": "Patient/subject information"
    }, {
      "id": "EHDSAllergyIntolerance.header.identifier",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSDataSet.header.identifier"
      },
      "path": "EHDSAllergyIntolerance.header.identifier",
      "type": [ {
        "code": "Identifier"
      } ],
      "short": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
      "definition": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries)."
    }, {
      "id": "EHDSAllergyIntolerance.header.author[x]",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSDataSet.header.author[x]"
      },
      "path": "EHDSAllergyIntolerance.header.author[x]",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
      }, {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
      }, {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice"
      } ],
      "short": "The author of the allergy/intolerance information.",
      "definition": "The author of the allergy/intolerance information."
    }, {
      "id": "EHDSAllergyIntolerance.header.date",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.date"
      },
      "path": "EHDSAllergyIntolerance.header.date",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Date and optionally time of authoring/issuing",
      "definition": "Date and optionally time of authoring/issuing"
    }, {
      "path": "EHDSAllergyIntolerance.header.status",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 1,
      "definition": "Current status of the allergy or intolerance, for example, whether it is active, in remission, resolved, etc.",
      "short": "Current status of the allergy or intolerance, for example, whether it is active, in remission, resolved, etc.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance status"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.header.status",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header.status"
      }
    }, {
      "id": "EHDSAllergyIntolerance.header.source",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.source"
      },
      "path": "EHDSAllergyIntolerance.header.source",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.",
      "definition": "Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information."
    }, {
      "path": "EHDSAllergyIntolerance.header.language",
      "min": 0,
      "definition": "Language in which the resource is written. Language is expressed by the IETF language tag.",
      "short": "Language in which the resource is written. Language is expressed by the IETF language tag.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "BCP 47"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.header.language",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.language"
      }
    }, {
      "path": "EHDSAllergyIntolerance.agentOrAllergen",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 1,
      "definition": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\")\n  It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.",
      "short": "Code that identifies the allergy or intolerance",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "ATC, EMA SPOR SMS, SNOMED CT"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.agentOrAllergen",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSAllergyIntolerance.agentOrAllergen"
      }
    }, {
      "path": "EHDSAllergyIntolerance.note",
      "requirements": "eHN PS Guideline, ISO IPS",
      "min": 0,
      "definition": "Additional information about the allergy or intolerance",
      "short": "Additional information about the allergy or intolerance",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "EHDSAllergyIntolerance.note",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.note"
      }
    }, {
      "path": "EHDSAllergyIntolerance.criticality",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
      "short": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance criticality"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.criticality",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.criticality"
      }
    }, {
      "path": "EHDSAllergyIntolerance.certainty",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "Assertion about the certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Diagnostic and /or clinical evidence of condition",
      "short": "Assertion about the certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Diagnostic and /or clinical evidence of condition",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance verification"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.certainty",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.certainty"
      }
    }, {
      "path": "EHDSAllergyIntolerance.onsetDate",
      "requirements": "MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "When allergy or intolerance was identified",
      "short": "When allergy or intolerance was identified",
      "type": [ {
        "code": "dateTime"
      } ],
      "max": "1",
      "id": "EHDSAllergyIntolerance.onsetDate",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.onsetDate"
      }
    }, {
      "path": "EHDSAllergyIntolerance.endDate",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "Date of resolution of the allergy (e.g. when the clinician deemed there is no longer any need to track the underlying condition)",
      "short": "Date of resolution of the allergy (e.g. when the clinician deemed there is no longer any need to track the underlying condition)",
      "type": [ {
        "code": "dateTime"
      } ],
      "max": "1",
      "id": "EHDSAllergyIntolerance.endDate",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.endDate"
      }
    }, {
      "path": "EHDSAllergyIntolerance.reaction",
      "requirements": "ISO IPS (explicit), implicitly in eHN PS Guideline, MH@EU",
      "min": 0,
      "definition": "Adverse reaction events linked to exposure to substance.",
      "short": "Adverse reaction events linked to exposure to substance.",
      "type": [ {
        "code": "Base"
      } ],
      "max": "*",
      "id": "EHDSAllergyIntolerance.reaction",
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSAllergyIntolerance.reaction"
      }
    }, {
      "id": "EHDSAllergyIntolerance.reaction.agentOrAllergen",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.reaction.agentOrAllergen"
      },
      "path": "EHDSAllergyIntolerance.reaction.agentOrAllergen",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "Specific substance or pharmaceutical product considered to be responsible for event",
      "definition": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the \n  Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified  as the cause of the risk, but it must be consistent with it.  \n  It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'."
    }, {
      "path": "EHDSAllergyIntolerance.reaction.manifestation",
      "requirements": "The element is present in eHN PS GL, MyHealth@EU specifications and ISO IPS. Element name and description is taken from eHN PS GL. Cardinality in MyHealth@EU for this element, used here, is one manifestation per severity and onset, while the cardinality in FHIR IPS IG allows multiple manifestations per severity and onset.",
      "min": 0,
      "definition": "Description of the clinical manifestation of the allergic reaction. Example: anaphylactic shock, angioedema. (the clinical manifestation also gives information about the severity of the observed reaction).",
      "short": "Description of the clinical manifestation of the allergic reaction. Example: anaphylactic shock, angioedema. (the clinical manifestation also gives information about the severity of the observed reaction).",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "ICD-10, SNOMED CT"
      },
      "max": "*",
      "id": "EHDSAllergyIntolerance.reaction.manifestation",
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSAllergyIntolerance.reaction.manifestation"
      }
    }, {
      "path": "EHDSAllergyIntolerance.reaction.severity",
      "requirements": "The element is present in eHN PS GL, MyHealth@EU specifications and ISO IPS. Element name and description is taken from eHN PS GL.",
      "min": 0,
      "definition": "Severity of the clinical manifestation of the allergic reaction.",
      "short": "Severity of the clinical manifestation of the allergic reaction.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "SNOMED CT, HL7 reaction event severity"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.reaction.severity",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.reaction.severity"
      }
    }, {
      "path": "EHDSAllergyIntolerance.reaction.onset",
      "requirements": "The element is present in eHN PS GL. Element name and description is taken from eHN PS GL.",
      "min": 0,
      "definition": "Date and time of the onset of the reaction",
      "short": "Date and time of the onset of the reaction",
      "type": [ {
        "code": "dateTime"
      } ],
      "max": "1",
      "id": "EHDSAllergyIntolerance.reaction.onset",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSAllergyIntolerance.reaction.onset"
      }
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "0.3.0"
    } ]
  },
  "status": "draft",
  "id": "310cbd51-960d-4a19-a79f-13ce6b44b1ab",
  "kind": "logical",
  "url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSAllergyIntolerance",
  "version": "0.3.0",
  "differential": {
    "element": [ {
      "id": "EHDSAllergyIntolerance",
      "path": "EHDSAllergyIntolerance",
      "short": "Allergy intolerance model",
      "definition": "Model for allergy or intolerance."
    }, {
      "id": "EHDSAllergyIntolerance.header.author[x]",
      "path": "EHDSAllergyIntolerance.header.author[x]",
      "short": "The author of the allergy/intolerance information.",
      "definition": "The author of the allergy/intolerance information."
    }, {
      "id": "EHDSAllergyIntolerance.header.status",
      "path": "EHDSAllergyIntolerance.header.status",
      "short": "Current status of the allergy or intolerance, for example, whether it is active, in remission, resolved, etc.",
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance status"
      },
      "definition": "Current status of the allergy or intolerance, for example, whether it is active, in remission, resolved, etc.",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS"
    }, {
      "path": "EHDSAllergyIntolerance.agentOrAllergen",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 1,
      "definition": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\")\n  It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. ",
      "short": "Code that identifies the allergy or intolerance",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "ATC, EMA SPOR SMS, SNOMED CT"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.agentOrAllergen"
    }, {
      "id": "EHDSAllergyIntolerance.note",
      "max": "1",
      "min": 0,
      "path": "EHDSAllergyIntolerance.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Additional information about the allergy or intolerance",
      "definition": "Additional information about the allergy or intolerance",
      "requirements": "eHN PS Guideline, ISO IPS"
    }, {
      "path": "EHDSAllergyIntolerance.criticality",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
      "short": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance criticality"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.criticality"
    }, {
      "path": "EHDSAllergyIntolerance.certainty",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS",
      "min": 0,
      "definition": "Assertion about the certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Diagnostic and /or clinical evidence of condition",
      "short": "Assertion about the certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Diagnostic and /or clinical evidence of condition",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "HL7 allergy intolerance verification"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.certainty"
    }, {
      "id": "EHDSAllergyIntolerance.onsetDate",
      "max": "1",
      "min": 0,
      "path": "EHDSAllergyIntolerance.onsetDate",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "When allergy or intolerance was identified",
      "definition": "When allergy or intolerance was identified",
      "requirements": "MyHealth@EU, ISO IPS"
    }, {
      "id": "EHDSAllergyIntolerance.endDate",
      "max": "1",
      "min": 0,
      "path": "EHDSAllergyIntolerance.endDate",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Date of resolution of the allergy (e.g. when the clinician deemed there is no longer any need to track the underlying condition)",
      "definition": "Date of resolution of the allergy (e.g. when the clinician deemed there is no longer any need to track the underlying condition)",
      "requirements": "eHN PS Guideline, MyHealth@EU, ISO IPS"
    }, {
      "id": "EHDSAllergyIntolerance.reaction",
      "max": "*",
      "min": 0,
      "path": "EHDSAllergyIntolerance.reaction",
      "type": [ {
        "code": "Base"
      } ],
      "short": "Adverse reaction events linked to exposure to substance.",
      "definition": "Adverse reaction events linked to exposure to substance.",
      "requirements": "ISO IPS (explicit), implicitly in eHN PS Guideline, MH@EU"
    }, {
      "id": "EHDSAllergyIntolerance.reaction.agentOrAllergen",
      "max": "1",
      "min": 0,
      "path": "EHDSAllergyIntolerance.reaction.agentOrAllergen",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "Specific substance or pharmaceutical product considered to be responsible for event",
      "definition": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the \n  Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified  as the cause of the risk, but it must be consistent with it.  \n  It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. "
    }, {
      "path": "EHDSAllergyIntolerance.reaction.manifestation",
      "requirements": "The element is present in eHN PS GL, MyHealth@EU specifications and ISO IPS. Element name and description is taken from eHN PS GL. Cardinality in MyHealth@EU for this element, used here, is one manifestation per severity and onset, while the cardinality in FHIR IPS IG allows multiple manifestations per severity and onset.",
      "min": 0,
      "definition": "Description of the clinical manifestation of the allergic reaction. Example: anaphylactic shock, angioedema. (the clinical manifestation also gives information about the severity of the observed reaction).",
      "short": "Description of the clinical manifestation of the allergic reaction. Example: anaphylactic shock, angioedema. (the clinical manifestation also gives information about the severity of the observed reaction).",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "ICD-10, SNOMED CT"
      },
      "max": "*",
      "id": "EHDSAllergyIntolerance.reaction.manifestation"
    }, {
      "path": "EHDSAllergyIntolerance.reaction.severity",
      "requirements": "The element is present in eHN PS GL, MyHealth@EU specifications and ISO IPS. Element name and description is taken from eHN PS GL.",
      "min": 0,
      "definition": "Severity of the clinical manifestation of the allergic reaction.",
      "short": "Severity of the clinical manifestation of the allergic reaction.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "SNOMED CT, HL7 reaction event severity"
      },
      "max": "1",
      "id": "EHDSAllergyIntolerance.reaction.severity"
    }, {
      "id": "EHDSAllergyIntolerance.reaction.onset",
      "max": "1",
      "min": 0,
      "path": "EHDSAllergyIntolerance.reaction.onset",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Date and time of the onset of the reaction",
      "definition": "Date and time of the onset of the reaction",
      "requirements": "The element is present in eHN PS GL. Element name and description is taken from eHN PS GL."
    } ]
  },
  "contact": [ {
    "name": "Xt-EHR",
    "telecom": [ {
      "value": "http://www.xt-ehr.eu/",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDataSet"
}