Kenya Patient Summary FHIR Implementation Guide
0.1.0 - ci-build Kenya flag

Kenya Patient Summary FHIR Implementation Guide, published by Digital Health Agency of 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-Patient-Summary-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: AllergyIntolerance Profile - KPS

Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance Version: 0.1.0
Draft as of 2026-06-19 Computable Name: KpsAllergyIntolerance

Copyright/Legal: Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.

This profile defines constraints on the AllergyIntolerance resource for use within the Kenya Patient Summary. It captures information about a patient's known allergies and intolerances to substances such as medications, foods, or environmental agents, supporting safer clinical decision-making, continuity of care, and data exchange within the national Health Information Exchange (HIE).

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
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... clinicalStatus ?!SΣC 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: VerificationStatus ValueSet (required)
... type SΣ 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... criticality SΣ 0..1 code Likelihood of life-threatening reaction on exposure
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG

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)
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
... clinicalStatus S 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... type S 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... criticality S 0..1 code Likelihood of life-threatening reaction on exposure
... code S 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG
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 SΣ 1..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 Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
.... 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 Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: VerificationStatus ValueSet (required)
... type SΣ 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code Likelihood of life-threatening reaction on exposure
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* 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 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (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.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 Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG
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 AllergyIntolerance

Summary

Mandatory: 6 elements
Must-Support: 12 elements

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
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... clinicalStatus ?!SΣC 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: VerificationStatus ValueSet (required)
... type SΣ 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... criticality SΣ 0..1 code Likelihood of life-threatening reaction on exposure
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance S 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG

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)
... id S 1..1 id Logical id of this artifact
... meta S 1..1 Meta Metadata about the resource
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
... clinicalStatus S 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... type S 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... criticality S 0..1 code Likelihood of life-threatening reaction on exposure
... code S 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG

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 SΣ 1..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 Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ke-kps-allergy-intolerance|0.1.0
.... 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 Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: VerificationStatus ValueSet (required)
... type SΣ 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code Likelihood of life-threatening reaction on exposure
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 0..1 CodeableConcept Causative agent (allergen)
Binding: KPS Allergy Intolerance Substance Codes (required)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date of last occurrence of the allergy
... note 0..* Annotation Medical alert notes (clinical importance)
... reaction S 1..* 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 0..1 CodeableConcept Substance causing the reaction
Binding: KPS Allergy Intolerance Substance Codes (required)
.... manifestation S 1..* CodeableConcept Clinical manifestation(s), e.g. rash, anaphylaxis
Binding: KPS Allergy Reaction Manifestation Codes (required)
.... description 0..1 string Free-text description of the allergy reaction
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code Severity of reaction
Binding: Allergy Severity (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.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 Allergy Clinical Status 📦0.1.0 This IG
AllergyIntolerance.verificationStatus Base required VerificationStatus ValueSet 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦0.1.0 This IG
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​substance Base required KPS Allergy Intolerance Substance Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​manifestation Base required KPS Allergy Reaction Manifestation Codes 📦0.1.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy Severity 📦0.1.0 This IG
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 AllergyIntolerance

Summary

Mandatory: 6 elements
Must-Support: 12 elements

 

Other representations of profile: CSV, Excel, Schematron