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-dispensed-to-patient | Version: 1.0.0 | |||
Draft as of 2024-02-14 | Computable Name: EETISMedicationDispensedToPatient |
Väljamüüdud ravim. Medication resource as it is presented today in Estonian e-Prescription center (Retseptikeskus). Used on prescriptions and dispensations.
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |
identifier | 0..1 | Identifier | Package code when medication is prescribed based on specific package | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend | |
code | 0..0 | |||
status | 0..0 | |||
marketingAuthorizationHolder | 0..0 | |||
Documentation for this format |
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..1 | Identifier | Package code when medication is prescribed based on specific package |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 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() |
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Package code when medication is prescribed based on specific package | ||||
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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend | ||||
value | ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
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 | CodeableReference(Substance | Medication) | The ingredient (substance or medication) that the ingredient.strength relates to Binding: SNOMEDCTMedicationCodes (example) | |||||
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 | |||||||
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 | |||||
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.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
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() |
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |
identifier | 0..1 | Identifier | Package code when medication is prescribed based on specific package | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend | |
code | 0..0 | |||
status | 0..0 | |||
marketingAuthorizationHolder | 0..0 | |||
Documentation for this format |
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..1 | Identifier | Package code when medication is prescribed based on specific package |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 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() |
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
name | 0..1 | string | Registered name for the medicinal product. URL: https://fhir.ee/StructureDefinition/ee-tis-medicinal-product-name | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Package code when medication is prescribed based on specific package | ||||
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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.ee/CodeSystem/tis-fhir-identifikaatorid/ravimiregister-pakend | ||||
value | ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
doseForm | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
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 | CodeableReference(Substance | Medication) | The ingredient (substance or medication) that the ingredient.strength relates to Binding: SNOMEDCTMedicationCodes (example) | |||||
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 | |||||||
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 | |||||
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.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Medication.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Medication.doseForm | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codes from the FHIR Standard | |
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() |
This structure is derived from Medication
Other representations of profile: CSV, Excel, Schematron