| Medication | C | | http://hl7.org/fhir/StructureDefinition/DomainResource | Element idMedication Short descriptionDefinition of a Medication DefinitionThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
http://hl7.org/fhir/StructureDefinition/DomainResource Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
Mappings- rim: Entity. Role, or Act
- script10.6: NewRx/MedicationPrescribed
-or-
RxFill/MedicationDispensed
-or-
RxHistoryResponse/MedicationDispensed
-or-
RxHistoryResponse/MedicationPrescribed
- rim: ManufacturedProduct[classCode=ADMM]
- w5: clinical.medication
|
| id | Σ | 0..1 | id | 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.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
id |
| 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 may not always be associated with version changes to the resource.
Meta |
| 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.
Asserting 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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
uri |
| 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.
Language 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).
code BindingA human language. http://hl7.org/fhir/ValueSet/languages (extensible) Binding extensions |
| text | C | 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 may 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.
Contained 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 in formation is added later.
Narrative ConditionsThe cardinality or value of this element may be affected by these constraints: dom-1 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.
This 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.
Resource Mappings |
| extension | | 0..* | Extension | There are no (further) constraints on this element 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. In order 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.
There 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| modifierExtension | ?! | 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. Usually modifier elements provide negation or qualification. In order 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.
There 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| code | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element 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.
Depending 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.
CodeableConcept BindingA coded concept that defines the type of a medication http://hl7.org/fhir/ValueSet/medication-codes (example) Mappings- script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode
coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier
coding.display = //element(*,MedicationType)/DrugDescription
- 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
- w5: class
|
| 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.
This status is not intended to specify if a medication is part of a formulary.
code BindingA coded concept defining if the medication is in active use http://hl7.org/fhir/ValueSet/medication-status (required) Mappings |
| isBrand | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMedication.isBrand Short descriptionTrue if a brand DefinitionSet to true if the item is attributable to a specific manufacturer.
boolean Mappings- script10.6: no mapping
- rim: true if .player.scopingRole[typeCode=MANU] exists
- w5: class
|
| isOverTheCounter | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMedication.isOverTheCounter Short descriptionTrue if medication does not require a prescription DefinitionSet to true if the medication can be obtained without an order from a prescriber.
boolean Mappings |
| manufacturer | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/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.
Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings- script10.6: no mapping
- v2: RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name
- rim: .player.scopingRole[typeCode=MANU].scoper
- w5: who.actor
|
| form | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedication.form Short descriptionpowder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule.
When 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.
CodeableConcept BindingA coded concept defining the form of a medication http://hl7.org/fhir/ValueSet/medication-form-codes (example) 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
|
| 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.
The 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.
BackboneElement Mappings- rim: .scopesRole[typeCode=INGR]
|
| package | | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMedication.package Short descriptionDetails about packaged medications DefinitionInformation that only applies to packages (not products).
BackboneElement Mappings- script10.6: no mapping
- rim: .player[classCode=CONT]
|
| image | | 0..* | Attachment | There are no (further) constraints on this element Element idMedication.image Short descriptionPicture of the medication DefinitionPhoto(s) or graphic representation(s) of the medication.
Note that "image" is only applicable when the medication.code represents a physical item (e.g. Amoxil 250 mg capsule) and not an abstract item (e.g. amoxicillin 250 mg).
Attachment Mappings- rim: .participation[typeCode=SUBJ].role[classCode=MANU],source[classCode=OBS,moodCode=EVN,code="type of image"].value(ED.image)
|