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

Kenya ePrescription 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: Kenya eRx AllergyIntolerance

Official URL: https://nshr-uat.sha.go.ke/StructureDefinition/ke-allergy-intolerance Version: 0.1.0
Draft as of 2026-04-24 Computable Name: KEAllergyIntolerance

Copyright/Legal: Copyright 2025+ Digital Health Agency, Kenya. This content is licensed under Creative Commons Attribution 4.0 International (CC-BY-4.0). Terminology content from the Kenya Pharmacy and Poisons Board (PPB) via Open Concept Lab (OCL) is subject to separate terms.

Profile on AllergyIntolerance for the Kenya eRx Implementation Guide.

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..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... 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 Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Verification status (unconfirmed, confirmed, refuted, entered-in-error)
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣ 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category SΣ 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter SΣ 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (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.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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown

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 AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 0..* Identifier External ids for this item
... clinicalStatus S 1..1 CodeableConcept Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... type S 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category S 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality S 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code S 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient S 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter S 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)

doco Documentation for this format

Terminology Bindings (Differential)

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.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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance 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 SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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 SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 1..1 CodeableConcept Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Verification status (unconfirmed, confirmed, refuted, entered-in-error)
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣ 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category SΣ 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter SΣ 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown

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 AllergyIntolerance

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 25 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... 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 Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Verification status (unconfirmed, confirmed, refuted, entered-in-error)
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣ 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category SΣ 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter SΣ 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (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.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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown

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 AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
... identifier S 0..* Identifier External ids for this item
... clinicalStatus S 1..1 CodeableConcept Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... type S 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category S 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality S 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code S 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient S 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter S 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)

doco Documentation for this format

Terminology Bindings (Differential)

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.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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance 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 SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to.
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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 SΣ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 1..1 CodeableConcept Clinical status (active, inactive, resolved) — default active
Binding: AllergyIntoleranceClinicalStatusCodes (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Verification status (unconfirmed, confirmed, refuted, entered-in-error)
Binding: AllergyIntoleranceVerificationStatusCodes (required)
... type SΣ 1..1 code Allergy or intolerance — default 'allergy'
Binding: AllergyIntoleranceType (required)
... category SΣ 1..* code Category (food, medication, environment, biologic)
Binding: AllergyIntoleranceCategory (required)
... criticality SΣ 1..1 code Estimated clinical harm (low, high, unable-to-assess)
Binding: AllergyIntoleranceCriticality (required)
... code SΣ 1..1 CodeableConcept ​Allergen substance from Kenya MOH PPB Active Components
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter S 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] S 0..1 When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime S 0..1 dateTime Use when allergy is still active
.... onset[x]:onsetAge 0..1 Age When allergy or intolerance was identified
.... onset[x]:onsetPeriod 0..1 Period Use when both start and end of allergy are known
.... onset[x]:onsetRange 0..1 Range When allergy or intolerance was identified
.... onset[x]:onsetString 0..1 string When allergy or intolerance was identified
... recordedDate S 1..1 dateTime Date recorded at point-of-care system
... recorder S 0..1 Reference(Practitioner | Patient) Who recorded the allergy
... asserter SΣ 0..1 Reference(Patient | Practitioner) Source asserting the allergy
... lastOccurrence S 0..1 dateTime Last known occurrence of a reaction
... note S 0..* Annotation Additional narrative notes about the allergy
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 1..1 CodeableConcept ​Specific allergen that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/active-components-vs (required)
.... manifestation S 1..* CodeableConcept ​Clinical manifestation / symptom
Binding: https://nshr-uat.sha.go.ke/ValueSet/manifestation (required)
.... description S 0..1 string Text description of the reaction
.... onset S 0..1 dateTime When the reaction occurred
.... severity S 1..1 code Severity (mild, moderate, severe)
Binding: AllergyIntoleranceSeverity (required)
.... exposureRoute S 0..1 CodeableConcept ​Route of exposure that caused the reaction
Binding: https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs (required)
.... 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.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
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 required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​substance Base required ​ https://nshr-uat.sha.go.ke/ValueSet/active-components-vs Not State Unknown
AllergyIntolerance.reaction.​manifestation Base required ​ https://nshr-uat.sha.go.ke/ValueSet/manifestation Not State Unknown
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base required ​ https://nshr-uat.sha.go.ke/ValueSet/route-of-administration-vs Not State Unknown

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 AllergyIntolerance

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 25 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

 

Other representations of profile: CSV, Excel, Schematron