XpanDH Hospital Discharge Report
0.1.0 - ci-build
150
XpanDH Hospital Discharge Report
0.1.0 - ci-build
150
XpanDH Hospital Discharge Report, published by XpanDH Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xpandh-hdr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/ig/xpandh/hdr/StructureDefinition/allergy-intolerance-xpandh | Version: 0.1.0 | |||
| Draft as of 2025-10-10 | Computable Name: AllergyIntoleranceXpandh | |||
Copyright/Legal: Used by permission of the XpanDH project, all rights reserved Creative Commons License |
||||
This profile represents the constraints applied to the AllergyIntolerance resource by the Xpandh Hospital Discharge Report FHIR Implementation Guide.
It documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.
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 | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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-datetime |
0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
 code |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
 patient |
SΣ | 1..1 | Reference(Patient: HDR) | Who the sensitivity is for | ||||||||
 reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
 onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
 reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| manifestation |
S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - SNOMED CT IPS Free Set | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| 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 | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |||||||
 code |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| |||||||
| patient |
1..1 | Reference(Patient: HDR) | Who the sensitivity is for | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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-datetime |
0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||
| clinicalStatus |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | |||||||||
| verificationStatus |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | |||||||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||||
| criticality |
Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||
| code |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
| patient |
SΣ | 1..1 | Reference(Patient: HDR) | 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 |
SΣ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 | |||||||||
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
| 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 |
S | 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||
| manifestation |
S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||||||
| exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||||||
| Documentation for this format | ||||||||||||
| 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 | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - SNOMED CT IPS Free Set | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| 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. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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-datetime |
0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
| code |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
| patient |
SΣ | 1..1 | Reference(Patient: HDR) | Who the sensitivity is for | ||||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| manifestation |
S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - SNOMED CT IPS Free Set | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| 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 | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |||||||
| code |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| |||||||
| patient |
1..1 | Reference(Patient: HDR) | Who the sensitivity is for | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.code | Base | preferred | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntoleranceUvIps | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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-datetime |
0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External ids for this item | ||||||||
| clinicalStatus |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | |||||||||
| verificationStatus |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | |||||||||
| type |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||||
| criticality |
Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||||
| code |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - Xpandh (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
| patient |
SΣ | 1..1 | Reference(Patient: HDR) | 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 |
SΣ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 | |||||||||
| onset[x] |
S | 0..1 | When allergy or intolerance was identified | |||||||||
| onsetDateTime |
dateTime S | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
| 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 |
S | 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||
| manifestation |
S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||||||
| exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||||||
| Documentation for this format | ||||||||||||
| 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 | Allergy Intolerance - Xpandh | 📦0.1.0 | This IG |
| AllergyIntolerance.patient.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | preferred | Allergy Reaction - SNOMED CT IPS Free Set | 📦1.1.0 | International Patient Summary Implementation Guide v1.1 |
| 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. |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ XpanDH Project. Package hl7.eu.fhir.xpandh.hdr#0.1.0 based on FHIR 4.0.1. Generated 2025-10-10
