UKCoreMedication (Medication) | C | | Medication | There are no (further) constraints on this element Element idMedication Short descriptionDefinition of a Medication DefinitionThis resource 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.
Data typeMedication Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() Mappings- rim: Entity. Role, or Act
- script10.6: NewRx/MedicationPrescribed
-or-
RxFill/MedicationDispensed
-or-
RxHistoryResponse/MedicationDispensed
-or-
RxHistoryResponse/MedicationPrescribed
- rim: ManufacturedProduct[classCode=ADMM]
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedication.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedication.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedication.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedication.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idMedication.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idMedication.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idMedication.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
MedicationTradeFamily | C | 0..1 | Extension(CodeableConcept) | Element idMedication.extension:MedicationTradeFamily Short descriptionA Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM) Alternate namesextensions, user content DefinitionA Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMedication.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idMedication.identifier Short descriptionBusiness identifier for this medication DefinitionBusiness identifier for this medication.
CommentsThe serial number could be included as an identifier.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- rim: .id
|
code | S Σ | 1..1 | CodeableConceptBinding | Element idMedication.code Short descriptionCodes that identify this medication DefinitionA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
CommentsDepending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).
Data typeCodeableConcept BindingA coded concept that defines the type of a medication.
UKCoreMedicationCode (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode
coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier
coding.display = //element(*,MedicationType)/DrugDescription
- w5: FiveWs.class
- v2: RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code
- rim: .code
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedication.status Short descriptionactive | inactive | entered-in-error DefinitionA code to indicate if the medication is in active use.
CommentsThis status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.
Data typecode BindingA coded concept defining if the medication is in active use.
Medication Status Codes (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
manufacturer | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idMedication.manufacturer Short descriptionManufacturer of the item DefinitionDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: no mapping
- w5: FiveWs.actor
- v2: RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name
- rim: .player.scopingRole[typeCode=MANU].scoper
|
form | | 0..1 | CodeableConceptBinding | Element idMedication.form Short descriptionpowder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule.
CommentsWhen Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.
Data typeCodeableConcept BindingA coded concept defining the form of a medication.
UKCoreMedicationForm (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: coding.code = //element(*,DrugCodedType)/FormCode
coding.system = //element(*,DrugCodedType)/FormSourceCode
- v2: RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form
- rim: .formCode
|
amount | Σ | 0..1 | Ratio | There are no (further) constraints on this element Element idMedication.amount Short descriptionAmount of drug in package DefinitionSpecific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
Data typeRatio Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
ingredient | | 0..* | BackboneElement | There are no (further) constraints on this element Element idMedication.ingredient Short descriptionActive or inactive ingredient DefinitionIdentifies a particular constituent of interest in the product.
CommentsThe ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .scopesRole[typeCode=INGR]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idMedication.ingredient.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedication.ingredient.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMedication.ingredient.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
item[x] | | 1..1 | | There are no (further) constraints on this element Element idMedication.ingredient.item[x] Short descriptionThe actual ingredient or content DefinitionThe actual ingredient - either a substance (simple ingredient) or another medication of a medication.
RequirementsThe ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode
coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier
coding.display = //element(*,MedicationType)/DrugDescription
- v2: RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code
- rim: .player
|
itemCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
itemReference | | | Reference(Substance | Medication) | There are no (further) constraints on this element Data typeReference(Substance | Medication) |
isActive | | 0..1 | boolean | There are no (further) constraints on this element Element idMedication.ingredient.isActive Short descriptionActive ingredient indicator DefinitionIndication of whether this ingredient affects the therapeutic action of the drug.
RequirementsTrue indicates that the ingredient affects the therapeutic action of the drug (i.e. active).
False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
strength | | 0..1 | Ratio | There are no (further) constraints on this element Element idMedication.ingredient.strength Short descriptionQuantity of ingredient present DefinitionSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
Data typeRatio Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: //element(*,DrugCodedType)/Strength
- v2: RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units
- rim: .quantity
|
batch | | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMedication.batch Short descriptionDetails about packaged medications DefinitionInformation that only applies to packages (not products).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: no mapping
- rim: .player[classCode=CONT]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idMedication.batch.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedication.batch.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMedication.batch.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
lotNumber | | 0..1 | string | There are no (further) constraints on this element Element idMedication.batch.lotNumber Short descriptionIdentifier assigned to batch DefinitionThe assigned lot number of a batch of the specified product.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: no mapping
- v2: RXA-15 Substance Lot Number / RXG-19 Substance Lot Number
- rim: .id
|
expirationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element idMedication.batch.expirationDate Short descriptionWhen batch will expire DefinitionWhen this specific batch of product will expire.
Data typedateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- script10.6: no mapping
- v2: RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date
- rim: participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
|