CH AllergyIntolerance (R4)
3.0.1 - trial-use Switzerland flag

This page is part of the CH-AllergyIntolerance (R4) (v3.0.1: STU 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CH AllergyIntolerance

Official URL: http://fhir.ch/ig/ch-allergyintolerance/StructureDefinition/ch-allergyintolerance Version: 3.0.1
Active as of 2025-12-16 Computable Name: CHAllergyIntolerance

Copyright/Legal: CC0-1.0

This profile represents the constraints applied to the AllergyIntolerance resource in the Swiss context (based on CH IPS). A record of an allergy or intolerance is represented in the Swiss EPR, in a TransitionOfCare transaction or similar as an instance of an AllergyIntolerance resource constrained by this profile. It documents the relevant allergies or intolerances for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.

This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of a Swiss patient in adaption of the one specified by the IPS project of HL7 International.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance SC 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | 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..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | 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..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... patient Σ 1..1 Reference(CH IPS Patient) Who the sensitivity is for
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:certainty 0..1 CodeableConcept Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
..... extension:duration 0..1 Duration The amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
..... extension:location 0..1 CodeableConcept The anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
..... extension:exposureDate 0..1 dateTime Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
..... extension:exposureDuration 0..1 Duration The amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
..... extension:exposureDescription 0..1 string Text description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
..... extension:management 0..1 string Text description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If 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-4 error AllergyIntolerance If 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-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChIpsAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance S 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... clinicalStatus S 0..1 CodeableConcept active | inactive | resolved
... verificationStatus S 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
... category S 0..* code food | medication | environment | biologic
... criticality S 0..1 code low | high | unable-to-assess
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:certainty 0..1 AICertainty(5.3.0-ballot-tc1) Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
..... extension:duration 0..1 AIDuration(5.3.0-ballot-tc1) The amount of time that the Adverse Reaction persisted
..... extension:location 0..1 AILocation(5.3.0-ballot-tc1) The anatomical location / body site(s) where the symptoms manifested
..... extension:exposureDate 0..1 AIExposureDate(5.3.0-ballot-tc1) Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
..... extension:exposureDuration 0..1 AIExposureDuration(5.3.0-ballot-tc1) The amount of time the individual was exposed to the Substance
..... extension:management 0..1 AIManagement(5.3.0-ballot-tc1) Text description about the clinical management provided.
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | moderate | severe (of event as a whole)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance SC 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | 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..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | 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..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... patient Σ 1..1 Reference(CH IPS Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:certainty 0..1 CodeableConcept Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
..... extension:duration 0..1 Duration The amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
..... extension:location 0..1 CodeableConcept The anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
..... extension:exposureDate 0..1 dateTime Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
..... extension:exposureDuration 0..1 Duration The amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
..... extension:exposureDescription 0..1 string Text description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
..... extension:management 0..1 string Text description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... description 0..1 string Description of the event as a whole
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | 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..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If 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-4 error AllergyIntolerance If 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-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChIpsAllergyIntolerance

Summary

Mandatory: 1 element
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance SC 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | 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..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | 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..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... patient Σ 1..1 Reference(CH IPS Patient) Who the sensitivity is for
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:certainty 0..1 CodeableConcept Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
..... extension:duration 0..1 Duration The amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
..... extension:location 0..1 CodeableConcept The anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
..... extension:exposureDate 0..1 dateTime Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
..... extension:exposureDuration 0..1 Duration The amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
..... extension:exposureDescription 0..1 string Text description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
..... extension:management 0..1 string Text description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If 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-4 error AllergyIntolerance If 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-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ChIpsAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance S 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... clinicalStatus S 0..1 CodeableConcept active | inactive | resolved
... verificationStatus S 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
... category S 0..* code food | medication | environment | biologic
... criticality S 0..1 code low | high | unable-to-assess
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:certainty 0..1 AICertainty(5.3.0-ballot-tc1) Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
..... extension:duration 0..1 AIDuration(5.3.0-ballot-tc1) The amount of time that the Adverse Reaction persisted
..... extension:location 0..1 AILocation(5.3.0-ballot-tc1) The anatomical location / body site(s) where the symptoms manifested
..... extension:exposureDate 0..1 AIExposureDate(5.3.0-ballot-tc1) Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
..... extension:exposureDuration 0..1 AIExposureDuration(5.3.0-ballot-tc1) The amount of time the individual was exposed to the Substance
..... extension:management 0..1 AIManagement(5.3.0-ballot-tc1) Text description about the clinical management provided.
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | moderate | severe (of event as a whole)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance SC 0..* ChIpsAllergyIntolerance CH IPS AllergyIntolerance
This profile also imposes the profile AllergyIntolerance (IPS)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime S 0..1 dateTime, Age, Period, Range, string Abatement datetime
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | 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..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | 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..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CH AllergyIntolerance (extensible)
... patient Σ 1..1 Reference(CH IPS Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime When allergy or intolerance was identified
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:certainty 0..1 CodeableConcept Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
..... extension:duration 0..1 Duration The amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
..... extension:location 0..1 CodeableConcept The anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
..... extension:exposureDate 0..1 dateTime Record of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
..... extension:exposureDuration 0..1 Duration The amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
..... extension:exposureDescription 0..1 string Text description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
..... extension:management 0..1 string Text description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: CH AllergyIntolerance Reaction Substance (extensible)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: CH AllergyIntolerance Reaction Manifestation (extensible)
.... description 0..1 string Description of the event as a whole
.... onset S 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | 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..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible CH AllergyIntolerance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​substance Base extensible CH AllergyIntolerance Reaction Substance 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​manifestation Base extensible CH AllergyIntolerance Reaction Manifestation 📦3.3.0 CH Term v3.3
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance AllergyIntolerance.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-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If 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-4 error AllergyIntolerance If 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-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChIpsAllergyIntolerance

Summary

Mandatory: 1 element
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

 

Other representations of profile: CSV, Excel, Schematron