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 Medication

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

SGHI's Medication profile for Medication resource

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
.. Medication 0..* Medication Definition of a Medication
... 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)
... code Σ 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 SGHIReference(SGHI Organization) Organization that has authorization to market medication
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... identifier 1..* Identifier Business identifier for this medication
.... 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)
... code 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status 1..1 code active | inactive | entered-in-error
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)
... ingredient
.... item 1..1 SGHICodeableReference(SGHI Medication | SGHI Substance) The ingredient (substance or medication) that the ingredient.strength relates to
Binding: SGHI Medication Codes (required)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio, CodeableConcept, Quantity Quantity of ingredient present
Slice: Unordered, Open by type:$this
..... strength[x]:strengthCodeableConcept 0..1 SGHICodeableConcept Quantity of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG
Medication.ingredient.​item Base required SGHI Medication Codes 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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 Business identifier for this medication
.... 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)
... code Σ 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 SGHIReference(SGHI Organization) Organization that has authorization to market medication
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)
... totalVolume Σ 0..1 Quantity When the specified product code does not infer a package size, this is the specific amount of drug in the product
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... item 1..1 SGHICodeableReference(SGHI Medication | SGHI Substance) The ingredient (substance or medication) that the ingredient.strength relates to
Binding: SGHI Medication Codes (required)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Quantity of ingredient present
Slice: Unordered, Open by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
..... strength[x]:strengthCodeableConcept 0..1 SGHICodeableConcept Quantity of ingredient present
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base required All Languages 📍5.0.0 FHIR Std.
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG
Medication.ingredient.​item Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.ingredient.​strength[x] Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.
Medication.ingredient.​strength[x]:strengthCodeableConcept Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication 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 Medication 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 Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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
.. Medication 0..* Medication Definition of a Medication
... 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)
... code Σ 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 SGHIReference(SGHI Organization) Organization that has authorization to market medication
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... identifier 1..* Identifier Business identifier for this medication
.... 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)
... code 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status 1..1 code active | inactive | entered-in-error
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)
... ingredient
.... item 1..1 SGHICodeableReference(SGHI Medication | SGHI Substance) The ingredient (substance or medication) that the ingredient.strength relates to
Binding: SGHI Medication Codes (required)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Ratio, CodeableConcept, Quantity Quantity of ingredient present
Slice: Unordered, Open by type:$this
..... strength[x]:strengthCodeableConcept 0..1 SGHICodeableConcept Quantity of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG
Medication.ingredient.​item Base required SGHI Medication Codes 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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 Business identifier for this medication
.... 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)
... code Σ 1..1 SGHICodeableConcept Codes that identify this medication
Binding: SGHI Medication Codes (required)
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 SGHIReference(SGHI Organization) Organization that has authorization to market medication
... doseForm 0..1 SGHICodeableConcept powder | tablets | capsule +
Binding: SGHI Medication Form Codes (required)
... totalVolume Σ 0..1 Quantity When the specified product code does not infer a package size, this is the specific amount of drug in the product
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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
.... item 1..1 SGHICodeableReference(SGHI Medication | SGHI Substance) The ingredient (substance or medication) that the ingredient.strength relates to
Binding: SGHI Medication Codes (required)
.... isActive 1..1 boolean Active ingredient indicator
.... Slices for strength[x] 1..1 Quantity of ingredient present
Slice: Unordered, Open by type:$this
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
..... strength[x]:strengthCodeableConcept 0..1 SGHICodeableConcept Quantity of ingredient present
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base required All Languages 📍5.0.0 FHIR Std.
Medication.identifier.​use Base required IdentifierUse 📦5.0.0 FHIR Std.
Medication.identifier.​type Base required SGHI Standard Identifier Types 📦0.1.0 This IG
Medication.code Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base required SGHI Medication Form Codes 📦0.1.0 This IG
Medication.ingredient.​item Base required SGHI Medication Codes 📦0.1.0 This IG
Medication.ingredient.​strength[x] Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.
Medication.ingredient.​strength[x]:strengthCodeableConcept Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.

Constraints

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