HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BeAllergyIntolerance

Belgian federal profile for an allergy and/or an intolerance. Initially based on the functional description of the NIHDI.

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-allergyintolerance

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S0..1CodeableConceptactive | inactive | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type S0..1codeallergy | intolerance - Underlying mechanism (if known)
... code S1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible)
... patient S1..1Reference(BePatient)Who the sensitivity is for
... recordedDate S1..1dateTimeDate first version of the resource instance was recorded
... recorder S1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | BePatient | BePractitioner | BePractitionerRole)Who recorded the sensitivity
... asserter S0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
..... coding 0..*CodingCode defined by a terminology system
Binding: BeExposureRoute (extensible)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣI0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category SΣI0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality ΣI0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣI1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible)
... patient SΣI1..1Reference(BePatient)Who the sensitivity is for
... encounter I0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] I0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... recordedDate SI1..1dateTimeDate first version of the resource instance was recorded
... recorder SI1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | BePatient | BePractitioner | BePractitionerRole)Who recorded the sensitivity
... asserter SΣI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... lastOccurrence I0..1dateTimeDate(/time) of last known occurrence of a reaction
... note SI0..*AnnotationAdditional text not captured in other fields
... reaction SI0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance I0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example)
.... manifestation SI1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description I0..1stringDescription of the event as a whole
.... onset I0..1dateTimeDate(/time) when manifestations showed
.... severity I0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute I0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
Binding: BeExposureRoute (extensible)
..... text ΣI0..1stringPlain text representation of the concept
.... note I0..*AnnotationText about event not captured in other fields

doco Documentation for this format

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S0..1CodeableConceptactive | inactive | resolved
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type S0..1codeallergy | intolerance - Underlying mechanism (if known)
... code S1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible)
... patient S1..1Reference(BePatient)Who the sensitivity is for
... recordedDate S1..1dateTimeDate first version of the resource instance was recorded
... recorder S1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | BePatient | BePractitioner | BePractitionerRole)Who recorded the sensitivity
... asserter S0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
..... coding 0..*CodingCode defined by a terminology system
Binding: BeExposureRoute (extensible)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣI0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
... category SΣI0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality ΣI0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
... code SΣI1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible)
... patient SΣI1..1Reference(BePatient)Who the sensitivity is for
... encounter I0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] I0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... recordedDate SI1..1dateTimeDate first version of the resource instance was recorded
... recorder SI1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | BePatient | BePractitioner | BePractitionerRole)Who recorded the sensitivity
... asserter SΣI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... lastOccurrence I0..1dateTimeDate(/time) of last known occurrence of a reaction
... note SI0..*AnnotationAdditional text not captured in other fields
... reaction SI0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance I0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example)
.... manifestation SI1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description I0..1stringDescription of the event as a whole
.... onset I0..1dateTimeDate(/time) when manifestations showed
.... severity I0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute I0..1CodeableConceptHow the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
Binding: BeExposureRoute (extensible)
..... text ΣI0..1stringPlain text representation of the concept
.... note I0..*AnnotationText about event not captured in other fields

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Max Binding: AllLanguages
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.substanceexampleSubstanceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
AllergyIntolerance.reaction.exposureRoute.codingextensibleBeExposureRoute

Constraints

Constraints

IdPathDetailsRequirements