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 - Detailed Descriptions

Active as of 2023-02-06 Maturity Level: 1

Definitions for the be-allergyintolerance resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. AllergyIntolerance
InvariantsDefined on this element
be-inv-asserter-person-rel-type: Checks 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')))
2. AllergyIntolerance.extension
SlicingThis element introduces a set of slices on AllergyIntolerance.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. AllergyIntolerance.extension:type
SliceNametype
Control0..1
TypeExtension(BeExtAllergyType) (Extension Type: CodeableConcept)
Must Supporttrue
4. AllergyIntolerance.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
SlicingThis element introduces a set of slices on AllergyIntolerance.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
5. AllergyIntolerance.identifier:allergy
SliceNameallergy
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
6. AllergyIntolerance.identifier:allergy.system
Control1..?
Fixed Valuehttps://www.ehealth.fgov.be/standards/fhir/allergy/NamingSystem/be-ns-allergy
7. AllergyIntolerance.identifier:allergy.value
Control1..?
8. AllergyIntolerance.clinicalStatus
Definition

The clinical status of the allergy or intolerance.

When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.

Use 'resolved' only in case of pediatric allergies, in case of complete recovery, use 'inactive' in case of longlasting tolerance after a desensitisation treatment

Must Supporttrue
9. AllergyIntolerance.verificationStatus
Definition

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.

Must Supporttrue
10. AllergyIntolerance.type
Control0..01
11. AllergyIntolerance.category
Definition

Category of the identified substance.

When available, a provider SHOULD include it in the istance. When given, a consumer SHALL record this in its consuming system.

Must Supporttrue
12. AllergyIntolerance.code
Definition

Code for an allergy or intolerance statement. This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a general or categorical negated statement (e.g., "No known allergy"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

A provider SHALL include it in the instance and a consumer SHALL record this in its consuming system. Medication related allergies or intolerances will be registered using the CNK, ATC or CTI-extended namingsystem.

Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

Control10..1
BindingThe codes SHALL be taken from BeAllergyIntoleranceCode; other codes may be used where these codes are not suitableFor example codes, see AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes

Causative agent codes as defined by NIHDI

Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

Must Supporttrue
Comments

Code for an allergy or intolerance statement. This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a general or categorical negated statement (e.g., "No known allergy"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

A provider SHALL include it in the instance and a consumer SHALL record this in its consuming system. Medication related allergies or intolerances will be registered using the CNK, ATC or CTI-extended namingsystem.

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

13. AllergyIntolerance.patient
Definition

The patient who has the allergy or intolerance.

A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system.

TypeReference(BePatient|Patient)
Must Supporttrue
14. AllergyIntolerance.recordedDate
Definition

The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

A provider SHALL include it in the istance and a consumer SHALL record this in its consuming system.

Control10..1
Must Supporttrue
15. AllergyIntolerance.recorder
Definition

Individual who takes responsibility for the content of the record. BePatient is added to allow a patient to record his/her own allergies. Organisations can be a recorder, using a PractitionerRole, but the you SHALL add a BePractioner who is responsable for the organisation.

A provider SHALL include it in the instance and a consumer SHALL record this in its consuming system.

Individual who recorded the record and takes responsibility for its content.

Control10..1
TypeReference(BePractitioner|BePractitionerRole|BePatient|Practitioner|PractitionerRole|Patient|RelatedPerson)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Special remarks for KMEHR users: This is the 'author' concept in a KMEHR message as the FHIR recorder is the party taking responsibility.

16. AllergyIntolerance.asserter
Definition

The source of the information about the allergy that is recorded.

When available, a provider SHOULD include it in the instance. When given, a consumer SHALL record this in its consuming system.

Must Supporttrue
Comments

The recorder takes responsibility for the content, but can reference the source from where they got it.

Special remarks for KMEHR users: As the FHIR asserter is not the party taking responsibility, this is not equal to the 'author' concept in KMEHR.

17. AllergyIntolerance.note
Must Supporttrue
Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.

18. AllergyIntolerance.reaction
Definition

Details about each adverse reaction event linked to exposure to the identified substance.

When available, a provider SHOULD include it in the istance. When given, a consumer SHALL record this in its consuming system.

Must Supporttrue
19. AllergyIntolerance.reaction.substance
20. AllergyIntolerance.reaction.manifestation
Definition

Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system. If needed codes can be used outside the given valueset, SNOMED-CT is preferred.

Control1..1*
BindingThe codes SHALL be taken from BeRiskManifestation; other codes may be used where these codes are not suitableFor example codes, see SNOMEDCTClinicalFindings
Must Supporttrue
21. AllergyIntolerance.reaction.onset
Must Supporttrue
22. AllergyIntolerance.reaction.exposureRoute
Definition

Identification of the route by which the subject was exposed to the substance. If needed codes can be used outside the given valueset, SNOMED-CT is preferred.

Identification of the route by which the subject was exposed to the substance.

BindingThe codes SHALL be taken from BeExposureRoute; other codes may be used where these codes are not suitableFor example codes, see SNOMEDCTRouteCodes
23. AllergyIntolerance.reaction.note
Definition

Additional text about the adverse reaction event not captured in other fields.

A note on this level SHOULD be avoided when not absolutely necessary. Preferably use the .note one level higher.