{
"description": "Profile of Medication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.",
"_filename": "StructureDefinition-qicore-medication.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2018-08-22T00:00:00+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CQI WG",
"fhirVersion": "3.0.1",
"name": "QICore-Medication",
"mapping": [ {
"uri": "http://www.hl7.org/implement/standards/product_brief.cfm?product_id=378",
"name": "Quality Improvement Domain Analysis Model",
"identity": "qidam"
}, {
"uri": "http://unknown.org/Argonaut DQ DSTU2",
"name": "Argonaut DQ DSTU2",
"identity": "argonaut-dq-dstu2"
}, {
"uri": "http://ncpdp.org/SCRIPT10_6",
"name": "Mapping to NCPDP SCRIPT 10.6",
"identity": "script10.6"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Medication",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "3.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Medication",
"min": 0,
"definition": "The US Core Medication Profile is based upon the core FHIR Medication Resource and created to meet the 2015 Edition Common Clinical Data Set 'Medications' requirements.",
"short": "US Core Medication Profile",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed",
"identity": "script10.6"
}, {
"map": "ManufacturedProduct[classCode=ADMM]",
"identity": "rim"
}, {
"map": "clinical.medication",
"identity": "w5"
}, {
"map": "Medication",
"identity": "argonaut-dq-dstu2"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication",
"base": {
"max": "*",
"min": 0,
"path": "Medication"
}
}, {
"path": "Medication.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Medication.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Medication.meta",
"min": 0,
"definition": "The 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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Medication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Medication.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Medication.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Medication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Medication.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Medication.text",
"min": 0,
"definition": "A 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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Medication.text",
"condition": [ "dom-1" ],
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Medication.contained",
"min": 0,
"definition": "These 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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Medication.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Medication.extension",
"min": 0,
"definition": "May 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Medication.modifierExtension",
"min": 0,
"definition": "May 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Medication.code",
"min": 1,
"definition": "A 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.",
"short": "Codes that identify this medication",
"mapping": [ {
"map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
}, {
"map": "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",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
}, {
"map": "Medication.code",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "preferred",
"description": "The set of RxNorm codes to represent medications",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes"
}
},
"max": "1",
"id": "Medication.code",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.code"
},
"isSummary": true
}, {
"path": "Medication.status",
"min": 0,
"definition": "A code to indicate if the medication is in active use.",
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatus"
} ],
"description": "A coded concept defining if the medication is in active use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-status"
}
},
"max": "1",
"id": "Medication.status",
"comment": "This status is not intended to specify if a medication is part of a formulary.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.status"
},
"isSummary": true
}, {
"path": "Medication.isBrand",
"min": 0,
"definition": "Set to true if the item is attributable to a specific manufacturer.",
"short": "True if a brand",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "true if .player.scopingRole[typeCode=MANU] exists",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Medication.isBrand",
"base": {
"max": "1",
"min": 0,
"path": "Medication.isBrand"
},
"isSummary": true
}, {
"path": "Medication.isOverTheCounter",
"min": 0,
"definition": "Set to true if the medication can be obtained without an order from a prescriber.",
"short": "True if medication does not require a prescription",
"mapping": [ {
"map": "NA",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Medication.isOverTheCounter",
"base": {
"max": "1",
"min": 0,
"path": "Medication.isOverTheCounter"
},
"isSummary": true
}, {
"path": "Medication.manufacturer",
"min": 0,
"definition": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"short": "Manufacturer of the item",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name",
"identity": "v2"
}, {
"map": ".player.scopingRole[typeCode=MANU].scoper",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.manufacturer",
"base": {
"max": "1",
"min": 0,
"path": "Medication.manufacturer"
},
"isSummary": true
}, {
"path": "Medication.form",
"min": 0,
"definition": "Describes the form of the item. Powder; tablets; capsule.",
"short": "powder | tablets | capsule +",
"mapping": [ {
"map": "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode",
"identity": "script10.6"
}, {
"map": "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",
"identity": "v2"
}, {
"map": ".formCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "This value set includes all dose form codes from SNOMED CT - provided as an exemplar.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-form-codes"
}
},
"max": "1",
"id": "Medication.form",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.form"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Medication.ingredient",
"min": 0,
"definition": "Identifies a particular constituent of interest in the product.",
"short": "Active or inactive ingredient",
"mapping": [ {
"map": ".scopesRole[typeCode=INGR]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.ingredient",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Medication.ingredient"
}
}, {
"path": "Medication.ingredient.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Medication.ingredient.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.ingredient.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.ingredient.modifierExtension",
"min": 0,
"definition": "May 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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.ingredient.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Medication.ingredient.itemReference",
"min": 1,
"definition": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"short": "The product contained",
"mapping": [ {
"map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
}, {
"map": "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",
"identity": "v2"
}, {
"map": ".player",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-substance"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.ingredient.itemReference",
"base": {
"max": "1",
"min": 1,
"path": "Medication.ingredient.item[x]"
}
}, {
"path": "Medication.ingredient.isActive",
"requirements": "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min": 0,
"definition": "Indication of whether this ingredient affects the therapeutic action of the drug.",
"short": "Active ingredient indicator",
"mapping": [ {
"map": "NA",
"identity": "rim"
}, {
"map": "Not in QIDAM, but added because it was determined to be important for drug-allergy checking. For example, if the patient is allergic to Depakote\n(a trade name, and includes blue dye as an inactive ingredient), then when patient is prescribed warfarin, it shoots out a drug-allergy alert because warfarin also contains blue dye. Providers hate this. We recently overcame this problem by having the drug-allergy alert interaction settings only check for allergies to active ingredients.",
"identity": "qidam"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.ingredient.isActive",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.isActive"
}
}, {
"path": "Medication.ingredient.amount",
"min": 0,
"definition": "Specifies 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.",
"short": "Quantity of ingredient present",
"mapping": [ {
"map": "//element(*,DrugCodedType)/Strength",
"identity": "script10.6"
}, {
"map": "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",
"identity": "v2"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Ratio"
} ],
"max": "1",
"id": "Medication.ingredient.amount",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.amount"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Medication.package",
"min": 0,
"definition": "Information that only applies to packages (not products).",
"short": "Details about packaged medications",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".player[classCode=CONT]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.package",
"base": {
"max": "1",
"min": 0,
"path": "Medication.package"
}
}, {
"path": "Medication.package.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.package.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Medication.package.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.package.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.package.modifierExtension",
"min": 0,
"definition": "May 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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.package.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Medication.package.container",
"min": 0,
"definition": "The kind of container that this package comes as.",
"short": "E.g. box, vial, blister-pack",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationContainer"
} ],
"description": "A coded concept defining the kind of container a medication package is packaged in",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-package-form"
}
},
"max": "1",
"id": "Medication.package.container",
"base": {
"max": "1",
"min": 0,
"path": "Medication.package.container"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Medication.package.content",
"min": 0,
"definition": "A set of components that go to make up the described item.",
"short": "What is in the package",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".scopesRole[typeCode=CONT]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.package.content",
"base": {
"max": "*",
"min": 0,
"path": "Medication.package.content"
}
}, {
"path": "Medication.package.content.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.package.content.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Medication.package.content.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.package.content.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.package.content.modifierExtension",
"min": 0,
"definition": "May 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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.package.content.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Medication.package.content.itemReference",
"min": 1,
"definition": "Identifies one of the items in the package.",
"short": "The item in the package",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".player",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.package.content.itemReference",
"base": {
"max": "1",
"min": 1,
"path": "Medication.package.content.item[x]"
}
}, {
"path": "Medication.package.content.amount",
"min": 0,
"definition": "The amount of the product that is in the package.",
"short": "Quantity present in the package",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Medication.package.content.amount",
"base": {
"max": "1",
"min": 0,
"path": "Medication.package.content.amount"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Medication.package.batch",
"min": 0,
"definition": "Information about a group of medication produced or packaged from one production run.",
"short": "Identifies a single production run",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Medication.package.batch",
"base": {
"max": "*",
"min": 0,
"path": "Medication.package.batch"
}
}, {
"path": "Medication.package.batch.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.package.batch.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Medication.package.batch.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.package.batch.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Medication.package.batch.modifierExtension",
"min": 0,
"definition": "May 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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.package.batch.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Medication.package.batch.lotNumber",
"min": 0,
"definition": "The assigned lot number of a batch of the specified product.",
"short": "Identifier assigned to batch",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Medication.package.batch.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Medication.package.batch.lotNumber"
}
}, {
"path": "Medication.package.batch.expirationDate",
"min": 0,
"definition": "When this specific batch of product will expire.",
"short": "When batch will expire",
"mapping": [ {
"map": "no mapping",
"identity": "script10.6"
}, {
"map": "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date",
"identity": "v2"
}, {
"map": "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Medication.package.batch.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Medication.package.batch.expirationDate"
}
}, {
"path": "Medication.image",
"requirements": "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).",
"min": 0,
"definition": "Photo(s) or graphic representation(s) of the medication.",
"short": "Picture of the medication",
"mapping": [ {
"map": ".participation[typeCode=SUBJ].role[classCode=MANU],source[classCode=OBS,moodCode=EVN,code=\"type of image\"].value(ED.image)",
"identity": "rim"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "Medication.image",
"base": {
"max": "*",
"min": 0,
"path": "Medication.image"
}
} ]
},
"status": "draft",
"id": "d8184c01-ac48-4ce3-bca7-4106bf2ff695",
"kind": "resource",
"url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication",
"version": "3.1.0",
"differential": {
"element": [ {
"id": "Medication",
"path": "Medication",
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.code",
"max": "1",
"min": 1,
"path": "Medication.code",
"binding": {
"strength": "preferred",
"description": "The set of RxNorm codes to represent medications",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/core/ValueSet/us-core-medication-codes"
}
},
"isModifier": false,
"mustSupport": true
}, {
"id": "Medication.manufacturer",
"path": "Medication.manufacturer",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.form",
"path": "Medication.form",
"binding": {
"strength": "example",
"description": "This value set includes all dose form codes from SNOMED CT - provided as an exemplar.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-form-codes"
}
},
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.ingredient",
"path": "Medication.ingredient",
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.ingredient.itemReference",
"path": "Medication.ingredient.itemReference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-substance"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.ingredient.isActive",
"max": "1",
"min": 0,
"path": "Medication.ingredient.isActive",
"type": [ {
"code": "boolean"
} ],
"mapping": [ {
"map": "Not in QIDAM, but added because it was determined to be important for drug-allergy checking. For example, if the patient is allergic to Depakote\n(a trade name, and includes blue dye as an inactive ingredient), then when patient is prescribed warfarin, it shoots out a drug-allergy alert because warfarin also contains blue dye. Providers hate this. We recently overcame this problem by having the drug-allergy alert interaction settings only check for allergies to active ingredients.",
"identity": "qidam"
} ],
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.package",
"path": "Medication.package",
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.package.content",
"path": "Medication.package.content",
"isModifier": false,
"mustSupport": false
}, {
"id": "Medication.package.content.itemReference",
"path": "Medication.package.content.itemReference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication"
} ],
"isModifier": false,
"mustSupport": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
}