Kenya Patient Summary FHIR IG
0.1.0 - ci-build
Kenya Patient Summary FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://example.org/fhir/StructureDefinition/kps-medication | Version: 0.1.0 | |||
| Draft as of 2025-12-09 | Computable Name: KpsMedication | |||
This profile defines constraints on the Medication resource for use within the Kenya Patient Summary. It captures information about medicinal products prescribed, dispensed, or administered to a patient, supporting medication reconciliation, continuity of care, and data exchange within the national Health Information Exchange (HIE).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name | ||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required)
| ||||||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | ||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | Reference(Substance - KPS) | The actual ingredient or content | ||||||||
![]() ![]() ![]() |
SC | 0..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator Constraints: rat-1 | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications | ||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch | ||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire | ||||||||
Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| 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().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 | 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()
|
| qty-3 | error | Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator | If a code for the unit is present, the system SHALL also be present |
code.empty() or system.exists()
|
| rat-1 | error | Medication.ingredient.strength | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
|
This structure is derived from MedicationIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name |
![]() ![]() |
1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required) | |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error |
![]() ![]() |
S | 0..1 | Reference(Organization) | Manufacturer of the item |
![]() ![]() |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | Reference(Substance - KPS) | The actual ingredient or content | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | |
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications |
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch |
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
![]() ![]() |
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 | |||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name | ||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required)
| ||||||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | ||||||||
![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | Reference(Substance - KPS) | The actual ingredient or content | ||||||||
![]() ![]() ![]() |
0..1 | boolean | Active ingredient indicator | |||||||||
![]() ![]() ![]() |
SC | 0..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator Constraints: rat-1 | ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications | ||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch | ||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire | ||||||||
Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| 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().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 | 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()
|
| qty-3 | error | Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator | If a code for the unit is present, the system SHALL also be present |
code.empty() or system.exists()
|
| rat-1 | error | Medication.ingredient.strength | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
|
This structure is derived from MedicationIPS
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name | ||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required)
| ||||||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | ||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | Reference(Substance - KPS) | The actual ingredient or content | ||||||||
![]() ![]() ![]() |
SC | 0..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator Constraints: rat-1 | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications | ||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch | ||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire | ||||||||
Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| 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().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 | 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()
|
| qty-3 | error | Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator | If a code for the unit is present, the system SHALL also be present |
code.empty() or system.exists()
|
| rat-1 | error | Medication.ingredient.strength | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
|
Differential View
This structure is derived from MedicationIPS
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name |
![]() ![]() |
1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required) | |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error |
![]() ![]() |
S | 0..1 | Reference(Organization) | Manufacturer of the item |
![]() ![]() |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | Reference(Substance - KPS) | The actual ingredient or content | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | |
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications |
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch |
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MedicationIPS | Definition of a Medication | |||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
![]() ![]() |
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 | |||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() |
S | 0..1 | string | Medication Brand Name URL: https://example.org/fhir/StructureDefinition/medication-brand-name | ||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for this medication | ||||||||
![]() ![]() |
S | 1..1 | CodeableConceptIPS | Medication that was administered or was to be administered (medication code from any code system) Binding: Medication Value Set (required)
| ||||||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||||
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||||||
![]() ![]() |
S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Form ValueSet (required) | ||||||||
![]() ![]() |
Σ | 0..1 | Ratio | Amount of drug in package | ||||||||
![]() ![]() |
S | 0..* | BackboneElement | Active or inactive ingredient | ||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | Reference(Substance - KPS) | The actual ingredient or content | ||||||||
![]() ![]() ![]() |
0..1 | boolean | Active ingredient indicator | |||||||||
![]() ![]() ![]() |
SC | 0..1 | RatioIPS | A ratio of two Quantity values - a numerator and a denominator Constraints: rat-1 | ||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() ![]() ![]() |
SC | 0..1 | QuantityIPS | A measured amount using UCUM Constraints: qty-3 | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation Binding: UCUM Units for Medication Strength (preferred) | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | uri | UCUM system for units Fixed Value: http://unitsofmeasure.org | ||||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Coded form of the unit | ||||||||
![]() ![]() |
S | 0..1 | BackboneElement | Details about packaged medications | ||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
![]() ![]() ![]() |
S | 1..1 | string | Identifier assigned to batch | ||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | When batch will expire | ||||||||
Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Medication.code | Base | required | Medication Value Set | 📦0.1.0 | This IG |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | required | Form ValueSet | 📦0.1.0 | This IG |
| Medication.ingredient.strength.numerator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.numerator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| Medication.ingredient.strength.denominator.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Medication.ingredient.strength.denominator.unit | Base | preferred | UCUM Units for Medication Strength | 📦0.1.0 | This IG |
| 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().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 | 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()
|
| qty-3 | error | Medication.ingredient.strength.numerator, Medication.ingredient.strength.denominator | If a code for the unit is present, the system SHALL also be present |
code.empty() or system.exists()
|
| rat-1 | error | Medication.ingredient.strength | Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
|
This structure is derived from MedicationIPS
Other representations of profile: CSV, Excel, Schematron