Medication Scheme Implementation Guide
1.0.0 - draft
Medication Scheme Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-medication-scheme/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.ee/StructureDefinition/ee-tis-medication-extemporal | Version: 1.0.0 | |||
Draft as of 2024-07-08 | Computable Name: EETISMedicationExtemporal |
Ekstemporaalne ravim. Profile for representing medication that is prepared in pharmacy by pharmacist. E.g. sulfur ointment or solution of Protargoli.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | Medication | |||
meta | ||||
versionId | 0..1 | id | Version specific identifier Example versionId: 1 | |
identifier | 0..1 | Identifier | Prescription number | |
code | 0..0 | |||
status | 0..0 | |||
marketingAuthorizationHolder | 0..0 | |||
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |
totalVolume | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 1..1 | decimal | Total volume of medication. | |
unit | 0..0 | |||
code | 0..1 | code | Unit for total volume | |
ingredient | 1..* | BackboneElement | Active or inactive ingredient | |
item | 1..1 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation | |
concept | ||||
text | 1..1 | string | Plain text representation of the concept | |
batch | 0..0 | |||
definition | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
identifier | Σ | 0..1 | Identifier | Prescription number |
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |
totalVolume | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
value | Σ | 1..1 | decimal | Total volume of medication. |
code | ΣC | 0..1 | code | Unit for total volume |
ingredient | 1..* | BackboneElement | Active or inactive ingredient | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item | 1..1 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation Binding: SNOMEDCTMedicationCodes (example) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
qty-3 | error | Medication.totalVolume | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | Medication.totalVolume | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier Example versionId: 1 | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Prescription number | ||||
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |||||
totalVolume | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Total volume of medication. | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | ΣC | 0..1 | code | Unit for total volume | ||||
ingredient | 1..* | 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 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation Binding: SNOMEDCTMedicationCodes (example) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
strength[x] | 0..1 | Quantity of ingredient present Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||||||
strengthRatio | Ratio | |||||||
strengthCodeableConcept | CodeableConcept | |||||||
strengthQuantity | Quantity | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Medication.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Medication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
qty-3 | error | Medication.totalVolume | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | Medication.totalVolume | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Medication
Differential View
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Medication | Medication | |||
meta | ||||
versionId | 0..1 | id | Version specific identifier Example versionId: 1 | |
identifier | 0..1 | Identifier | Prescription number | |
code | 0..0 | |||
status | 0..0 | |||
marketingAuthorizationHolder | 0..0 | |||
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |
totalVolume | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 1..1 | decimal | Total volume of medication. | |
unit | 0..0 | |||
code | 0..1 | code | Unit for total volume | |
ingredient | 1..* | BackboneElement | Active or inactive ingredient | |
item | 1..1 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation | |
concept | ||||
text | 1..1 | string | Plain text representation of the concept | |
batch | 0..0 | |||
definition | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
identifier | Σ | 0..1 | Identifier | Prescription number |
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |
totalVolume | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
value | Σ | 1..1 | decimal | Total volume of medication. |
code | ΣC | 0..1 | code | Unit for total volume |
ingredient | 1..* | BackboneElement | Active or inactive ingredient | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item | 1..1 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation Binding: SNOMEDCTMedicationCodes (example) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
qty-3 | error | Medication.totalVolume | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | Medication.totalVolume | The comparator is not used on a SimpleQuantity : comparator.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Medication | 0..* | Medication | Definition of a Medication | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier Example versionId: 1 | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Prescription number | ||||
doseForm | 1..1 | CodeableConcept | Dose form of the medication. E.g powder, tablet, ointment etc. Binding: Ravimvormid (preferred) | |||||
totalVolume | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 1..1 | decimal | Total volume of medication. | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | ΣC | 0..1 | code | Unit for total volume | ||||
ingredient | 1..* | 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 | CodeableReference(Substance | Medication) | List of ingredients in precise amounts for medication preparation Binding: SNOMEDCTMedicationCodes (example) | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||
strength[x] | 0..1 | Quantity of ingredient present Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient. | ||||||
strengthRatio | Ratio | |||||||
strengthCodeableConcept | CodeableConcept | |||||||
strengthQuantity | Quantity | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Medication.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Medication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Medication.doseForm | preferred | Ravimvormid_VS (a valid code from Ravimvorm)https://fhir.ee/ValueSet/ravimvormid from this IG | |
Medication.ingredient.item | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.ingredient.strength[x] | preferred | MedicationIngredientStrengthCodeshttp://hl7.org/fhir/ValueSet/medication-ingredientstrength from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
qty-3 | error | Medication.totalVolume | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | Medication.totalVolume | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Medication
Other representations of profile: CSV, Excel, Schematron