Kenya Emergency FHIR Implementation Guide
0.1.0 - ci-build Kenya flag

Kenya Emergency FHIR Implementation Guide, published by Digital Health Agency (DHA), Kenya. 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/IntelliSOFT-Consulting/Kenya-Emmergency-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: AllergyIntolerance - No Known Allergy

Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/em-no-known-allergy Version: 0.1.0
Active as of 2026-07-20 Computable Name: EMNoKnownAllergy

An explicit record asserting that a full allergy history was taken and nothing was found, distinct from simply having zero AllergyIntolerance resources.

The absence of any AllergyIntolerance resource is ambiguous — it could mean 'confirmed none' or 'never asked' — and that ambiguity is exactly the kind of gap that can lead to a contraindicated drug being administered.

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: Filtersdoco
.. AllergyIntolerance C 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!SΣC 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
..... display 0..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
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Overall potential clinical harm from a future reaction
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Binding: Active Components Value Set (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
..... 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) Patient with the allergy
... encounter S 0..1 Reference(Encounter) Encounter during which this record was captured or updated
... recordedDate S 1..1 dateTime When the no-known-allergy assertion was made
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who captured this record
... asserter SΣ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who originally reported the allergy
... reaction S 0..* BackboneElement Details of the actual reaction(s) previously experienced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept What the reaction looked like
Binding: Manifestation or Symptom ValueSet (extensible)
.... severity S 0..1 code Severity of that specific reaction
Binding: AllergyIntoleranceSeverity (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible Active Components Value Set 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Manifestation or Symptom ValueSet 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 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.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 EMAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
... code 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
... recordedDate 1..1 dateTime When the no-known-allergy assertion was made

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
..... display 0..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
... verificationStatus ?!SΣC 1..1 CodeableConcept Confidence level in this allergy record
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type Σ 0..1 code Allergy versus intolerance
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Overall potential clinical harm from a future reaction
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Binding: Active Components Value Set (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
..... 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) Patient with the allergy
... encounter S 0..1 Reference(Encounter) Encounter during which this record was captured or updated
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetString string
... recordedDate S 1..1 dateTime When the no-known-allergy assertion was made
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who captured this record
... asserter SΣ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who originally reported the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 0..* BackboneElement Details of the actual reaction(s) previously experienced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConcept What the reaction looked like
Binding: Manifestation or Symptom ValueSet (extensible)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code Severity of that specific reaction
Binding: AllergyIntoleranceSeverity (required)
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible Active Components Value Set 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base extensible Manifestation or Symptom ValueSet 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from EMAllergyIntolerance

Summary

Mandatory: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!SΣC 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
..... display 0..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
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Overall potential clinical harm from a future reaction
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Binding: Active Components Value Set (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
..... 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) Patient with the allergy
... encounter S 0..1 Reference(Encounter) Encounter during which this record was captured or updated
... recordedDate S 1..1 dateTime When the no-known-allergy assertion was made
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who captured this record
... asserter SΣ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who originally reported the allergy
... reaction S 0..* BackboneElement Details of the actual reaction(s) previously experienced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept What the reaction looked like
Binding: Manifestation or Symptom ValueSet (extensible)
.... severity S 0..1 code Severity of that specific reaction
Binding: AllergyIntoleranceSeverity (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible Active Components Value Set 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Manifestation or Symptom ValueSet 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 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.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from EMAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
... code 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
... recordedDate 1..1 dateTime When the no-known-allergy assertion was made

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* EMAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 1..1 CodeableConcept Fixed to active — this assertion is itself an active record
Binding: AllergyIntoleranceClinicalStatusCodes (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: active
..... display 0..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
... verificationStatus ?!SΣC 1..1 CodeableConcept Confidence level in this allergy record
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type Σ 0..1 code Allergy versus intolerance
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Overall potential clinical harm from a future reaction
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept Fixed to the SNOMED CT 'No known allergy (situation)' concept
Binding: Active Components Value Set (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 716186003
..... display 1..1 string Representation defined by the system
Fixed Value: No known allergy (situation)
..... 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) Patient with the allergy
... encounter S 0..1 Reference(Encounter) Encounter during which this record was captured or updated
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetString string
... recordedDate S 1..1 dateTime When the no-known-allergy assertion was made
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who captured this record
... asserter SΣ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who originally reported the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 0..* BackboneElement Details of the actual reaction(s) previously experienced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConcept What the reaction looked like
Binding: Manifestation or Symptom ValueSet (extensible)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code Severity of that specific reaction
Binding: AllergyIntoleranceSeverity (required)
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📦4.0.1 FHIR Std.
AllergyIntolerance.code Base extensible Active Components Value Set 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base extensible Manifestation or Symptom ValueSet 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from EMAllergyIntolerance

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron