Kenya Emergency FHIR Implementation Guide
0.1.0 - ci-build
Kenya Emergency FHIR Implementation Guide
0.1.0 - ci-build
Kenya Emergency FHIR Implementation Guide, published by Digital Health Agency (DHA), Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-Emmergency-FHIR-IG/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr-uat.sha.go.ke/fhir/StructureDefinition/em-allergy-criticality-flag | Version: 0.1.0 | |||
| Active as of 2026-07-20 | Computable Name: EMAllergyCriticalityFlag | |||
A prominent, must-see alert referencing a high-criticality EMAllergyIntolerance record.
Reuses the base FHIR Flag resource, designed exactly for prominent alerts, rather than requiring every consuming system to know a local convention on AllergyIntolerance. Intended for use specifically with EMAllergyIntolerance instances where criticality = high.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Flag |
0..* | Flag | Key information to flag to healthcare providers | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. Required Pattern: active |
 category |
SΣ | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
| code |
SΣ | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
  subject |
SΣ | 1..1 | Reference(Patient) | Patient the alert applies to |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | example | Flag Code | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | 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 | Flag | 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 | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | 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 Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
 status |
S | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Required Pattern: active |
| category |
S | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety |
| code |
S | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction |
| subject |
S | 1..1 | Reference(Patient) | Patient the alert applies to |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. Required Pattern: active | ||||
| category |
SΣ | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Patient the alert applies to | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | example | Flag Code | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | 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 | Flag | 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 | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | 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 Flag
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. Required Pattern: active |
| category |
SΣ | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
| code |
SΣ | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
| subject |
SΣ | 1..1 | Reference(Patient) | Patient the alert applies to |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | example | Flag Code | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | 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 | Flag | 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 | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | 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 Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| status |
S | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Required Pattern: active |
| category |
S | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety |
| code |
S | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction |
| subject |
S | 1..1 | Reference(Patient) | Patient the alert applies to |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | Fixed to active while the underlying allergy remains high-criticality Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. Required Pattern: active | ||||
| category |
SΣ | 0..1 | CodeableConcept | Category of alert, e.g. clinical/safety Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Summary of the high-criticality allergy, e.g. allergen and reaction Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Patient the alert applies to | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | example | Flag Code | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | 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 | Flag | 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 | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | 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 Flag
Other representations of profile: CSV, Excel, Schematron