SIL HIE Implementation Guide
0.1.0 - sil-hie-active

SIL HIE Implementation Guide, published by Kathurima Kimathi. 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/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions

Resource Profile: HIE AllergyIntolerance

Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/allergyintolerance Version: 0.1.0
Active as of 2026-10-20 Computable Name: HIEAllergyIntolerance

R4B AllergyIntolerance constrained for HIE capture and exchange.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type This element is included in summaries. C 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Constraints: cc-text-or-code
AllergyIntolerance.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.assigner This element must be supported. This element is included in summaries. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter This element is included in summaries. 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance C 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
Constraints: cc-text-or-code
AllergyIntolerance.reaction.manifestation This element must be supported. C 1..* HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute C 0..1 HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
cc-text-or-code warning AllergyIntolerance.identifier.type, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.exposureRoute Text is optional, coding is required coding.exists()
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.exists() and ('#'+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(uri) = '#').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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.identifier This element must be supported. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
AllergyIntolerance.identifier.system 1..1 uri The namespace for the identifier value
AllergyIntolerance.identifier.value This element must be supported. 1..1 string The value that is unique
AllergyIntolerance.identifier.assigner This element must be supported. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element must be supported. 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
AllergyIntolerance.verificationStatus This element must be supported. 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
AllergyIntolerance.category This element must be supported. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.patient This element must be supported. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.substance 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
AllergyIntolerance.reaction.manifestation This element must be supported. 1..* HIECodeableConcept Clinical symptoms/signs associated with the Event
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute 0..1 HIECodeableConcept How the subject was exposed to the substance
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
AllergyIntolerance.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.id 0..1 id Unique id for inter-element referencing
AllergyIntolerance.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type This element is included in summaries. C 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Constraints: cc-text-or-code
AllergyIntolerance.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner This element must be supported. This element is included in summaries. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.code This element is included in summaries. 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x] 0..1 When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime dateTime
AllergyIntolerance.onset[x].onsetAge Age
AllergyIntolerance.onset[x].onsetPeriod Period
AllergyIntolerance.onset[x].onsetRange Range
AllergyIntolerance.onset[x].onsetString string
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter This element is included in summaries. 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance C 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
Constraints: cc-text-or-code
AllergyIntolerance.reaction.manifestation This element must be supported. C 1..* HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute C 0..1 HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
cc-text-or-code warning AllergyIntolerance.identifier.type, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.exposureRoute Text is optional, coding is required coding.exists()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning AllergyIntolerance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type This element is included in summaries. C 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Constraints: cc-text-or-code
AllergyIntolerance.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.assigner This element must be supported. This element is included in summaries. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter This element is included in summaries. 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance C 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
Constraints: cc-text-or-code
AllergyIntolerance.reaction.manifestation This element must be supported. C 1..* HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute C 0..1 HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
cc-text-or-code warning AllergyIntolerance.identifier.type, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.exposureRoute Text is optional, coding is required coding.exists()
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.exists() and ('#'+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(uri) = '#').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 AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.identifier This element must be supported. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
AllergyIntolerance.identifier.system 1..1 uri The namespace for the identifier value
AllergyIntolerance.identifier.value This element must be supported. 1..1 string The value that is unique
AllergyIntolerance.identifier.assigner This element must be supported. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element must be supported. 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
AllergyIntolerance.verificationStatus This element must be supported. 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
AllergyIntolerance.type This element must be supported. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
AllergyIntolerance.category This element must be supported. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.patient This element must be supported. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.substance 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
AllergyIntolerance.reaction.manifestation This element must be supported. 1..* HIECodeableConcept Clinical symptoms/signs associated with the Event
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute 0..1 HIECodeableConcept How the subject was exposed to the substance
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
AllergyIntolerance.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.id 0..1 id Unique id for inter-element referencing
AllergyIntolerance.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
AllergyIntolerance.identifier.type This element is included in summaries. C 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
Constraints: cc-text-or-code
AllergyIntolerance.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner This element must be supported. This element is included in summaries. 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 HIECodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..1 HIECodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required)
Constraints: cc-text-or-code
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required)
AllergyIntolerance.code This element is included in summaries. 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 HIEReference(HIE Patient) Who the sensitivity is for
AllergyIntolerance.encounter 1..1 HIEReference(HIE Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x] 0..1 When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime dateTime
AllergyIntolerance.onset[x].onsetAge Age
AllergyIntolerance.onset[x].onsetPeriod Period
AllergyIntolerance.onset[x].onsetRange Range
AllergyIntolerance.onset[x].onsetString string
AllergyIntolerance.recordedDate This element must be supported. 1..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder 0..1 HIEReference(HIE Practitioner | PractitionerRole) Who recorded the sensitivity
AllergyIntolerance.asserter This element is included in summaries. 1..1 HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson) Source of the information about the allergy
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.reaction This element must be supported. 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.extension 0..* Extension Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance C 0..1 HIECodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
Constraints: cc-text-or-code
AllergyIntolerance.reaction.manifestation This element must be supported. C 1..* HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required)
AllergyIntolerance.reaction.exposureRoute C 0..1 HIECodeableConcept 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.
Constraints: cc-text-or-code
AllergyIntolerance.reaction.note 0..* HIEAnnotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📦4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.3.0 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. (verificationStatus.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
cc-text-or-code warning AllergyIntolerance.identifier.type, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.exposureRoute Text is optional, coding is required coding.exists()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning AllergyIntolerance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

 

Other representations of profile: CSV, Excel, Schematron