HSAI FHIR Implementation Guide
0.1.0 - CI Build Netherlands

HSAI FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: CDT AllergyIntolerance

Official URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/cdt-allergyintolerance | Version: 0.1.0
Active as of 2026-02-09 | Computable Name: CDTAllergyIntolerance

AllergyIntolerance profile created by the Clinical Data Transformer (CDT) tool for international use

Usage:

- This Resource Profile is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end
identifier | S | 1..* | Identifier | External ids for this item
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value |  | 1..1 | string | The value that is unique
clinicalStatus | S | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus | S | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required)
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Required Pattern: allergy
code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct
version |  | 1..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system
display |  | 1..1 | string | Representation defined by the system
patient | S | 1..1 | Reference(Patient) | Who the sensitivity is for
onset[x] | S | 0..1 | dateTime | When allergy or intolerance was identified
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..* | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
clinicalStatus | ?!S Σ C | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required) ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!S Σ C | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required) ele-1: All FHIR elements must have a @value or children
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children Required Pattern: allergy
code | S Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required) ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
onset[x] | S | 0..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.type | required | Pattern: allergy `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG

#### Constraints

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 | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | External ids for this item
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
clinicalStatus | ?!S Σ C | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus | ?!S Σ C | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required)
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Required Pattern: allergy
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 Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct
version | Σ | 1..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] | 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(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 |  | 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 |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity |  | 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

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
AllergyIntolerance.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.type | required | Pattern: allergy `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG
AllergyIntolerance.reaction.substance | example | SubstanceCode `http://hl7.org/fhir/ValueSet/substance-code` from the FHIR Standard
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` from the FHIR Standard
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes `http://hl7.org/fhir/ValueSet/route-codes` from the FHIR Standard

#### Constraints

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: 8 elements(4 nested mandatory elements)
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end

Differential View

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance |  | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end
identifier | S | 1..* | Identifier | External ids for this item
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value |  | 1..1 | string | The value that is unique
clinicalStatus | S | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus | S | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required)
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Required Pattern: allergy
code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required)
coding |  |  |  |
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct
version |  | 1..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system
display |  | 1..1 | string | Representation defined by the system
patient | S | 1..1 | Reference(Patient) | Who the sensitivity is for
onset[x] | S | 0..1 | dateTime | When allergy or intolerance was identified
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..* | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
clinicalStatus | ?!S Σ C | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required) ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!S Σ C | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required) ele-1: All FHIR elements must have a @value or children
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children Required Pattern: allergy
code | S Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required) ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
onset[x] | S | 0..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.type | required | Pattern: allergy `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG

#### Constraints

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 | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 3..* | Extension | Extension Slice: Unordered, Open by value:url
extension:textSource | S | 1..1 | string | Text Source Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
extension:textIndexStart | S | 1..1 | integer | Text Index Start Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
extension:textIndexEnd | S | 1..1 | integer | Text Index End Extension URL: https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | External ids for this item
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://cdt-beta.healthsage.ai/fhir/identifier/hsai-cdt
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
clinicalStatus | ?!S Σ C | 1..1 | CodeableConcept | active | resolved | inactive Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus | ?!S Σ C | 1..1 | CodeableConcept | confirmed | presumed Binding: AllergyIntoleranceVerificationStatusCodes (required)
type | S Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. Required Pattern: allergy
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 Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: CDT AllergyIntolerance Value Set (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct
version | Σ | 1..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(Patient) | Who the sensitivity is for
encounter |  | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted
onset[x] | 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(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 |  | 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 |  | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity |  | 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

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
AllergyIntolerance.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
AllergyIntolerance.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
AllergyIntolerance.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-clinical` from the FHIR Standard
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes `http://hl7.org/fhir/ValueSet/allergyintolerance-verification` from the FHIR Standard
AllergyIntolerance.type | required | Pattern: allergy `http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1` from the FHIR Standard
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality `http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | CDTAllergyIntoleranceVS `https://cdt-beta.healthsage.ai/fhir/ValueSet/cdt-allergyintolerance-vs` from this IG
AllergyIntolerance.reaction.substance | example | SubstanceCode `http://hl7.org/fhir/ValueSet/substance-code` from the FHIR Standard
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` from the FHIR Standard
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity `http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1` from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes `http://hl7.org/fhir/ValueSet/route-codes` from the FHIR Standard

#### Constraints

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: 8 elements(4 nested mandatory elements)
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-source
- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-start
- https://cdt-beta.healthsage.ai/fhir/StructureDefinition/text-index-end

Other representations of profile: CSV, Excel, Schematron