HL7.FHIR.BE.ALLERGY\Allergy Intolerance Logical Model

Allergy (Patient Dossier)
1.0.1 - STU1

This page is part of the HL7 Belgium FHIR Implementation Guide - Allergy profiles (v1.0.1: Trial Use) based on FHIR R4. The current version which supercedes this version is 1.1.0. 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.0.1
Active as of 2022-09-13		Responsible: eHealth Platform	Realm: BE	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

Summary

Mandatory: 0 element (7 nested mandatory elements)

This structure is derived from Element

Name	Card.	Type	Description & Constraints
be-model-allergyintolerance	0..*	Element	Allergy Intolerance Logical Model
patient	1..1	Reference()	The person that has the allergy
code	1..1	CodeableConcept	The substance that the person is allergic to Binding: BeAllergyIntoleranceCode (extensible)
category	0..*	code	The 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
type	0..1	code	The Type - whether it is an allergy or intolerance Binding: AllergyIntoleranceType (required)
status	0..1	BackboneElement	The status of the allergy
clinicalStatus	1..1	CodeableConcept	The status of the allergy - if it is active or resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	1..1	CodeableConcept	The verification status of the allergy - if it is confirmed or suspected or refuted Binding: AllergyIntoleranceVerificationStatusCodes (required)
recordedDate	1..1	dateTime	when the allergy/intolerance was recorded
recorder	1..1	Reference()	Who recorded the allergy
asserter	0..1	Reference()	Who asserted the allergy
note	0..1	string	Additional text note about the allergy or intolerance
reactions	0..*	BackboneElement	known past reactions to the allergen
manifestation	1..1	CodeableConcept	How the reaction manifested itself
onset	0..1	dateTime	Manifestation date
note	0..1	string	Additional text note about the allergic reaction
Documentation for this format

Name	Card.	Type	Description & Constraints
be-model-allergyintolerance	0..*	Element	Allergy Intolerance Logical Model
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
patient	1..1	Reference()	The person that has the allergy
code	1..1	CodeableConcept	The substance that the person is allergic to Binding: BeAllergyIntoleranceCode (extensible)
category	0..*	code	The 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
type	0..1	code	The Type - whether it is an allergy or intolerance Binding: AllergyIntoleranceType (required)
status	0..1	BackboneElement	The status of the allergy
clinicalStatus	1..1	CodeableConcept	The status of the allergy - if it is active or resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	1..1	CodeableConcept	The verification status of the allergy - if it is confirmed or suspected or refuted Binding: AllergyIntoleranceVerificationStatusCodes (required)
recordedDate	1..1	dateTime	when the allergy/intolerance was recorded
recorder	1..1	Reference()	Who recorded the allergy
asserter	0..1	Reference()	Who asserted the allergy
note	0..1	string	Additional text note about the allergy or intolerance
reactions	0..*	BackboneElement	known past reactions to the allergen
manifestation	1..1	CodeableConcept	How the reaction manifested itself
onset	0..1	dateTime	Manifestation date
note	0..1	string	Additional text note about the allergic reaction
Documentation for this format

This structure is derived from Element

Summary

Mandatory: 0 element (7 nested mandatory elements)

Differential View

This structure is derived from Element

Name	Card.	Type	Description & Constraints
be-model-allergyintolerance	0..*	Element	Allergy Intolerance Logical Model
patient	1..1	Reference()	The person that has the allergy
code	1..1	CodeableConcept	The substance that the person is allergic to Binding: BeAllergyIntoleranceCode (extensible)
category	0..*	code	The 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
type	0..1	code	The Type - whether it is an allergy or intolerance Binding: AllergyIntoleranceType (required)
status	0..1	BackboneElement	The status of the allergy
clinicalStatus	1..1	CodeableConcept	The status of the allergy - if it is active or resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	1..1	CodeableConcept	The verification status of the allergy - if it is confirmed or suspected or refuted Binding: AllergyIntoleranceVerificationStatusCodes (required)
recordedDate	1..1	dateTime	when the allergy/intolerance was recorded
recorder	1..1	Reference()	Who recorded the allergy
asserter	0..1	Reference()	Who asserted the allergy
note	0..1	string	Additional text note about the allergy or intolerance
reactions	0..*	BackboneElement	known past reactions to the allergen
manifestation	1..1	CodeableConcept	How the reaction manifested itself
onset	0..1	dateTime	Manifestation date
note	0..1	string	Additional text note about the allergic reaction
Documentation for this format

Snapshot View

Name	Card.	Type	Description & Constraints
be-model-allergyintolerance	0..*	Element	Allergy Intolerance Logical Model
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
patient	1..1	Reference()	The person that has the allergy
code	1..1	CodeableConcept	The substance that the person is allergic to Binding: BeAllergyIntoleranceCode (extensible)
category	0..*	code	The 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
type	0..1	code	The Type - whether it is an allergy or intolerance Binding: AllergyIntoleranceType (required)
status	0..1	BackboneElement	The status of the allergy
clinicalStatus	1..1	CodeableConcept	The status of the allergy - if it is active or resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	1..1	CodeableConcept	The verification status of the allergy - if it is confirmed or suspected or refuted Binding: AllergyIntoleranceVerificationStatusCodes (required)
recordedDate	1..1	dateTime	when the allergy/intolerance was recorded
recorder	1..1	Reference()	Who recorded the allergy
asserter	0..1	Reference()	Who asserted the allergy
note	0..1	string	Additional text note about the allergy or intolerance
reactions	0..*	BackboneElement	known past reactions to the allergen
manifestation	1..1	CodeableConcept	How the reaction manifested itself
onset	0..1	dateTime	Manifestation date
note	0..1	string	Additional text note about the allergic reaction
Documentation for this format

Other representations of profile: CSV, Excel

Terminology Bindings

Path	Conformance	ValueSet
be-model-allergyintolerance.code	extensible	BeAllergyIntoleranceCode
be-model-allergyintolerance.type	required	AllergyIntoleranceType
be-model-allergyintolerance.status.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes
be-model-allergyintolerance.status.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes

Constraints

Id	Grade	Path	Details	Requirements
ele-1	error	be-model-allergyintolerance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	be-model-allergyintolerance.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	be-model-allergyintolerance.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()

<prev

top

next>

IG © 2021+ eHealth Platform. Package hl7.fhir.be.allergy#1.0.1 based on FHIR 4.0.1. Generated 2022-09-13
Links: Table of Contents | QA Report