Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile:

Defining URL:https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-allergyintolerance
Version:1.2.2
Name:BeAllergyIntolerance
Status:Active as of 2021-07-10T14:45:27+02:00
Definition:

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

Publisher:eHealth
Source Resource:XML / JSON / Turtle

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

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): Causative agent codes as defined by NIHDI

... 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
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 Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI

... patient SΣ1..1Reference(BePatient)Who the sensitivity is for
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] 0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... 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 SΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
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)
... clinicalStatus ?!ΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type Σ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... code Σ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI

... patient Σ1..1Reference(BePatient)Who the sensitivity is for
... recordedDate 1..1dateTimeDate first version of the resource instance was recorded
... recorder 1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | BePatient | BePractitioner | BePractitionerRole)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... note 0..*AnnotationAdditional text not captured in other fields
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)

doco Documentation for this format

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): Causative agent codes as defined by NIHDI

... 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
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 Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣI0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ0..1codelow | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code SΣ1..1CodeableConceptCode that identifies the allergy or intolerance
Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI

... patient SΣ1..1Reference(BePatient)Who the sensitivity is for
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... onset[x] 0..1When allergy or intolerance was identified
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
... 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 SΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note S0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).

.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..1codemild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

.... exposureRoute 0..1CodeableConceptHow the subject was exposed to the substance
Binding: BeExposureRoute (extensible)
.... note 0..*AnnotationText about event not captured in other fields

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

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.exposureRouteextensibleBeExposureRoute

Constraints

IdPathDetailsRequirements
ait-1AllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2AllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2AllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3AllergyIntoleranceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4AllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5AllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6AllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1AllergyIntolerance.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.clinicalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.verificationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.criticalityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.recordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.asserterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.lastOccurrenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.substanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.manifestationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.onsetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.exposureRouteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())