ISiK Basis Implementierungsleitfaden
Version 6.0.0-rc - ballot

Resource Profile: ISiKAllergieUnvertraeglichkeit

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKAllergieUnvertraeglichkeit Version: 6.0.0-rc
Active as of 2026-04-02 Computable Name: ISiKAllergieUnvertraeglichkeit

Diese Profil ermöglicht die Dokumentation von Allergien und Unverträglichkeiten in ISiK Szenarien.

Motivation

Die Möglichkeit, auf eine Übersicht der Allergien und Unverträglichkeiten eines Patienten zuzugreifen, ist eine wichtige Funktion im klinischen Behandlungsablauf. Dies gilt insbesondere, aber nicht ausschließlich, im Bereich der Arzneimitteltherapiesicherheit. Motivierender Use-Case zur Einführung dieser Profile ist die Arzneitmitteltherapiesicherheit im Krankenhaus - AMTS.

In FHIR werden Allergien und Unverträglichkeiten mit der AllergyIntolerance-Ressource repräsentiert.

Kompatibilität

Für das Profil ISiKAllergieUnvertraeglichkeit wird eine Kompatibilität mit folgenden Profilen angestrebt; allerdings kann nicht sichergestellt werden, dass Instanzen, die gegen ISiKAllergieUnvertraeglichkeit valide sind, auch valide sind gegen:

Hinweise zu Inkompatibilitäten können über die Portalseite gemeldet werden.

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 C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id serverseitige, interne ID des Datensatzes
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!ΣC 0..1 CodeableConcept klinischer Status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
.... coding Σ 0..1 Coding Code defined by a terminology system
.... coding Σ 0..1 Coding Code defined by a terminology system
... type Σ 0..1 code Type (Allergie oder Unverträglichkeit)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code Kategorie
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Kritikalität
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask Σ 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc Σ 0..1 ISiKATCCoding Code defined by a terminology system
... patient Σ 1..1 Reference(Patient) Patientenbezug
.... reference ΣC 0..1 string Patienten-Link
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... reference ΣC 0..1 string Encounter-Link
... Slices for onset[x] 0..1 Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... note 0..* Annotation Anmerkung
.... author[x] Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
.... severity 0..1 code Schweregrad der Reaktion
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept Expositionsweg
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.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system

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 example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
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 AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... implicitRules 0..0 Verweis auf die Regeln, nach denen die Ressource erstellt wurde
.... coding 0..1 Coding Code defined by a terminology system
... verificationStatus 0..1 CodeableConcept Verifikationsstatus
.... coding 0..1 Coding Code defined by a terminology system
... type 0..1 code Type (Allergie oder Unverträglichkeit)
... category 0..* code Kategorie
... criticality 0..1 code Kritikalität
... code 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc 0..1 ISiKATCCoding Code defined by a terminology system
... patient 1..1 Reference(Patient) Patientenbezug
.... reference 0..1 string Patienten-Link
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... reference 0..1 string Encounter-Link
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... note 0..* Annotation Anmerkung
.... author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system
.... severity 0..1 code Schweregrad der Reaktion
.... exposureRoute 0..1 CodeableConcept Expositionsweg
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept klinischer Status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verificationStatus ?!ΣC 0..1 CodeableConcept Verifikationsstatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... type Σ 0..1 code Type (Allergie oder Unverträglichkeit)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code Kategorie
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Kritikalität
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask Σ 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc Σ 0..1 ISiKATCCoding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) Patientenbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Patienten-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Encounter-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for onset[x] 0..1 Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Anmerkung
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code Schweregrad der Reaktion
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept Expositionsweg
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.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
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 example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.encounter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
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 AllergyIntolerance

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.code.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction.manifestation.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction.exposureRoute.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id serverseitige, interne ID des Datensatzes
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!ΣC 0..1 CodeableConcept klinischer Status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
.... coding Σ 0..1 Coding Code defined by a terminology system
.... coding Σ 0..1 Coding Code defined by a terminology system
... type Σ 0..1 code Type (Allergie oder Unverträglichkeit)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code Kategorie
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Kritikalität
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask Σ 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc Σ 0..1 ISiKATCCoding Code defined by a terminology system
... patient Σ 1..1 Reference(Patient) Patientenbezug
.... reference ΣC 0..1 string Patienten-Link
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... reference ΣC 0..1 string Encounter-Link
... Slices for onset[x] 0..1 Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... note 0..* Annotation Anmerkung
.... author[x] Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
.... severity 0..1 code Schweregrad der Reaktion
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept Expositionsweg
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.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system

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 example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
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()

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... implicitRules 0..0 Verweis auf die Regeln, nach denen die Ressource erstellt wurde
.... coding 0..1 Coding Code defined by a terminology system
... verificationStatus 0..1 CodeableConcept Verifikationsstatus
.... coding 0..1 Coding Code defined by a terminology system
... type 0..1 code Type (Allergie oder Unverträglichkeit)
... category 0..* code Kategorie
... criticality 0..1 code Kritikalität
... code 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc 0..1 ISiKATCCoding Code defined by a terminology system
... patient 1..1 Reference(Patient) Patientenbezug
.... reference 0..1 string Patienten-Link
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... reference 0..1 string Encounter-Link
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... note 0..* Annotation Anmerkung
.... author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system
.... severity 0..1 code Schweregrad der Reaktion
.... exposureRoute 0..1 CodeableConcept Expositionsweg
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct 0..1 ISiKSnomedCTCoding Code defined by a terminology system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept klinischer Status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verificationStatus ?!ΣC 0..1 CodeableConcept Verifikationsstatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... type Σ 0..1 code Type (Allergie oder Unverträglichkeit)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code Kategorie
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Kritikalität
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Benennung der Allergie/Unverträglichkeit
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... coding:ask Σ 0..1 ISiKASKCoding Code defined by a terminology system
..... coding:atc Σ 0..1 ISiKATCCoding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) Patientenbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Patienten-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Aufenthaltsbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Encounter-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for onset[x] 0..1 Beginn-Zeitpunkt
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetAge 0..1 Age Alter beim Beginn der Allergie/Unvertraeglichkeit
.... onset[x]:onsetString 0..1 string Freitextinformation zum Beginn der Allergie/Unvertraeglichkeit
... recordedDate 0..1 dateTime Datum an dem die Allergie/Unverträglichkeit aufgezeichnet wurde
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person/Rolle, die die Information dokumentiert
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person/Rolle, die die Allergie/Unverträglichkeit festgestellt hat
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Anmerkung
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 0..* BackboneElement Unerwünschte Reaktion
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Manifestation der Reaktion
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code Schweregrad der Reaktion
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept Expositionsweg
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.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
...... coding:snomed-ct Σ 0..1 ISiKSnomedCTCoding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
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 example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.encounter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
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 AllergyIntolerance

Summary

Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.code.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction.manifestation.coding
  • The element 1 is sliced based on the value of AllergyIntolerance.reaction.exposureRoute.coding

 

Other representations of profile: CSV, Excel, Schematron