Kenya Patient Summary FHIR IG
0.1.0 - ci-build Kenya flag

Kenya Patient Summary FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AllergyIntolerance Profile - KPS

Official URL: https://example.org/fhir/StructureDefinition/kps-allergyIntolerance Version: 0.1.0
Draft as of 2025-12-09 Computable Name: KpsAllergyIntolerance

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..* AllergyIntoleranceUvIps 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
... Slices for extension Content/Rules for all slices
.... extension:abatement-datetime 0..1 dateTime Abatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (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 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
Additional BindingsPurpose
Allergy Intolerance - SNOMED CT IPS Free Set candidate
WHO ATC - IPS candidate
Absent or Unknown Allergies - IPS candidate
... patient SΣ 1..1 Reference(Patient (IPS)) Who the sensitivity is for
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime S
.... 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 1..1 CodeableConcept Allergen or substance causing reaction
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
.... 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 Allergy Certainty 📦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 preferred Allergy Intolerance - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
AllergyIntolerance.reaction.​substance Base example Substance Code 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - SNOMED CT IPS Free Set 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 AllergyIntoleranceUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntoleranceUvIps Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S 0..1 CodeableConceptIPS Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (required)
... type 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... onset[x] 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 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance 1..1 CodeableConcept Allergen or substance causing reaction
.... manifestation 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
.... description 0..1 string Free-text description of the allergy reaction
.... severity 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 Allergy Certainty 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦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..* AllergyIntoleranceUvIps 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime 0..1 dateTime Abatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus S 0..1 CodeableConceptIPS Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (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 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
Additional BindingsPurpose
Allergy Intolerance - SNOMED CT IPS Free Set candidate
WHO ATC - IPS candidate
Absent or Unknown Allergies - IPS candidate
... patient SΣ 1..1 Reference(Patient (IPS)) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 S
.... 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 1..1 CodeableConcept Allergen or substance causing reaction
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
.... 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.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 Allergy Certainty 📦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 preferred Allergy Intolerance - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
AllergyIntolerance.patient.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - SNOMED CT IPS Free Set 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 AllergyIntoleranceUvIps

Summary

Mandatory: 4 elements
Must-Support: 3 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntoleranceUvIps 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
... Slices for extension Content/Rules for all slices
.... extension:abatement-datetime 0..1 dateTime Abatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (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 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
Additional BindingsPurpose
Allergy Intolerance - SNOMED CT IPS Free Set candidate
WHO ATC - IPS candidate
Absent or Unknown Allergies - IPS candidate
... patient SΣ 1..1 Reference(Patient (IPS)) Who the sensitivity is for
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime S
.... 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 1..1 CodeableConcept Allergen or substance causing reaction
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
.... 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 Allergy Certainty 📦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 preferred Allergy Intolerance - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
AllergyIntolerance.reaction.​substance Base example Substance Code 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - SNOMED CT IPS Free Set 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 AllergyIntoleranceUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntoleranceUvIps Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S 0..1 CodeableConceptIPS Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (required)
... type 1..1 code Allergy, Intolerance, or Unknown
Binding: Allergy Type (required)
... onset[x] 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 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance 1..1 CodeableConcept Allergen or substance causing reaction
.... manifestation 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
.... description 0..1 string Free-text description of the allergy reaction
.... severity 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 Allergy Certainty 📦0.1.0 This IG
AllergyIntolerance.type Base required Allergy Type 📦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..* AllergyIntoleranceUvIps 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement-datetime 0..1 dateTime Abatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus S 0..1 CodeableConceptIPS Status of the allergy: active, resolved, etc.
Binding: Allergy Clinical Status (required)
... verificationStatus S 1..1 CodeableConceptIPS Certainty about the allergy (confirmed, unconfirmed, etc.)
Binding: Allergy Certainty (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 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
Additional BindingsPurpose
Allergy Intolerance - SNOMED CT IPS Free Set candidate
WHO ATC - IPS candidate
Absent or Unknown Allergies - IPS candidate
... patient SΣ 1..1 Reference(Patient (IPS)) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 S
.... 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 1..1 CodeableConcept Allergen or substance causing reaction
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConceptIPS Clinical manifestation(s), e.g. rash, shock
Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set).
.... 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.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 Allergy Certainty 📦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 preferred Allergy Intolerance - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
AllergyIntolerance.patient.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📦4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - SNOMED CT IPS Free Set 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 AllergyIntoleranceUvIps

Summary

Mandatory: 4 elements
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron