HL7 Europe Patient Summary
0.0.1-ci - ci-build
150
HL7 Europe Patient Summary
0.0.1-ci - ci-build
150
HL7 Europe Patient Summary, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/eps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/eps/StructureDefinition/allergyIntolerance-eu-eps | Version: 0.0.1-ci | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: AllergyIntoleranceEuEps | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
||||
This profile constrains the AllergyIntolerance resource for the purpose of the European patient summary.
This profile constrains the AllergyIntolerance resource for the purpose of the European patient summary.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) Constraints: ait-1, ait-2 | ||||||||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
   extension:abatement |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1]] | Extension URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1 | |||||||||||||||||||
  url |
1..1 | uri | identifies the meaning of the extension | |||||||||||||||||||
 Slices for value[x] |
0..1 | Value of extension Slice: Unordered, Open by type:$this | ||||||||||||||||||||
 valueBase64Binary |
base64Binary | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
 valueCanonical |
canonical(Any) | |||||||||||||||||||||
| valueCode |
code | |||||||||||||||||||||
| valueDate |
date | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valueDecimal |
decimal | |||||||||||||||||||||
| valueId |
id | |||||||||||||||||||||
| valueInstant |
instant | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueMarkdown |
markdown | |||||||||||||||||||||
| valueOid |
oid | |||||||||||||||||||||
| valuePositiveInt |
positiveInt | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueUnsignedInt |
unsignedInt | |||||||||||||||||||||
| valueUri |
uri | |||||||||||||||||||||
| valueUrl |
url | |||||||||||||||||||||
| valueUuid |
uuid | |||||||||||||||||||||
 valueAddress |
Address | |||||||||||||||||||||
| valueAge |
Age | |||||||||||||||||||||
| valueAnnotation |
Annotation | |||||||||||||||||||||
| valueAttachment |
Attachment | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueCoding |
Coding | |||||||||||||||||||||
| valueContactPoint |
ContactPoint | |||||||||||||||||||||
| valueCount |
Count | |||||||||||||||||||||
| valueDistance |
Distance | |||||||||||||||||||||
| valueDuration |
Duration | |||||||||||||||||||||
| valueHumanName |
HumanName | |||||||||||||||||||||
| valueIdentifier |
Identifier | |||||||||||||||||||||
| valueMoney |
Money | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueReference |
Reference(Any) | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueSignature |
Signature | |||||||||||||||||||||
| valueTiming |
Timing | |||||||||||||||||||||
| valueContactDetail |
ContactDetail | |||||||||||||||||||||
| valueContributor |
Contributor | |||||||||||||||||||||
| valueDataRequirement |
DataRequirement | |||||||||||||||||||||
| valueExpression |
Expression | |||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | |||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||||||||||||||||
| valueUsageContext |
UsageContext | |||||||||||||||||||||
| valueDosage |
Dosage | |||||||||||||||||||||
| valueMeta |
Meta | |||||||||||||||||||||
 value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConceptIPS(2.0.0) | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||||||
| type |
SOΣ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(Patient (EPS)) | Who the sensitivity is for
| ||||||||||||||||||
 reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| Slices for onset[x] |
SO | 0..1 | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
| |||||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||||||
| onsetAge |
Age | |||||||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||||||
| onsetRange |
Range | |||||||||||||||||||||
| onsetString |
string | |||||||||||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | Onset date
| ||||||||||||||||||
 reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||||||||
| 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: Allergens Value Set (preferred) | |||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS(2.0.0) | 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
| ||||||||||||||||||
| severity |
SO | 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.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| 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.criticality | Base | required | AllergyIntoleranceCriticality | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| AllergyIntolerance.reaction.substance | Base | preferred | Allergens Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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 AllergyIntoleranceUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) | |||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:abatement |
0..1 | ?pkp-2? | Extension | |||||||
| Slices for value[x] |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Slice: Unordered, Open by type:$this | |||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||
 clinicalStatus |
0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status | |||||||
| verificationStatus |
0..1 | CodeableConceptIPS(2.0.0) | Certainty | |||||||
| type |
0..1 | code | Type of propensity | |||||||
| criticality |
0..1 | code | Criticality | |||||||
| code |
1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||
| patient |
1..1 | Reference(Patient (EPS)) | Who the sensitivity is for | |||||||
| Slices for onset[x] |
Content/Rules for all slices | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| reaction |
||||||||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Allergens Value Set (preferred) | |||||||
| manifestation |
1..* | CodeableConceptIPS(2.0.0) | 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
| |||||||
| severity |
0..1 | code | Reaction severity | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| AllergyIntolerance.reaction.substance | Base | preferred | Allergens Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) 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 | ||||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||||
| 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 |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1]] | Extension URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1 | |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| url |
1..1 | uri | identifies the meaning of the extension | |||||||||||||||||||
| Slices for value[x] |
0..1 | Value of extension Slice: Unordered, Open by type:$this | ||||||||||||||||||||
| valueBase64Binary |
base64Binary | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueCanonical |
canonical(Any) | |||||||||||||||||||||
| valueCode |
code | |||||||||||||||||||||
| valueDate |
date | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valueDecimal |
decimal | |||||||||||||||||||||
| valueId |
id | |||||||||||||||||||||
| valueInstant |
instant | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueMarkdown |
markdown | |||||||||||||||||||||
| valueOid |
oid | |||||||||||||||||||||
| valuePositiveInt |
positiveInt | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueUnsignedInt |
unsignedInt | |||||||||||||||||||||
| valueUri |
uri | |||||||||||||||||||||
| valueUrl |
url | |||||||||||||||||||||
| valueUuid |
uuid | |||||||||||||||||||||
| valueAddress |
Address | |||||||||||||||||||||
| valueAge |
Age | |||||||||||||||||||||
| valueAnnotation |
Annotation | |||||||||||||||||||||
| valueAttachment |
Attachment | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueCoding |
Coding | |||||||||||||||||||||
| valueContactPoint |
ContactPoint | |||||||||||||||||||||
| valueCount |
Count | |||||||||||||||||||||
| valueDistance |
Distance | |||||||||||||||||||||
| valueDuration |
Duration | |||||||||||||||||||||
| valueHumanName |
HumanName | |||||||||||||||||||||
| valueIdentifier |
Identifier | |||||||||||||||||||||
| valueMoney |
Money | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueReference |
Reference(Any) | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueSignature |
Signature | |||||||||||||||||||||
| valueTiming |
Timing | |||||||||||||||||||||
| valueContactDetail |
ContactDetail | |||||||||||||||||||||
| valueContributor |
Contributor | |||||||||||||||||||||
| valueDataRequirement |
DataRequirement | |||||||||||||||||||||
| valueExpression |
Expression | |||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | |||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||||||||||||||||
| valueUsageContext |
UsageContext | |||||||||||||||||||||
| valueDosage |
Dosage | |||||||||||||||||||||
| valueMeta |
Meta | |||||||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConceptIPS(2.0.0) | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||||||
| type |
SOΣ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||||||||||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(Patient (EPS)) | Who the sensitivity is for
| ||||||||||||||||||
| 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 |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| 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) | Encounter when the allergy or intolerance was asserted | |||||||||||||||||||
| Slices for onset[x] |
SO | 0..1 | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
| |||||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||||||
| onsetAge |
Age | |||||||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||||||
| onsetRange |
Range | |||||||||||||||||||||
| onsetString |
string | |||||||||||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | Onset date
| ||||||||||||||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||||||||||||||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||||||||
| 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: Allergens Value Set (preferred) | |||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS(2.0.0) | 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
| ||||||||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||||||||||
| severity |
SO | 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.
| ||||||||||||||||||
| 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 | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| 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 AllergyIntoleranceUvIps
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) Constraints: ait-1, ait-2 | ||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:abatement |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1]] | Extension URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1 | |||||||||||||||||||
| url |
1..1 | uri | identifies the meaning of the extension | |||||||||||||||||||
| Slices for value[x] |
0..1 | Value of extension Slice: Unordered, Open by type:$this | ||||||||||||||||||||
| valueBase64Binary |
base64Binary | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueCanonical |
canonical(Any) | |||||||||||||||||||||
| valueCode |
code | |||||||||||||||||||||
| valueDate |
date | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valueDecimal |
decimal | |||||||||||||||||||||
| valueId |
id | |||||||||||||||||||||
| valueInstant |
instant | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueMarkdown |
markdown | |||||||||||||||||||||
| valueOid |
oid | |||||||||||||||||||||
| valuePositiveInt |
positiveInt | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueUnsignedInt |
unsignedInt | |||||||||||||||||||||
| valueUri |
uri | |||||||||||||||||||||
| valueUrl |
url | |||||||||||||||||||||
| valueUuid |
uuid | |||||||||||||||||||||
| valueAddress |
Address | |||||||||||||||||||||
| valueAge |
Age | |||||||||||||||||||||
| valueAnnotation |
Annotation | |||||||||||||||||||||
| valueAttachment |
Attachment | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueCoding |
Coding | |||||||||||||||||||||
| valueContactPoint |
ContactPoint | |||||||||||||||||||||
| valueCount |
Count | |||||||||||||||||||||
| valueDistance |
Distance | |||||||||||||||||||||
| valueDuration |
Duration | |||||||||||||||||||||
| valueHumanName |
HumanName | |||||||||||||||||||||
| valueIdentifier |
Identifier | |||||||||||||||||||||
| valueMoney |
Money | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueReference |
Reference(Any) | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueSignature |
Signature | |||||||||||||||||||||
| valueTiming |
Timing | |||||||||||||||||||||
| valueContactDetail |
ContactDetail | |||||||||||||||||||||
| valueContributor |
Contributor | |||||||||||||||||||||
| valueDataRequirement |
DataRequirement | |||||||||||||||||||||
| valueExpression |
Expression | |||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | |||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||||||||||||||||
| valueUsageContext |
UsageContext | |||||||||||||||||||||
| valueDosage |
Dosage | |||||||||||||||||||||
| valueMeta |
Meta | |||||||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConceptIPS(2.0.0) | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||||||
| type |
SOΣ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(Patient (EPS)) | Who the sensitivity is for
| ||||||||||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| Slices for onset[x] |
SO | 0..1 | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
| |||||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||||||
| onsetAge |
Age | |||||||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||||||
| onsetRange |
Range | |||||||||||||||||||||
| onsetString |
string | |||||||||||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | Onset date
| ||||||||||||||||||
| reaction |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||||||||
| 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: Allergens Value Set (preferred) | |||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS(2.0.0) | 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
| ||||||||||||||||||
| severity |
SO | 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.
| ||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| 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.criticality | Base | required | AllergyIntoleranceCriticality | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| AllergyIntolerance.reaction.substance | Base | preferred | Allergens Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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 AllergyIntoleranceUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) | |||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:abatement |
0..1 | ?pkp-2? | Extension | |||||||
| Slices for value[x] |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Slice: Unordered, Open by type:$this | |||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||
| clinicalStatus |
0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status | |||||||
| verificationStatus |
0..1 | CodeableConceptIPS(2.0.0) | Certainty | |||||||
| type |
0..1 | code | Type of propensity | |||||||
| criticality |
0..1 | code | Criticality | |||||||
| code |
1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| |||||||
| patient |
1..1 | Reference(Patient (EPS)) | Who the sensitivity is for | |||||||
| Slices for onset[x] |
Content/Rules for all slices | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| reaction |
||||||||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Allergens Value Set (preferred) | |||||||
| manifestation |
1..* | CodeableConceptIPS(2.0.0) | 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
| |||||||
| severity |
0..1 | code | Reaction severity | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| AllergyIntolerance.reaction.substance | Base | preferred | Allergens Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1 |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps(2.0.0) | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0) 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 | ||||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||||
| 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 |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1]] | Extension URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement|5.3.0-ballot-tc1 | |||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||
| url |
1..1 | uri | identifies the meaning of the extension | |||||||||||||||||||
| Slices for value[x] |
0..1 | Value of extension Slice: Unordered, Open by type:$this | ||||||||||||||||||||
| valueBase64Binary |
base64Binary | |||||||||||||||||||||
| valueBoolean |
boolean | |||||||||||||||||||||
| valueCanonical |
canonical(Any) | |||||||||||||||||||||
| valueCode |
code | |||||||||||||||||||||
| valueDate |
date | |||||||||||||||||||||
| valueDateTime |
dateTime | |||||||||||||||||||||
| valueDecimal |
decimal | |||||||||||||||||||||
| valueId |
id | |||||||||||||||||||||
| valueInstant |
instant | |||||||||||||||||||||
| valueInteger |
integer | |||||||||||||||||||||
| valueMarkdown |
markdown | |||||||||||||||||||||
| valueOid |
oid | |||||||||||||||||||||
| valuePositiveInt |
positiveInt | |||||||||||||||||||||
| valueString |
string | |||||||||||||||||||||
| valueTime |
time | |||||||||||||||||||||
| valueUnsignedInt |
unsignedInt | |||||||||||||||||||||
| valueUri |
uri | |||||||||||||||||||||
| valueUrl |
url | |||||||||||||||||||||
| valueUuid |
uuid | |||||||||||||||||||||
| valueAddress |
Address | |||||||||||||||||||||
| valueAge |
Age | |||||||||||||||||||||
| valueAnnotation |
Annotation | |||||||||||||||||||||
| valueAttachment |
Attachment | |||||||||||||||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||||||||||||||
| valueCoding |
Coding | |||||||||||||||||||||
| valueContactPoint |
ContactPoint | |||||||||||||||||||||
| valueCount |
Count | |||||||||||||||||||||
| valueDistance |
Distance | |||||||||||||||||||||
| valueDuration |
Duration | |||||||||||||||||||||
| valueHumanName |
HumanName | |||||||||||||||||||||
| valueIdentifier |
Identifier | |||||||||||||||||||||
| valueMoney |
Money | |||||||||||||||||||||
| valuePeriod |
Period | |||||||||||||||||||||
| valueQuantity |
Quantity | |||||||||||||||||||||
| valueRange |
Range | |||||||||||||||||||||
| valueRatio |
Ratio | |||||||||||||||||||||
| valueReference |
Reference(Any) | |||||||||||||||||||||
| valueSampledData |
SampledData | |||||||||||||||||||||
| valueSignature |
Signature | |||||||||||||||||||||
| valueTiming |
Timing | |||||||||||||||||||||
| valueContactDetail |
ContactDetail | |||||||||||||||||||||
| valueContributor |
Contributor | |||||||||||||||||||||
| valueDataRequirement |
DataRequirement | |||||||||||||||||||||
| valueExpression |
Expression | |||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | |||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||||||||||||||||
| valueUsageContext |
UsageContext | |||||||||||||||||||||
| valueDosage |
Dosage | |||||||||||||||||||||
| valueMeta |
Meta | |||||||||||||||||||||
| value[x]:valueDateTime |
0..1 | dateTime | End date | |||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||||||||||||
| clinicalStatus |
?!SOΣC | 0..1 | CodeableConceptIPS(2.0.0) | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||||||||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConceptIPS(2.0.0) | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||||||||||||
| type |
SOΣ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| ||||||||||||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||||||||||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS(2.0.0) | Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
| ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(Patient (EPS)) | Who the sensitivity is for
| ||||||||||||||||||
| 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 |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||||||||
| 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) | Encounter when the allergy or intolerance was asserted | |||||||||||||||||||
| Slices for onset[x] |
SO | 0..1 | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this
| |||||||||||||||||||
| onsetDateTime |
dateTime | |||||||||||||||||||||
| onsetAge |
Age | |||||||||||||||||||||
| onsetPeriod |
Period | |||||||||||||||||||||
| onsetRange |
Range | |||||||||||||||||||||
| onsetString |
string | |||||||||||||||||||||
| onset[x]:onsetDateTime |
SO | 0..1 | dateTime | Onset date
| ||||||||||||||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||||||||||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||||||||||||||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | 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 |
SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| ||||||||||||||||||
| 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: Allergens Value Set (preferred) | |||||||||||||||||||
| manifestation |
SO | 1..* | CodeableConceptIPS(2.0.0) | 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
| ||||||||||||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||||||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||||||||||
| severity |
SO | 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.
| ||||||||||||||||||
| 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 | |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| 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 AllergyIntoleranceUvIps
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Europe. Package hl7.fhir.eu.eps#0.0.1-ci based on FHIR 4.0.1. Generated 2025-10-24
