| Package | xxexample.fhir.food-Allergy |
| Resource Type | StructureDefinition |
| Id | FoodAllergyModel |
| FHIR Version | R4 |
| Source | http://xxsomewhere.org/fhir/food-Allergy/https://build.fhir.org/ig/novillof/foodAllergy/StructureDefinition-FoodAllergyModel.html |
| URL | http://example.com/fhir/example/StructureDefinition/FoodAllergyModel |
| Version | 0.1.0-test |
| Status | active |
| Date | 2025-07-08T08:56:08+00:00 |
| Name | FoodAllergyModel |
| Title | Food Allergy Logical Model |
| Realm | uv |
| Description | Food Allergy information model |
| Type | http://example.com/fhir/example/StructureDefinition/FoodAllergyModel |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition FoodAllergyModel
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  FoodAllergyModel | 0..* | Base | Food Allergy Logical Model | |
  patient | 1..1 | Reference() | The person that has the allergy | |
 allergen | 1..1 | CodeableConcept | The substance that the person is allergic to | |
| clinicalStatus | 1..1 | CodeableConcept | The status of the allergy - if it is active or resolved | |
| verificationStatus | 1..1 | CodeableConcept | The verification status of the allergy - if it is confirmed or suspected or refuted | |
 recordedDate | 0..1 | dateTime | When the allergy was reported | |
| recorder | 0..1 | Reference() | Who recorded the allergy | |
| asserter | 0..1 | Reference() | Who asserted the allergy | |
 reactions | 0..1 | BackboneElement | known past reactions to the allergen | |
 manifestation | 0..1 | CodeableConcept | How the reaction manifested itself | |
| certitude | 0..1 | CodeableConcept | How certain we are that the cause of the reaction was the allergen indicated | |
| exposure | 0..1 | CodeableConcept | The exposure route to the substance | |
| note | 0..1 | string | Additional text note about the allergic reaction | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "FoodAllergyModel",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://example.com/fhir/example/StructureDefinition/FoodAllergyModel",
"version": "0.1.0-test",
"name": "FoodAllergyModel",
"title": "Food Allergy Logical Model",
"status": "active",
"date": "2025-07-08T08:56:08+00:00",
"publisher": "fnovillo",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "mailto:fnovper@gmail.com"
}
]
}
],
"description": "Food Allergy information model",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://example.com/fhir/example/StructureDefinition/FoodAllergyModel",
"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": "FoodAllergyModel",
"path": "FoodAllergyModel",
"short": "Food Allergy Logical Model",
"definition": "Food Allergy information model",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "FoodAllergyModel.patient",
"path": "FoodAllergyModel.patient",
"short": "The person that has the allergy",
"definition": "The person that has the allergy",
"min": 1,
"max": "1",
"base": {
"path": "FoodAllergyModel.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.allergen",
"path": "FoodAllergyModel.allergen",
"short": "The substance that the person is allergic to",
"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",
"min": 1,
"max": "1",
"base": {
"path": "FoodAllergyModel.allergen",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.clinicalStatus",
"path": "FoodAllergyModel.clinicalStatus",
"short": "The status of the allergy - if it is active or resolved",
"definition": "The status of the allergy - if it is active or resolved",
"min": 1,
"max": "1",
"base": {
"path": "FoodAllergyModel.clinicalStatus",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.verificationStatus",
"path": "FoodAllergyModel.verificationStatus",
"short": "The verification status of the allergy - if it is confirmed or suspected or refuted",
"definition": "The verification status of the allergy - if it is confirmed or suspected or refuted",
"min": 1,
"max": "1",
"base": {
"path": "FoodAllergyModel.verificationStatus",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.recordedDate",
"path": "FoodAllergyModel.recordedDate",
"short": "When the allergy was reported",
"definition": "When the allergy was reported",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.recordedDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "FoodAllergyModel.recorder",
"path": "FoodAllergyModel.recorder",
"short": "Who recorded the allergy",
"definition": "Who recorded the allergy",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.recorder",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.asserter",
"path": "FoodAllergyModel.asserter",
"short": "Who asserted the allergy",
"definition": " who asserted or provided the allergy information e.g. the patient, a relative, a care giver...",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.asserter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.reactions",
"path": "FoodAllergyModel.reactions",
"short": "known past reactions to the allergen",
"definition": "known past reactions to the allergen",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.reactions",
"min": 0,
"max": "1"
},
"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": "FoodAllergyModel.reactions.id",
"path": "FoodAllergyModel.reactions.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": "FoodAllergyModel.reactions.extension",
"path": "FoodAllergyModel.reactions.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": "FoodAllergyModel.reactions.modifierExtension",
"path": "FoodAllergyModel.reactions.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": "FoodAllergyModel.reactions.manifestation",
"path": "FoodAllergyModel.reactions.manifestation",
"short": "How the reaction manifested itself",
"definition": "How the reaction manifested itself, e.g. rash, breathing difficulty...",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.reactions.manifestation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.certitude",
"path": "FoodAllergyModel.reactions.certitude",
"short": "How certain we are that the cause of the reaction was the allergen indicated",
"definition": "How certain we are that the cause of the reaction was the allergen indicated",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.reactions.certitude",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.exposure",
"path": "FoodAllergyModel.reactions.exposure",
"short": "The exposure route to the substance",
"definition": "The exposure route to the substance",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.reactions.exposure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.note",
"path": "FoodAllergyModel.reactions.note",
"short": "Additional text note about the allergic reaction",
"definition": "Additional text note about the allergic reaction",
"min": 0,
"max": "1",
"base": {
"path": "FoodAllergyModel.reactions.note",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "FoodAllergyModel",
"path": "FoodAllergyModel",
"short": "Food Allergy Logical Model",
"definition": "Food Allergy information model"
},
{
"id": "FoodAllergyModel.patient",
"path": "FoodAllergyModel.patient",
"short": "The person that has the allergy",
"definition": "The person that has the allergy",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.allergen",
"path": "FoodAllergyModel.allergen",
"short": "The substance that the person is allergic to",
"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",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.clinicalStatus",
"path": "FoodAllergyModel.clinicalStatus",
"short": "The status of the allergy - if it is active or resolved",
"definition": "The status of the allergy - if it is active or resolved",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.verificationStatus",
"path": "FoodAllergyModel.verificationStatus",
"short": "The verification status of the allergy - if it is confirmed or suspected or refuted",
"definition": "The verification status of the allergy - if it is confirmed or suspected or refuted",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.recordedDate",
"path": "FoodAllergyModel.recordedDate",
"short": "When the allergy was reported",
"definition": "When the allergy was reported",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "FoodAllergyModel.recorder",
"path": "FoodAllergyModel.recorder",
"short": "Who recorded the allergy",
"definition": "Who recorded the allergy",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.asserter",
"path": "FoodAllergyModel.asserter",
"short": "Who asserted the allergy",
"definition": " who asserted or provided the allergy information e.g. the patient, a relative, a care giver...",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "FoodAllergyModel.reactions",
"path": "FoodAllergyModel.reactions",
"short": "known past reactions to the allergen",
"definition": "known past reactions to the allergen",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FoodAllergyModel.reactions.manifestation",
"path": "FoodAllergyModel.reactions.manifestation",
"short": "How the reaction manifested itself",
"definition": "How the reaction manifested itself, e.g. rash, breathing difficulty...",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.certitude",
"path": "FoodAllergyModel.reactions.certitude",
"short": "How certain we are that the cause of the reaction was the allergen indicated",
"definition": "How certain we are that the cause of the reaction was the allergen indicated",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.exposure",
"path": "FoodAllergyModel.reactions.exposure",
"short": "The exposure route to the substance",
"definition": "The exposure route to the substance",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FoodAllergyModel.reactions.note",
"path": "FoodAllergyModel.reactions.note",
"short": "Additional text note about the allergic reaction",
"definition": "Additional text note about the allergic reaction",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}