CH-AllergyIntolerance (R4)
2.0.1 - trial-use
CH-AllergyIntolerance (R4)
2.0.1 - trial-use
This page is part of the CH-AllergyIntolerance (R4) (v2.0.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-allergyintolerance/StructureDefinition/ch-allergyintolerance | Version: 2.0.1 | |||
| Draft as of 2023-12-28 | Computable Name: CHAllergyIntolerance | |||
Copyright/Legal: CC0-1.0 |
||||
This profile represents the constraints applied to the AllergyIntolerance resource in the Swiss context - in adaption of the definition by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the Swiss EPR, in a TransitionOfCare transaction or similar as an instance of an AllergyIntolerance resource constrained by this profile. It documents the relevant allergies or intolerances for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.
This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of a Swiss patient in adaption of the one specified by the IPS project of HL7 International.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | S | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 abatement-datetime | S | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips |
 clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
| category | S | 0..* | code | food | medication | environment | biologic |
| criticality | S | 0..1 | code | low | high | unable-to-assess |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) |
 patient | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for | |
  Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
  onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified |
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy | |
 reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
 severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet |
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet |
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| abatement-datetime | S | 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 |
 clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) |
| patient | Σ | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for |
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||
 onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified |
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet |
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet |
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| abatement-datetime | S | 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 | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) | ||||
| patient | Σ | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified | ||||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy | ||||
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note | 0..* | Annotation | Additional text not captured in other fields | |||||
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |||||
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |||||
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |||||
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |||||
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |||||
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |||||
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) | ||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed | ||||
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
| ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet | ||||
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet | ||||
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | S | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| abatement-datetime | S | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips |
| clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
| verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
| type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
| category | S | 0..* | code | food | medication | environment | biologic |
| criticality | S | 0..1 | code | low | high | unable-to-assess |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) |
| patient | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for | |
| Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
| onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified |
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy | |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet |
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet |
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| abatement-datetime | S | 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 |
| clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) |
| patient | Σ | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for |
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified |
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | Σ | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) |
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet |
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet |
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| abatement-datetime | S | 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 | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | SΣ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CHAllergyIntoleranceValueSet (extensible) | ||||
| patient | Σ | 1..1 | Reference(CH Core Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified | ||||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson) | Source of the information about the allergy | ||||
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
| note | 0..* | Annotation | Additional text not captured in other fields | |||||
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| certainty | 0..1 | CodeableConcept | certainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event. | |||||
| duration | 0..1 | Duration | The amount of time that the Adverse Reaction persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | |||||
| location | 0..1 | CodeableConcept | The anatomical location / body site(s) where the symptoms manifested URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |||||
| exposureDate | 0..1 | dateTime | Record of the date and/or time of the first exposure to the Substance for this Reaction Event. URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate | |||||
| exposureDuration | 0..1 | Duration | The amount of time the individual was exposed to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration | |||||
| exposureDescription | 0..1 | string | Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription | |||||
| management | 0..1 | string | Text description about the clinical management provided. URL: http://hl7.org/fhir/StructureDefinition/openEHR-management | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| substance | S | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible) | ||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible) | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | S | 0..1 | dateTime | Date(/time) when manifestations showed | ||||
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
| ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
| AllergyIntolerance.code | extensible | CHAllergyIntoleranceValueSet | ||||
| AllergyIntolerance.reaction.substance | extensible | CHAllergyIntoleranceReactionSubstanceValueSet | ||||
| AllergyIntolerance.reaction.manifestation | extensible | CHAllergyIntoleranceReactionManifestationValueSet | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from AllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron