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 Substance

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-substance Version: 0.1.0
Draft as of 2025-12-02 Computable Name: SGHISubstance

Profile for representing substances in the SGHI context

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
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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)
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ 1..* SGHICodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
... code Σ 1..1 SGHICodeableReference(SubstanceDefinition) What substance this is
Binding: SGHI Substance Codes (required)
... description Σ 1..1 markdown Textual description of the substance, comments
... expiry Σ 1..1 dateTime When no longer valid to use
... quantity Σ 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient Σ 1..* BackboneElement Composition information about the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 1..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Substance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Substance 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().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-4 error Substance 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 Substance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Substance 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 Substance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... identifier 1..* Identifier Unique identifier
.... 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)
... status 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category 1..* SGHICodeableConcept What class/type of substance this is
... description 1..1 markdown Textual description of the substance, comments
... expiry 1..1 dateTime When no longer valid to use
... quantity 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient 1..* BackboneElement Composition information about the substance
.... quantity 1..1 Ratio Optional amount (concentration)
.... substance[x] 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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 Unique identifier
.... 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)
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ 1..* SGHICodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
... code Σ 1..1 SGHICodeableReference(SubstanceDefinition) What substance this is
Binding: SGHI Substance Codes (required)
... description Σ 1..1 markdown Textual description of the substance, comments
... expiry Σ 1..1 dateTime When no longer valid to use
... quantity Σ 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient Σ 1..* BackboneElement Composition information about the 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
.... quantity Σ 1..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base required All Languages 📍5.0.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Substance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Substance 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().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-4 error Substance 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 Substance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Substance 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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)
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ 1..* SGHICodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
... code Σ 1..1 SGHICodeableReference(SubstanceDefinition) What substance this is
Binding: SGHI Substance Codes (required)
... description Σ 1..1 markdown Textual description of the substance, comments
... expiry Σ 1..1 dateTime When no longer valid to use
... quantity Σ 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient Σ 1..* BackboneElement Composition information about the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 1..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Substance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Substance 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().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-4 error Substance 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 Substance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Substance 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 Substance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... identifier 1..* Identifier Unique identifier
.... 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)
... status 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category 1..* SGHICodeableConcept What class/type of substance this is
... description 1..1 markdown Textual description of the substance, comments
... expiry 1..1 dateTime When no longer valid to use
... quantity 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient 1..* BackboneElement Composition information about the substance
.... quantity 1..1 Ratio Optional amount (concentration)
.... substance[x] 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... 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 Unique identifier
.... 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)
... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ 1..* SGHICodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
... code Σ 1..1 SGHICodeableReference(SubstanceDefinition) What substance this is
Binding: SGHI Substance Codes (required)
... description Σ 1..1 markdown Textual description of the substance, comments
... expiry Σ 1..1 dateTime When no longer valid to use
... quantity Σ 1..1 SimpleQuantity(5.0.0) Amount of substance in the package
... ingredient Σ 1..* BackboneElement Composition information about the 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
.... quantity Σ 1..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 SGHICodeableConcept A component of the substance
Binding: SGHI Substance Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base required All Languages 📍5.0.0 FHIR Std.
Substance.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Substance.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Substance.status Base required FHIRSubstanceStatus 📦5.0.0 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍5.0.0 FHIR Std.
Substance.code Base required SGHI Substance Codes 📦0.1.0 This IG
Substance.ingredient.​substance[x] Base required SGHI Substance Codes 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Substance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Substance 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().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-4 error Substance 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 Substance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Substance 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()

 

Other representations of profile: CSV, Excel, Schematron