Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication | Version: 2.3.0 | |||
| Active as of 2023-12-12 | Computable Name: UKCoreMedication | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
This profile defines the UK constraints and extensions on the International FHIR resource Medication.
This profile is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
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 |
0..* | Medication | Definition of a Medication | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |
  code |
S | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) |
 form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | |
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom this IG |
| 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().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() |
| 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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
| MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
 manufacturer |
Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| 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[x] |
1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| itemReference |
Reference(Substance | Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | Ratio | Quantity of ingredient present | |||||
 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom this IG |
| 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().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() |
This structure is derived from Medication
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |
| code |
S | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) |
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | |
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | |
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom this IG |
| 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().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() |
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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | |||||
| MedicationTradeFamily |
0..1 | CodeableConcept | Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily Binding: UK Core Medication Trade Family (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code |
SΣ | 1..1 | CodeableConcept | Codes that identify this medication Binding: UK Core Medication Code (preferred) | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| manufacturer |
Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: UK Core Medication Form (preferred) | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| 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[x] |
1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| itemReference |
Reference(Substance | Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | Ratio | Quantity of ingredient present | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Medication.code | preferred | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCodefrom this IG | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | preferred | UKCoreMedicationFormhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationFormfrom this IG |
| 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().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() |
This structure is derived from Medication
Other representations of profile: CSV, Excel, Schematron