HL7 Europe Discharge Report
1.0.0-ci-build - ci-build 150

HL7 Europe Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/discharge-report/ and changes regularly. See the Directory of published versions

Resource Profile: AllergyIntolerance: obligations

Official URL: http://hl7.eu/fhir/discharge-report/StructureDefinition/allergyIntolerance-obl-eu-dr Version: 1.0.0-ci-build
Standards status: Informative Maturity Level: 0 Computable Name: AllergyIntoleranceEuDrObligation

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile defines obligations for the AllergyIntolerance resource for the purpose of this guide.

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: doco
AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.text This element has obligations. 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
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for extension Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
AllergyIntolerance.Slices for extension.extension:abatement.extension 0..0 Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueDateTime dateTime
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueAge Age
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valuePeriod Period
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueRange Range
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueString string
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].value[x]:valueDateTime 0..1 dateTime End date
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type This element has obligations. This element is included in summaries. 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.code This element has obligations. This element is included in summaries. 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional BindingsPurpose
eHDSI Allergen No Drug Preferred
WHO ATC - IPS Preferred
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
AllergyIntolerance.Slices for onset[x].onsetDateTime dateTime
AllergyIntolerance.Slices for onset[x].onsetAge Age
AllergyIntolerance.Slices for onset[x].onsetPeriod Period
AllergyIntolerance.Slices for onset[x].onsetRange Range
AllergyIntolerance.Slices for onset[x].onsetString string
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

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.code Base preferred Allergies & Intolerances - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0

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 AllergyIntoleranceEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.text This element has obligations. 0..1 Narrative Text summary of the resource, for human interpretation
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.type This element has obligations. 0..1 code Type of propensity
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.code This element has obligations. 1..1 CodeableConcept Code that identifies the allergy or intolerance
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for onset[x] Content/Rules for all slices
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the allergy or intolerance content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.text This element has obligations. 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
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
AllergyIntolerance.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
AllergyIntolerance.Slices for extension.extension:abatement.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.Slices for extension.extension:abatement.extension 0..0 Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueDateTime dateTime
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueAge Age
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valuePeriod Period
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueRange Range
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueString string
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].value[x]:valueDateTime 0..1 dateTime End date
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element is included in summaries. 0..* Identifier Business identifier for the allergy or intolerance
AllergyIntolerance.clinicalStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type This element has obligations. This element is included in summaries. 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.category This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element is included in summaries. 0..1 code Criticality
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code This element has obligations. This element is included in summaries. 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional BindingsPurpose
eHDSI Allergen No Drug Preferred
WHO ATC - IPS Preferred
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.Slices for onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
AllergyIntolerance.Slices for onset[x].onsetDateTime dateTime
AllergyIntolerance.Slices for onset[x].onsetAge Age
AllergyIntolerance.Slices for onset[x].onsetPeriod Period
AllergyIntolerance.Slices for onset[x].onsetRange Range
AllergyIntolerance.Slices for onset[x].onsetString string
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
AllergyIntolerance.recordedDate 0..1 dateTime Date when the allergy or intolerance was recorded
AllergyIntolerance.recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the allergy or intolerance
AllergyIntolerance.asserter This element is included in summaries. 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who asserts the allergy or intolerance
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.note.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.note.author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
AllergyIntolerance.note.author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
AllergyIntolerance.note.author[x].authorString string
AllergyIntolerance.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
AllergyIntolerance.note.text This element is included in summaries. 1..1 markdown Additional information about the allergy or intolerance
AllergyIntolerance.reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: eHDSI Allergen No Drug (example)
AllergyIntolerance.reaction.manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additional BindingsPurpose
eHDSI Reaction Allergy Preferred

AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset 0..1 dateTime Reaction onset
AllergyIntolerance.reaction.severity 0..1 code Reaction severity
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.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 preferred Allergies & Intolerances - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
AllergyIntolerance.reaction.​substance Base example eHDSI Allergen No Drug ⏿0.2.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
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 AllergyIntoleranceEuCore

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.text This element has obligations. 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
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for extension Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
AllergyIntolerance.Slices for extension.extension:abatement.extension 0..0 Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueDateTime dateTime
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueAge Age
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valuePeriod Period
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueRange Range
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueString string
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].value[x]:valueDateTime 0..1 dateTime End date
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type This element has obligations. This element is included in summaries. 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.code This element has obligations. This element is included in summaries. 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional BindingsPurpose
eHDSI Allergen No Drug Preferred
WHO ATC - IPS Preferred
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
AllergyIntolerance.Slices for onset[x].onsetDateTime dateTime
AllergyIntolerance.Slices for onset[x].onsetAge Age
AllergyIntolerance.Slices for onset[x].onsetPeriod Period
AllergyIntolerance.Slices for onset[x].onsetRange Range
AllergyIntolerance.Slices for onset[x].onsetString string
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

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.code Base preferred Allergies & Intolerances - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0

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 AllergyIntoleranceEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.text This element has obligations. 0..1 Narrative Text summary of the resource, for human interpretation
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.type This element has obligations. 0..1 code Type of propensity
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.code This element has obligations. 1..1 CodeableConcept Code that identifies the allergy or intolerance
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.patient This element has obligations. 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.Slices for onset[x] Content/Rules for all slices
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the allergy or intolerance content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.text This element has obligations. 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
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
AllergyIntolerance.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
AllergyIntolerance.Slices for extension.extension:abatement.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.Slices for extension.extension:abatement.extension 0..0 Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:abatement.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueDateTime dateTime
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueAge Age
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valuePeriod Period
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueRange Range
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].valueString string
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x] Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:abatement.Slices for value[x].value[x]:valueDateTime 0..1 dateTime End date
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element is included in summaries. 0..* Identifier Business identifier for the allergy or intolerance
AllergyIntolerance.clinicalStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element is included in summaries. C 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type This element has obligations. This element is included in summaries. 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.category This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element is included in summaries. 0..1 code Criticality
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code This element has obligations. This element is included in summaries. 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additional BindingsPurpose
eHDSI Allergen No Drug Preferred
WHO ATC - IPS Preferred
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
AllergyIntolerance.encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.Slices for onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
AllergyIntolerance.Slices for onset[x].onsetDateTime dateTime
AllergyIntolerance.Slices for onset[x].onsetAge Age
AllergyIntolerance.Slices for onset[x].onsetPeriod Period
AllergyIntolerance.Slices for onset[x].onsetRange Range
AllergyIntolerance.Slices for onset[x].onsetString string
AllergyIntolerance.Slices for onset[x].onset[x]:onsetDateTime This element has obligations. 0..1 dateTime Onset date
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
AllergyIntolerance.recordedDate 0..1 dateTime Date when the allergy or intolerance was recorded
AllergyIntolerance.recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the allergy or intolerance
AllergyIntolerance.asserter This element is included in summaries. 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who asserts the allergy or intolerance
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.note.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.note.author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
AllergyIntolerance.note.author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
AllergyIntolerance.note.author[x].authorString string
AllergyIntolerance.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
AllergyIntolerance.note.text This element is included in summaries. 1..1 markdown Additional information about the allergy or intolerance
AllergyIntolerance.reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: eHDSI Allergen No Drug (example)
AllergyIntolerance.reaction.manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additional BindingsPurpose
eHDSI Reaction Allergy Preferred

AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset 0..1 dateTime Reaction onset
AllergyIntolerance.reaction.severity 0..1 code Reaction severity
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.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 preferred Allergies & Intolerances - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
AllergyIntolerance.reaction.​substance Base example eHDSI Allergen No Drug ⏿0.2.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
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 AllergyIntoleranceEuCore

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron