Allergy (Patient Dossier)
1.1.0 - STU1

This page is part of the HL7 Belgium FHIR Implementation Guide - Allergy profiles (v1.1.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeAllergyIntolerance

Official URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-allergyintolerance Version: 1.1.0
Active as of 2023-02-06 Maturity Level: 1 Responsible: eHealth Platform Realm: Belgium flag Computable Name: BeAllergyIntolerance

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

Usage:

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 C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... Slices for identifier S0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy 0..1IdentifierReference ID of the allergy
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value 1..1stringThe value that is unique
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type 0..0
... category S0..*codefood | medication | environment | biologic
... code S1..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
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(BePractitioner | BePractitionerRole | BePatient)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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset S0..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

Terminology Bindings (Differential)

PathConformanceValueSet
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
be-inv-asserter-person-rel-typeerrorAllergyIntoleranceChecks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
: asserter.empty() or (asserter.resolve() is RelatedPerson implies asserter.resolve().relationship.memberOf('https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-patient-relationship-type'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... Slices for identifier SΣ0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy Σ0..1IdentifierReference ID of the allergy
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value Σ1..1stringThe value that is unique
Example General: 123456
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..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.

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


... code SΣ1..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI

... patient SΣ1..1Reference(BePatient)Who the sensitivity is for
... recordedDate S1..1dateTimeDate first version of the resource instance was recorded
... recorder S1..1Reference(BePractitioner | BePractitionerRole | BePatient)Who recorded the sensitivity
... asserter SΣ0..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
.... 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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset S0..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

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.identifier:allergy.userequiredIdentifierUse
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.substanceexampleSubstanceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
be-inv-asserter-person-rel-typeerrorAllergyIntoleranceChecks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
: asserter.empty() or (asserter.resolve() is RelatedPerson implies asserter.resolve().relationship.memberOf('https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-patient-relationship-type'))
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy Σ0..1IdentifierReference ID of the allergy
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..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.

... 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..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
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(BePractitioner | BePractitionerRole | BePatient)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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S0..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

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:allergy.userequiredIdentifierUse
AllergyIntolerance.identifier:allergy.typeextensibleIdentifier Type Codes
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.substanceexampleSubstanceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element AllergyIntolerance.identifier is sliced based on the value of value:system

Maturity: 1

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... Slices for identifier S0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy 0..1IdentifierReference ID of the allergy
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value 1..1stringThe value that is unique
... verificationStatus S0..1CodeableConceptunconfirmed | confirmed | refuted | entered-in-error
... type 0..0
... category S0..*codefood | medication | environment | biologic
... code S1..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
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(BePractitioner | BePractitionerRole | BePatient)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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset S0..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

Terminology Bindings (Differential)

PathConformanceValueSet
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
be-inv-asserter-person-rel-typeerrorAllergyIntoleranceChecks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
: asserter.empty() or (asserter.resolve() is RelatedPerson implies asserter.resolve().relationship.memberOf('https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-patient-relationship-type'))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... Slices for identifier SΣ0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy Σ0..1IdentifierReference ID of the allergy
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value Σ1..1stringThe value that is unique
Example General: 123456
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..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.

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


... code SΣ1..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
Binding: BeAllergyIntoleranceCode (extensible): Causative agent codes as defined by NIHDI

... patient SΣ1..1Reference(BePatient)Who the sensitivity is for
... recordedDate S1..1dateTimeDate first version of the resource instance was recorded
... recorder S1..1Reference(BePractitioner | BePractitionerRole | BePatient)Who recorded the sensitivity
... asserter SΣ0..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
.... 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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... onset S0..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

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.identifier:allergy.userequiredIdentifierUse
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.substanceexampleSubstanceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
be-inv-asserter-person-rel-typeerrorAllergyIntoleranceChecks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
: asserter.empty() or (asserter.resolve() is RelatedPerson implies asserter.resolve().relationship.memberOf('https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-patient-relationship-type'))
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C0..*AllergyIntoleranceAllergy or Intolerance (generally: Risk of adverse reaction to a substance)
be-inv-asserter-person-rel-type: Checks that the person relationship type of the RelatedPerson in asserter is from BeVSPatientRelationshipType
... id Σ0..1idLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... type S0..1CodeableConceptBeExtAllergyType
URL: https://www.ehealth.fgov.be/standards/fhir/allergy/StructureDefinition/be-ext-allergy-type
Binding: BeVSAllergyIntoleranceType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierExternal ids for this item
Slice: Unordered, Open by value:system
.... identifier:allergy Σ0..1IdentifierReference ID of the allergy
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..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.

... 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..1CodeableConceptUse ATC, CNK or CTI-extended in case of medication allergy
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(BePractitioner | BePractitionerRole | BePatient)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..1CodeableConceptClinical symptoms/signs associated with the Event
Binding: BeRiskManifestation (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S0..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

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:allergy.userequiredIdentifierUse
AllergyIntolerance.identifier:allergy.typeextensibleIdentifier Type Codes
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleBeAllergyIntoleranceCode
AllergyIntolerance.reaction.substanceexampleSubstanceCode
AllergyIntolerance.reaction.manifestationextensibleBeRiskManifestation
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteextensibleBeExposureRoute

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element AllergyIntolerance.identifier is sliced based on the value of value:system

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron