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

Logical Model: Allergy Intolerance Logical Model

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

Allergy / Intolerance information model

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..*codeThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
... status 0..1BackboneElementThe status of the allergy
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..*codeThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
... status 0..1BackboneElementThe status of the allergy
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes

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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... type 0..1codeThe Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1BackboneElementThe status of the allergy
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes

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 Element

Summary

Mandatory: 0 element (7 nested mandatory elements)

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..*codeThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
... status 0..1BackboneElementThe status of the allergy
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... category 0..*codeThe category of the risk (food, medication, environment, biological,...). This information will not be encoded by the Recorder but can automatically be added using the SNOMED-CT code from causative agent
... status 0..1BackboneElementThe status of the allergy
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes

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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-allergyintolerance 0..*ElementAllergy Intolerance Logical Model
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... patient 1..1Reference()The person that has the allergy
... code 1..1CodeableConceptThe substance that the person is allergic to
Binding: BeAllergyIntoleranceCode (extensible)
... type 0..1codeThe Type - whether it is an allergy or intolerance
Binding: BeVSAllergyIntoleranceType (required)
... status 0..1BackboneElementThe status of the allergy
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... clinicalStatus 1..1CodeableConceptThe status of the allergy - if it is active or resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
.... verificationStatus 1..1CodeableConceptThe verification status of the allergy - if it is confirmed or suspected or refuted
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... recordedDate 1..1dateTimewhen the allergy/intolerance was recorded
... recorder 1..1Reference()Who recorded the allergy
... asserter 0..1Reference()Who asserted the allergy
... note 0..1stringAdditional text note about the allergy or intolerance
... reactions 0..*BackboneElementknown past reactions to the allergen
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... manifestation 1..1CodeableConceptHow the reaction manifested itself
.... onset 0..1dateTimeManifestation date
.... note 0..1stringAdditional text note about the allergic reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
be-model-allergyintolerance.codeextensibleBeAllergyIntoleranceCode
be-model-allergyintolerance.typerequiredBeVSAllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes

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 Element

Summary

Mandatory: 0 element (7 nested mandatory elements)

 

Other representations of profile: CSV, Excel