HdBe-AllergyIntolerance

Profile	Status	URL
HdBe-AllergyIntolerance	draft	https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-AllergyIntolerance

allergy_intolerance		allergy_intolerance	There are no (further) constraints on this element Element Id allergy_intolerance Short description AllergyIntolerance Definition Root concept of the AllergyIntolerance information model. This root concept contains all data elements of the AllergyIntolerance information model. Data Type allergy_intolerance
causative_agent	1..1	CodeableConcept	There are no (further) constraints on this element Element Id allergy_intolerance.causative_agent Short description CausativeAgent Definition Substance, group of substances or environmental factor to which the patient is allergic or hypersensitive. Data Type CodeableConcept
allergy_category	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.allergy_category Short description AllergyCategory Definition Identifies the allergy category such as medication, food or environment. Data Type CodeableConcept Binding AllergyCategory codes AllergieCategorie (required)
allergy_status	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.allergy_status Short description AllergyStatus Definition Statement on the status of the patient’s hypersensitivity. Data Type CodeableConcept Binding AllergyStatus codes AllergieStatus (required)
start_date_time	0..1	dateTime	There are no (further) constraints on this element Element Id allergy_intolerance.start_date_time Short description StartDateTime Definition The date and time at which the allergy or undesired reaction was determined. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year). Data Type dateTime
criticality	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.criticality Short description Criticality Definition Critical extent is defined as “the potential severity of future reactions.” This represents a clinical evaluation of the worst case scenario for a future reaction. It can be based on the severity of past reactions, the dose and manner of exposure which caused reactions in the past, and the life-threatening potential of the type of reaction. Critical extent is a property of the allergy, and not of the reaction itself. Data Type CodeableConcept Binding Criticality codes MateVanKritiekZijn (required)
last_reaction_date_time	0..1	dateTime	There are no (further) constraints on this element Element Id allergy_intolerance.last_reaction_date_time Short description LastReactionDateTime Definition Entry of the last time a hypersensitive reaction took place. Data Type dateTime
comment	0..1	string	There are no (further) constraints on this element Element Id allergy_intolerance.comment Short description Comment Definition Textual explanation of the hypersensitivity which cannot be entered in any of the other fields. Data Type string
reaction	0..*	BackboneElement	There are no (further) constraints on this element Element Id allergy_intolerance.reaction Short description Reaction Definition Container of the Reaction concept. This container contains all data elements of the Reaction concept. Data Type BackboneElement
symptom	1..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.symptom Short description Symptom Definition The content specifications of the reaction that takes place when the patient is exposed to the causative substance. Data Type CodeableConcept Binding Symptom codes Symptoom (extensible)
specific_substance	0..1	CodeableConcept	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.specific_substance Short description SpecificSubstance Definition More specific indication of the substance that caused the reaction. This can be a specific substance from a group of substances to which the patient is allergic or hypersensitive. Data Type CodeableConcept
reaction_description	0..1	string	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.reaction_description Short description ReactionDescription Definition Textual description of the reaction as a whole. Data Type string
severity	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.severity Short description Severity Definition The severity of the reaction as a result of exposure to the causative substance. Data Type CodeableConcept Binding Severity codes Ernst (required)
route_of_exposure	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.route_of_exposure Short description RouteOfExposure Definition Way in which the patient came into contact with the causative agent or the way in which the agent was administered. Data Type CodeableConcept Binding RouteOfExposure codes WijzeVanBlootstelling (required)
reaction_time	0..1	dateTime	There are no (further) constraints on this element Element Id allergy_intolerance.reaction.reaction_time Short description ReactionTime Definition Date and time at which the reaction took place. This may also be just the date or a partial date, in the event that the exact date is unknown. Data Type dateTime

allergy_intolerance		0..*
allergy_intolerance.causative_agent	CodeableConcept	1..1
allergy_intolerance.allergy_category	CodeableConcept	0..1
allergy_intolerance.allergy_status	CodeableConcept	0..1
allergy_intolerance.start_date_time	dateTime	0..1
allergy_intolerance.criticality	CodeableConcept	0..1
allergy_intolerance.last_reaction_date_time	dateTime	0..1
allergy_intolerance.comment	string	0..1
allergy_intolerance.reaction	BackboneElement	0..*
allergy_intolerance.reaction.symptom	CodeableConcept	1..*
allergy_intolerance.reaction.specific_substance	CodeableConcept	0..1
allergy_intolerance.reaction.reaction_description	string	0..1
allergy_intolerance.reaction.severity	CodeableConcept	0..1
allergy_intolerance.reaction.route_of_exposure	CodeableConcept	0..1
allergy_intolerance.reaction.reaction_time	dateTime	0..1

allergy_intolerance
Definition	Root concept of the AllergyIntolerance information model. This root concept contains all data elements of the AllergyIntolerance information model.
Cardinality	0...*
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
allergy_intolerance.extension
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
allergy_intolerance.causative_agent
Definition	Substance, group of substances or environmental factor to which the patient is allergic or hypersensitive.
Cardinality	1...1
Type	CodeableConcept
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.allergy_category
Definition	Identifies the allergy category such as medication, food or environment.
Cardinality	0...1
Type	CodeableConcept
Binding	AllergyCategory codes AllergieCategorie (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.allergy_status
Definition	Statement on the status of the patient’s hypersensitivity.
Cardinality	0...1
Type	CodeableConcept
Binding	AllergyStatus codes AllergieStatus (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.start_date_time
Definition	The date and time at which the allergy or undesired reaction was determined. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year).
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.criticality
Definition	Critical extent is defined as “the potential severity of future reactions.” This represents a clinical evaluation of the worst case scenario for a future reaction. It can be based on the severity of past reactions, the dose and manner of exposure which caused reactions in the past, and the life-threatening potential of the type of reaction. Critical extent is a property of the allergy, and not of the reaction itself.
Cardinality	0...1
Type	CodeableConcept
Binding	Criticality codes MateVanKritiekZijn (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.last_reaction_date_time
Definition	Entry of the last time a hypersensitive reaction took place.
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.comment
Definition	Textual explanation of the hypersensitivity which cannot be entered in any of the other fields.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.reaction
Definition	Container of the Reaction concept. This container contains all data elements of the Reaction concept.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.reaction.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
allergy_intolerance.reaction.extension
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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
allergy_intolerance.reaction.modifierExtension
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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
Comments	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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
allergy_intolerance.reaction.symptom
Definition	The content specifications of the reaction that takes place when the patient is exposed to the causative substance.
Cardinality	1...*
Type	CodeableConcept
Binding	Symptom codes Symptoom (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.reaction.specific_substance
Definition	More specific indication of the substance that caused the reaction. This can be a specific substance from a group of substances to which the patient is allergic or hypersensitive.
Cardinality	0...1
Type	CodeableConcept
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.reaction.reaction_description
Definition	Textual description of the reaction as a whole.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a
allergy_intolerance.reaction.severity
Definition	The severity of the reaction as a result of exposure to the causative substance.
Cardinality	0...1
Type	CodeableConcept
Binding	Severity codes Ernst (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.reaction.route_of_exposure
Definition	Way in which the patient came into contact with the causative agent or the way in which the agent was administered.
Cardinality	0...1
Type	CodeableConcept
Binding	RouteOfExposure codes WijzeVanBlootstelling (required)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
allergy_intolerance.reaction.reaction_time
Definition	Date and time at which the reaction took place. This may also be just the date or a partial date, in the event that the exact date is unknown.
Cardinality	0...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a

Example instances

[CBB name]
[Concept name ]	[example value]

// example of NameInformation

## Example instances

| name_information      |                   |
|----------------------|-------------------|
| first_names | Johanna Petronella Maria   
| initials | J.P.M. 
| given_name | Jo 
| name_usage | Geslachtsnaam partner gevolgd door eigen geslachtsnaam
| last_name.prefix | van
| last_name.last_name | Putten
| last_name_partner.partner_prefix | van der
| last_name_partner.partner_last_name | Giessen
| titles |

zib [zib name + version](https://zibs.nl/wiki/[zib name + version(release)]) difference

Concept	Category	Description
`[element.path]`	[category of change]	[Description of change]([Reference to ticket/issue/zulip chat using MarkDown link])

Terminology Bindings

Path	Name	Strength	URL
allergy_category	AllergieCategorie	required	https://fhir.healthdata.be/ValueSet/AllergieCategorie
allergy_status	AllergieStatus	required	https://fhir.healthdata.be/ValueSet/AllergieStatus
criticality	MateVanKritiekZijn	required	https://fhir.healthdata.be/ValueSet/MateVanKritiekZijn
reaction.symptom	Symptoom	extensible	https://fhir.healthdata.be/ValueSet/Symptoom
reaction.severity	Ernst	required	https://fhir.healthdata.be/ValueSet/Ernst
reaction.route_of_exposure	WijzeVanBlootstelling	required	https://fhir.healthdata.be/ValueSet/WijzeVanBlootstelling