{
  "description": "Allergy / Intolerance information model",
  "_filename": "StructureDefinition-be-model-allergyintolerance.json",
  "package_name": "hl7.fhir.be.allergy",
  "date": "2022-09-13T17:51:47+02:00",
  "derivation": "specialization",
  "publisher": "eHealth Platform",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "BE",
      "system": "urn:iso:std:iso:3166",
      "display": "Belgium"
    } ]
  } ],
  "name": "BeModelAllergyIntolerance",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-model-allergyintolerance",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Allergy Intolerance Logical Model",
  "package_version": "1.0.1",
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "be-model-allergyintolerance",
      "min": 0,
      "definition": "Allergy / Intolerance information model",
      "isModifier": false,
      "short": "Allergy Intolerance Logical Model",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "be-model-allergyintolerance",
      "condition": [ "ele-1" ],
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element"
      }
    }, {
      "path": "be-model-allergyintolerance.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "be-model-allergyintolerance.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "be-model-allergyintolerance.extension",
      "min": 0,
      "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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "be-model-allergyintolerance.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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "id": "be-model-allergyintolerance.patient",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.patient"
      },
      "path": "be-model-allergyintolerance.patient",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "The person that has the allergy",
      "definition": "The person that has the allergy"
    }, {
      "path": "be-model-allergyintolerance.code",
      "min": 1,
      "definition": "The substance - from a lst of substances - that the person is allergic to. It is possible to use free text but for the products indicated, a code must be used",
      "short": "The substance that the person is allergic to",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "extensible",
        "valueSet": "https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode"
      },
      "max": "1",
      "id": "be-model-allergyintolerance.code",
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.code"
      }
    }, {
      "id": "be-model-allergyintolerance.category",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "be-model-allergyintolerance.category"
      },
      "path": "be-model-allergyintolerance.category",
      "type": [ {
        "code": "code"
      } ],
      "short": "The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent",
      "definition": "The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent"
    }, {
      "path": "be-model-allergyintolerance.type",
      "min": 0,
      "definition": "the type of risk (allergy, intolerance...). When it is not possible to distinguish between a real allergy, a non-allergic hypersensitivity or an intolerance you can use the 'Intolerance' type, but code the VerificationStatus as 'Unconfirmed'",
      "short": "The Type - whether it is an allergy or intolerance",
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type"
      },
      "max": "1",
      "id": "be-model-allergyintolerance.type",
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.type"
      }
    }, {
      "id": "be-model-allergyintolerance.status",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.status"
      },
      "path": "be-model-allergyintolerance.status",
      "type": [ {
        "code": "BackboneElement"
      } ],
      "short": "The status of the allergy",
      "definition": "The status of the allergy"
    }, {
      "path": "be-model-allergyintolerance.status.clinicalStatus",
      "min": 1,
      "definition": "The status of the allergy - if it is active or resolved",
      "short": "The status of the allergy - if it is active or resolved",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical"
      },
      "max": "1",
      "id": "be-model-allergyintolerance.status.clinicalStatus",
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.status.clinicalStatus"
      }
    }, {
      "path": "be-model-allergyintolerance.status.verificationStatus",
      "min": 1,
      "definition": "The verification status of the allergy - if it is confirmed or suspected or refuted",
      "short": "The verification status of the allergy - if it is confirmed or suspected or refuted",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification"
      },
      "max": "1",
      "id": "be-model-allergyintolerance.status.verificationStatus",
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.status.verificationStatus"
      }
    }, {
      "id": "be-model-allergyintolerance.recordedDate",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.recordedDate"
      },
      "path": "be-model-allergyintolerance.recordedDate",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "when the allergy/intolerance was recorded",
      "definition": "when the allergy/intolerance was recorded"
    }, {
      "id": "be-model-allergyintolerance.recorder",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.recorder"
      },
      "path": "be-model-allergyintolerance.recorder",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "Who recorded the allergy",
      "definition": "Who recorded the allergy"
    }, {
      "id": "be-model-allergyintolerance.asserter",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.asserter"
      },
      "path": "be-model-allergyintolerance.asserter",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "Who asserted the allergy",
      "definition": "Is the person at the source of the information (eg the patient, the general practitioner, a family member, the healthcare professional who registers the information himself, ...). He is represented as much as possible by a unique identification number, namely the national register number (INSZ) or the BIS number. However, when it comes to a parent or family member, only the role (e.g. father, mother, neighbor, caregiver, friend, etc.) is coded to meet the requirements of the GDPR."
    }, {
      "id": "be-model-allergyintolerance.note",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.note"
      },
      "path": "be-model-allergyintolerance.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Additional text note about the allergy or intolerance",
      "definition": "Additional text note about the allergy or intolerance"
    }, {
      "id": "be-model-allergyintolerance.reactions",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "be-model-allergyintolerance.reactions"
      },
      "path": "be-model-allergyintolerance.reactions",
      "type": [ {
        "code": "BackboneElement"
      } ],
      "short": "known past reactions to the allergen",
      "definition": "known past reactions to the allergen"
    }, {
      "id": "be-model-allergyintolerance.reactions.manifestation",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "be-model-allergyintolerance.reactions.manifestation"
      },
      "path": "be-model-allergyintolerance.reactions.manifestation",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "How the reaction manifested itself",
      "definition": "How the reaction manifested itself, e.g. rash, breathing difficulty..."
    }, {
      "id": "be-model-allergyintolerance.reactions.onset",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.reactions.onset"
      },
      "path": "be-model-allergyintolerance.reactions.onset",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Manifestation date",
      "definition": "For each manifestation it is possible to specify an actual date or approximate date (age, period, interval, ...) of each suspected manifestation of the risk"
    }, {
      "id": "be-model-allergyintolerance.reactions.note",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "be-model-allergyintolerance.reactions.note"
      },
      "path": "be-model-allergyintolerance.reactions.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Additional text note about the allergic reaction",
      "definition": "Additional text note about the allergic reaction"
    } ]
  },
  "status": "active",
  "id": "9d484500-1150-410c-bd5d-8c348ed1481e",
  "kind": "logical",
  "url": "https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-model-allergyintolerance",
  "version": "1.0.1",
  "differential": {
    "element": [ {
      "id": "be-model-allergyintolerance",
      "path": "be-model-allergyintolerance",
      "short": "Allergy Intolerance Logical Model",
      "definition": "Allergy / Intolerance information model"
    }, {
      "id": "be-model-allergyintolerance.patient",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.patient",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "The person that has the allergy",
      "definition": "The person that has the allergy"
    }, {
      "id": "be-model-allergyintolerance.code",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.code",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "The substance that the person is allergic to",
      "binding": {
        "strength": "extensible",
        "valueSet": "https://www.ehealth.fgov.be/standards/fhir/allergy/ValueSet/be-allergyintolerancecode"
      },
      "definition": "The substance - from a lst of substances - that the person is allergic to. It is possible to use free text but for the products indicated, a code must be used"
    }, {
      "id": "be-model-allergyintolerance.category",
      "max": "*",
      "min": 0,
      "path": "be-model-allergyintolerance.category",
      "type": [ {
        "code": "code"
      } ],
      "short": "The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent",
      "definition": "The category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent"
    }, {
      "id": "be-model-allergyintolerance.type",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.type",
      "type": [ {
        "code": "code"
      } ],
      "short": "The Type - whether it is an allergy or intolerance",
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type"
      },
      "definition": "the type of risk (allergy, intolerance...). When it is not possible to distinguish between a real allergy, a non-allergic hypersensitivity or an intolerance you can use the 'Intolerance' type, but code the VerificationStatus as 'Unconfirmed'"
    }, {
      "id": "be-model-allergyintolerance.status",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.status",
      "type": [ {
        "code": "BackboneElement"
      } ],
      "short": "The status of the allergy",
      "definition": "The status of the allergy"
    }, {
      "id": "be-model-allergyintolerance.status.clinicalStatus",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.status.clinicalStatus",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "The status of the allergy - if it is active or resolved",
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical"
      },
      "definition": "The status of the allergy - if it is active or resolved"
    }, {
      "id": "be-model-allergyintolerance.status.verificationStatus",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.status.verificationStatus",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "The verification status of the allergy - if it is confirmed or suspected or refuted",
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification"
      },
      "definition": "The verification status of the allergy - if it is confirmed or suspected or refuted"
    }, {
      "id": "be-model-allergyintolerance.recordedDate",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.recordedDate",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "when the allergy/intolerance was recorded",
      "definition": "when the allergy/intolerance was recorded"
    }, {
      "id": "be-model-allergyintolerance.recorder",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.recorder",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "Who recorded the allergy",
      "definition": "Who recorded the allergy"
    }, {
      "id": "be-model-allergyintolerance.asserter",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.asserter",
      "type": [ {
        "code": "Reference"
      } ],
      "short": "Who asserted the allergy",
      "definition": "Is the person at the source of the information (eg the patient, the general practitioner, a family member, the healthcare professional who registers the information himself, ...). He is represented as much as possible by a unique identification number, namely the national register number (INSZ) or the BIS number. However, when it comes to a parent or family member, only the role (e.g. father, mother, neighbor, caregiver, friend, etc.) is coded to meet the requirements of the GDPR."
    }, {
      "id": "be-model-allergyintolerance.note",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Additional text note about the allergy or intolerance",
      "definition": "Additional text note about the allergy or intolerance"
    }, {
      "id": "be-model-allergyintolerance.reactions",
      "max": "*",
      "min": 0,
      "path": "be-model-allergyintolerance.reactions",
      "type": [ {
        "code": "BackboneElement"
      } ],
      "short": "known past reactions to the allergen",
      "definition": "known past reactions to the allergen"
    }, {
      "id": "be-model-allergyintolerance.reactions.manifestation",
      "max": "1",
      "min": 1,
      "path": "be-model-allergyintolerance.reactions.manifestation",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "How the reaction manifested itself",
      "definition": "How the reaction manifested itself, e.g. rash, breathing difficulty..."
    }, {
      "id": "be-model-allergyintolerance.reactions.onset",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.reactions.onset",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Manifestation date",
      "definition": "For each manifestation it is possible to specify an actual date or approximate date (age, period, interval, ...) of each suspected manifestation of the risk"
    }, {
      "id": "be-model-allergyintolerance.reactions.note",
      "max": "1",
      "min": 0,
      "path": "be-model-allergyintolerance.reactions.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Additional text note about the allergic reaction",
      "definition": "Additional text note about the allergic reaction"
    } ]
  },
  "contact": [ {
    "name": "eHealth Platform",
    "telecom": [ {
      "value": "https://www.ehealth.fgov.be/standards/fhir",
      "system": "url"
    }, {
      "value": "message-structure@ehealth.fgov.be",
      "system": "email"
    } ]
  }, {
    "name": "Message Structure eHealth",
    "telecom": [ {
      "use": "work",
      "value": "message-structure@ehealth.fgov.be",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element"
}