SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

Resource Profile: SGHI AllergyIntolerance

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-allergyintolerance Version: 0.1.0
Draft as of 2025-09-04 Computable Name: SGHIAllergyIntolerance

Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.

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 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ 1..1 SGHICodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code Σ 1..1 SGHICodeableConcept Code that identifies the allergy or intolerance
Binding: All LOINC Codes (example)
... patient Σ 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... reaction 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... severity 1..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0
From the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0
From the FHIR Standard
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|5.0.0
From the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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)
... identifier 1..* Identifier External ids for this item
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus 1..1 SGHICodeableConcept active | inactive | resolved
... verificationStatus 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
... patient 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... actor 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... reaction 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... severity 1..1 code mild | moderate | severe (of event as a whole)
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ 1..1 SGHICodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 CodeableConcept allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 1..1 SGHICodeableConcept Code that identifies the allergy or intolerance
Binding: All LOINC Codes (example)
... patient Σ 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... 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
.... function Σ 0..1 CodeableConcept Type of involvement
Binding: ParticipationRoleType (extensible)
.... actor Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction 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 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 1..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0
From the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0
From the FHIR Standard
AllergyIntolerance.typepreferredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type
From the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|5.0.0
From the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|5.0.0
From the FHIR Standard
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.participant.functionextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|5.0.0
From the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ 1..1 SGHICodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code Σ 1..1 SGHICodeableConcept Code that identifies the allergy or intolerance
Binding: All LOINC Codes (example)
... patient Σ 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... reaction 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... severity 1..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0
From the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0
From the FHIR Standard
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|5.0.0
From the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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)
... identifier 1..* Identifier External ids for this item
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus 1..1 SGHICodeableConcept active | inactive | resolved
... verificationStatus 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
... patient 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... actor 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... reaction 1..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... severity 1..1 code mild | moderate | severe (of event as a whole)
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ 1..1 SGHICodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ 1..1 SGHICodeableConcept unconfirmed | presumed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 CodeableConcept allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 1..1 SGHICodeableConcept Code that identifies the allergy or intolerance
Binding: All LOINC Codes (example)
... patient Σ 1..1 SGHIReference(SGHI Patient) Who the allergy or intolerance is for
... encounter 1..1 SGHIReference(SGHI Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 1..1 dateTime When allergy or intolerance was identified
... recordedDate 1..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 1..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... 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
.... function Σ 0..1 CodeableConcept Type of involvement
Binding: ParticipationRoleType (extensible)
.... actor Σ 1..1 SGHIReference(SGHI Patient | SGHI Organization) Who or what participated in the activities related to the allergy or intolerance
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction 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 0..1 SGHICodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: All LOINC Codes (example)
.... manifestation 1..* SGHICodeableReference(SGHI Observation) Clinical symptoms/signs associated with the Event
Binding: All LOINC Codes (example)
.... description 1..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 1..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 SGHICodeableConcept How the subject was exposed to the substance
Binding: All LOINC Codes (example)
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
AllergyIntolerance.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
AllergyIntolerance.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|5.0.0
From the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatus
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|5.0.0
From the FHIR Standard
AllergyIntolerance.typepreferredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type
From the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|5.0.0
From the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|5.0.0
From the FHIR Standard
AllergyIntolerance.codeexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.participant.functionextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
From the FHIR Standard
AllergyIntolerance.reaction.substanceexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.manifestationexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|5.0.0
From the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleAllLoincCodes(a valid code from LOINC)
https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron