{
"description": "This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"_filename": "StructureDefinition-Medication.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-12-18T07:07:42+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-12-18T07:07:42.170+11:00"
},
"publisher": "HL7 International / Pharmacy",
"fhirVersion": "6.0.0-ballot4",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "Medication",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://ncpdp.org/SCRIPT10_6",
"name": "Mapping to NCPDP SCRIPT 10.6",
"identity": "script10.6"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Medication",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Medications"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "phx"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Medication",
"min": 0,
"definition": "This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"isModifier": false,
"short": "Definition of a Medication",
"mapping": [ {
"map": "Entity, Role, or Act,ManufacturedProduct[classCode=ADMM]",
"identity": "rim"
}, {
"map": "clinical.medication",
"identity": "w5"
}, {
"map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed",
"identity": "script10.6"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication",
"base": {
"max": "*",
"min": 0,
"path": "Medication"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.meta",
"min": 0,
"definition": "The 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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.text",
"min": 0,
"definition": "A 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Medication.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a 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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Medication.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.modifierExtension",
"requirements": "Modifier 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](extensibility.html#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 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.identifier",
"min": 0,
"definition": "Business identifier for this medication.",
"isModifier": false,
"short": "Business identifier for this medication",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.identifier",
"comment": "The serial number could be included as an identifier.",
"base": {
"max": "*",
"min": 0,
"path": "Medication.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.code",
"min": 0,
"definition": "A code (or set of codes) that specify this medication, or a textual description. 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. The name of the medication can be conveyed in the code.text even if it is different from any of the coding displayName values.",
"isModifier": false,
"short": "Codes that identify this medication",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"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": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationFormalRepresentation"
} ],
"description": "A coded concept that defines the type of a medication."
},
"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. 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).",
"base": {
"max": "1",
"min": 0,
"path": "Medication.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.status",
"min": 0,
"definition": "A code to indicate if the medication is in active use.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatus"
} ],
"description": "A coded concept defining if the medication is in active use."
},
"max": "1",
"id": "Medication.status",
"comment": "This 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.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.status"
},
"isModifierReason": "This element changes the interpretation of all descriptive attributes.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.marketingAuthorizationHolder",
"min": 0,
"definition": "The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).",
"isModifier": false,
"short": "Organization that has authorization to market medication",
"mapping": [ {
"map": ".player.scopingRole[typeCode=MANU].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.marketingAuthorizationHolder",
"base": {
"max": "1",
"min": 0,
"path": "Medication.marketingAuthorizationHolder"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.doseForm",
"min": 0,
"definition": "Describes the form of the item. Powder; tablets; capsule.",
"isModifier": false,
"short": "powder | tablets | capsule +",
"mapping": [ {
"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"
}, {
"map": "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-form-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationForm"
} ],
"description": "A coded concept defining the form of a medication."
},
"max": "1",
"id": "Medication.doseForm",
"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.doseForm"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "med-1",
"human": "Either numberOfItems or amountPerItem must exist",
"source": "http://hl7.org/fhir/StructureDefinition/Medication",
"severity": "error",
"expression": "numberOfItems.exists() or amountPerItem.exists()"
} ],
"path": "Medication.packageSize",
"min": 0,
"definition": "When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package.",
"isModifier": false,
"short": "When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package",
"mapping": [ {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize",
"comment": "To represent a medication that has 5 vials with 10ml in each vial and the medication code just represents a vial, then the number of Items would be '5 vial' and the amountPerItem would be '10ml/vial'. To represent a medication where there are 300 tablets and the code is for 100mg tablets, the number of items would be '300 tablets'",
"base": {
"max": "1",
"min": 0,
"path": "Medication.packageSize"
},
"isSummary": true
}, {
"path": "Medication.packageSize.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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.packageSize.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.packageSize.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.packageSize.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.packageSize.modifierExtension",
"requirements": "Modifier 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](extensibility.html#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 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.packageSize.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.packageSize.numberOfItems",
"min": 0,
"definition": "The number of items in the package that are represented by the code, e.g. 5 vials or 100 tablets.",
"isModifier": false,
"short": "The number of items in the package that are represented by the code",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize.numberOfItems",
"base": {
"max": "1",
"min": 0,
"path": "Medication.packageSize.numberOfItems"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.packageSize.amountPerItem",
"min": 0,
"definition": "The amount per each item, e.g. 10 ml / vial.",
"isModifier": false,
"short": "The amount per each item",
"type": [ {
"code": "Ratio"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize.amountPerItem",
"base": {
"max": "1",
"min": 0,
"path": "Medication.packageSize.amountPerItem"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient",
"min": 0,
"definition": "Identifies a particular constituent of interest in the product.",
"isModifier": false,
"short": "Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications",
"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. If Medication.code represents a fully specified product (the product + the strength + the dosage form) then including ingredients is duplicative. However, there may be implementation considerations which dictate including ingredients when Medication.code is a fully specified product. For compounded products, active and inactive ingredients should be included. However, even with all ingredients specified, a Medication resource should not be considered a \"recipe\" as the sequence and techniques for preparing the final product cannot be included.",
"base": {
"max": "*",
"min": 0,
"path": "Medication.ingredient"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.ingredient.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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. To make the use of extensions safe and managable, 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.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient.modifierExtension",
"requirements": "Modifier 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](extensibility.html#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 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient.item",
"min": 1,
"definition": "The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).",
"isModifier": false,
"short": "The specific substance or medication that is the ingredient",
"mapping": [ {
"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"
}, {
"map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Substance", "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition", "http://hl7.org/fhir/StructureDefinition/Medication" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationFormalRepresentation"
} ]
},
"max": "1",
"id": "Medication.ingredient.item",
"comment": "The ingredient may reference a medication substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). A referenced medication may be fully specified (amoxicillin 250 mg capsule), partially specified (amoxicillin 250mg), or may refer to an abstract ingredient (e.g., amoxicillin).",
"base": {
"max": "1",
"min": 1,
"path": "Medication.ingredient.item"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Active ingredient indicator",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.ingredient.isActive",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.isActive"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient.role",
"requirements": "This can be used in combination with the isActive element to provide further information about the type of ingredient.",
"min": 0,
"definition": "Indication of whether this ingredient affects the therapeutic action of the drug.",
"isModifier": false,
"short": "A code that defines the type of ingredient, active, base, etc.",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationIngredientRole"
} ]
},
"max": "1",
"id": "Medication.ingredient.role",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.ingredient.strength[x]",
"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 but can also be expressed a quantity when the denominator is assumed to be 1 tablet.",
"isModifier": false,
"short": "Quantity of ingredient present",
"mapping": [ {
"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"
}, {
"map": "//element(*,DrugCodedType)/Strength",
"identity": "script10.6"
} ],
"type": [ {
"code": "Ratio"
}, {
"code": "CodeableConcept"
}, {
"code": "Quantity"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-ingredientstrength",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationIngredientStrength"
} ],
"description": "A coded concpet defining the strength of an ingredient."
},
"max": "1",
"id": "Medication.ingredient.strength[x]",
"comment": "Medication.ingredient.strength.denominator can cause some confusion. For example, the concentration of a pediatric acetaminophen suspension can be '32 mg / 1 ml' or '160 mg / 5 ml'. Both strengths are the same (32 mg * 5 = 160 mg). In clinical systems (drug databases) strengths are usually to unit volumes (32 mg / 1 ml). While on a consumer product it's preferred to say how much per 'typical' dose (160 mg / 5 ml, with 5 ml (1 tsp) being the typical dose). Both representations are valid. Best practice is to select the denominator most relevant to the situation and use that same denominator for all ingredients. Ingredient.strength is problematic for multi-ingredient ingredients. For example, antacid products often contain multiple ingredients, such as 'aluminum & magnesium hydroxide with simethicone 400-400-40 mg/5ml'. Expressing a 'final concentration' in these cases is intractable and the best option is to not include ingredient.strength.",
"base": {
"max": "1",
"min": 0,
"path": "Medication.ingredient.strength[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance",
"min": 0,
"definition": "Information that only applies to packages (not products).",
"isModifier": false,
"short": "Details about packaged medications",
"mapping": [ {
"map": ".player[classCode=CONT]",
"identity": "rim"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance",
"base": {
"max": "1",
"min": 0,
"path": "Medication.instance"
},
"isSummary": false
}, {
"path": "Medication.instance.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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Medication.instance.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Medication.instance.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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance.modifierExtension",
"requirements": "Modifier 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](extensibility.html#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 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Medication.instance.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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance.identifier",
"min": 0,
"definition": "Identifier for the physical instance, typically a serial number.",
"isModifier": false,
"short": "Identifier for the physical instance, typically a serial number",
"mapping": [ {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.instance.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Medication.instance.identifier"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance.lotNumber",
"min": 0,
"definition": "The assigned lot number of a batch of the specified product.",
"isModifier": false,
"short": "Identifier assigned to batch",
"mapping": [ {
"map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Medication.instance.lotNumber"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.instance.expirationDate",
"min": 0,
"definition": "When this specific instance of product will expire.",
"isModifier": false,
"short": "When instance will expire",
"mapping": [ {
"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"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Medication.instance.expirationDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Medication.definition",
"min": 0,
"definition": "A reference to a definitional resource that provides more information about this medication.",
"isModifier": false,
"short": "Formal definition of the medication",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition", "http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition", "http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition", "http://hl7.org/fhir/StructureDefinition/ManufacturedItemDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.definition",
"base": {
"max": "1",
"min": 0,
"path": "Medication.definition"
},
"isSummary": false
} ]
},
"status": "active",
"id": "755b9d7d-67fe-4b6b-a427-04d0a01df915",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Medication",
"version": "6.0.0-ballot4",
"differential": {
"element": [ {
"path": "Medication",
"min": 0,
"definition": "This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"isModifier": false,
"short": "Definition of a Medication",
"mapping": [ {
"map": "clinical.medication",
"identity": "w5"
}, {
"map": "ManufacturedProduct[classCode=ADMM]",
"identity": "rim"
}, {
"map": "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed",
"identity": "script10.6"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication"
}, {
"path": "Medication.identifier",
"min": 0,
"definition": "Business identifier for this medication.",
"isModifier": false,
"short": "Business identifier for this medication",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.identifier",
"comment": "The serial number could be included as an identifier.",
"isSummary": true
}, {
"path": "Medication.code",
"min": 0,
"definition": "A code (or set of codes) that specify this medication, or a textual description. 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. The name of the medication can be conveyed in the code.text even if it is different from any of the coding displayName values.",
"isModifier": false,
"short": "Codes that identify this medication",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"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": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationFormalRepresentation"
} ],
"description": "A coded concept that defines the type of a medication."
},
"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. 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).",
"isSummary": true
}, {
"path": "Medication.status",
"min": 0,
"definition": "A code to indicate if the medication is in active use.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationStatus"
} ],
"description": "A coded concept defining if the medication is in active use."
},
"max": "1",
"id": "Medication.status",
"comment": "This 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.",
"isModifierReason": "This element changes the interpretation of all descriptive attributes.",
"isSummary": true
}, {
"path": "Medication.marketingAuthorizationHolder",
"min": 0,
"definition": "The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).",
"isModifier": false,
"short": "Organization that has authorization to market medication",
"mapping": [ {
"map": ".player.scopingRole[typeCode=MANU].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.marketingAuthorizationHolder",
"isSummary": true
}, {
"path": "Medication.doseForm",
"min": 0,
"definition": "Describes the form of the item. Powder; tablets; capsule.",
"isModifier": false,
"short": "powder | tablets | capsule +",
"mapping": [ {
"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"
}, {
"map": "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-form-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationForm"
} ],
"description": "A coded concept defining the form of a medication."
},
"max": "1",
"id": "Medication.doseForm",
"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.",
"isSummary": false
}, {
"constraint": [ {
"key": "med-1",
"human": "Either numberOfItems or amountPerItem must exist",
"source": "http://hl7.org/fhir/StructureDefinition/Medication",
"severity": "error",
"expression": "numberOfItems.exists() or amountPerItem.exists()"
} ],
"path": "Medication.packageSize",
"min": 0,
"definition": "When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package.",
"isModifier": false,
"short": "When the code does not specify the package size, this backbone element can be used to specify the overall amount of medication in the package",
"mapping": [ {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize",
"comment": "To represent a medication that has 5 vials with 10ml in each vial and the medication code just represents a vial, then the number of Items would be '5 vial' and the amountPerItem would be '10ml/vial'. To represent a medication where there are 300 tablets and the code is for 100mg tablets, the number of items would be '300 tablets'",
"isSummary": true
}, {
"path": "Medication.packageSize.numberOfItems",
"min": 0,
"definition": "The number of items in the package that are represented by the code, e.g. 5 vials or 100 tablets.",
"isModifier": false,
"short": "The number of items in the package that are represented by the code",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize.numberOfItems",
"isSummary": false
}, {
"path": "Medication.packageSize.amountPerItem",
"min": 0,
"definition": "The amount per each item, e.g. 10 ml / vial.",
"isModifier": false,
"short": "The amount per each item",
"type": [ {
"code": "Ratio"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.packageSize.amountPerItem",
"isSummary": false
}, {
"path": "Medication.ingredient",
"min": 0,
"definition": "Identifies a particular constituent of interest in the product.",
"isModifier": false,
"short": "Components of a medication. These can be ingredient substances or other medications, in the case of combination packaged medications",
"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. If Medication.code represents a fully specified product (the product + the strength + the dosage form) then including ingredients is duplicative. However, there may be implementation considerations which dictate including ingredients when Medication.code is a fully specified product. For compounded products, active and inactive ingredients should be included. However, even with all ingredients specified, a Medication resource should not be considered a \"recipe\" as the sequence and techniques for preparing the final product cannot be included.",
"isSummary": false
}, {
"path": "Medication.ingredient.item",
"min": 1,
"definition": "The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).",
"isModifier": false,
"short": "The specific substance or medication that is the ingredient",
"mapping": [ {
"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"
}, {
"map": "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription",
"identity": "script10.6"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Substance", "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition", "http://hl7.org/fhir/StructureDefinition/Medication" ]
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationFormalRepresentation"
} ]
},
"max": "1",
"id": "Medication.ingredient.item",
"comment": "The ingredient may reference a medication substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). A referenced medication may be fully specified (amoxicillin 250 mg capsule), partially specified (amoxicillin 250mg), or may refer to an abstract ingredient (e.g., amoxicillin).",
"isSummary": false
}, {
"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.",
"isModifier": false,
"short": "Active ingredient indicator",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.ingredient.isActive",
"isSummary": false
}, {
"path": "Medication.ingredient.role",
"requirements": "This can be used in combination with the isActive element to provide further information about the type of ingredient.",
"min": 0,
"definition": "Indication of whether this ingredient affects the therapeutic action of the drug.",
"isModifier": false,
"short": "A code that defines the type of ingredient, active, base, etc.",
"mapping": [ {
"map": "NA",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationIngredientRole"
} ]
},
"max": "1",
"id": "Medication.ingredient.role",
"isSummary": false
}, {
"path": "Medication.ingredient.strength[x]",
"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 but can also be expressed a quantity when the denominator is assumed to be 1 tablet.",
"isModifier": false,
"short": "Quantity of ingredient present",
"mapping": [ {
"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"
}, {
"map": "//element(*,DrugCodedType)/Strength",
"identity": "script10.6"
} ],
"type": [ {
"code": "Ratio"
}, {
"code": "CodeableConcept"
}, {
"code": "Quantity"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-ingredientstrength",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationIngredientStrength"
} ],
"description": "A coded concpet defining the strength of an ingredient."
},
"max": "1",
"id": "Medication.ingredient.strength[x]",
"comment": "Medication.ingredient.strength.denominator can cause some confusion. For example, the concentration of a pediatric acetaminophen suspension can be '32 mg / 1 ml' or '160 mg / 5 ml'. Both strengths are the same (32 mg * 5 = 160 mg). In clinical systems (drug databases) strengths are usually to unit volumes (32 mg / 1 ml). While on a consumer product it's preferred to say how much per 'typical' dose (160 mg / 5 ml, with 5 ml (1 tsp) being the typical dose). Both representations are valid. Best practice is to select the denominator most relevant to the situation and use that same denominator for all ingredients. Ingredient.strength is problematic for multi-ingredient ingredients. For example, antacid products often contain multiple ingredients, such as 'aluminum & magnesium hydroxide with simethicone 400-400-40 mg/5ml'. Expressing a 'final concentration' in these cases is intractable and the best option is to not include ingredient.strength.",
"isSummary": false
}, {
"path": "Medication.instance",
"min": 0,
"definition": "Information that only applies to packages (not products).",
"isModifier": false,
"short": "Details about packaged medications",
"mapping": [ {
"map": ".player[classCode=CONT]",
"identity": "rim"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance",
"isSummary": false
}, {
"path": "Medication.instance.identifier",
"min": 0,
"definition": "Identifier for the physical instance, typically a serial number.",
"isModifier": false,
"short": "Identifier for the physical instance, typically a serial number",
"mapping": [ {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "Medication.instance.identifier",
"isSummary": false
}, {
"path": "Medication.instance.lotNumber",
"min": 0,
"definition": "The assigned lot number of a batch of the specified product.",
"isModifier": false,
"short": "Identifier assigned to batch",
"mapping": [ {
"map": "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance.lotNumber",
"isSummary": false
}, {
"path": "Medication.instance.expirationDate",
"min": 0,
"definition": "When this specific instance of product will expire.",
"isModifier": false,
"short": "When instance will expire",
"mapping": [ {
"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"
}, {
"map": "no mapping",
"identity": "script10.6"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.instance.expirationDate",
"isSummary": false
}, {
"path": "Medication.definition",
"min": 0,
"definition": "A reference to a definitional resource that provides more information about this medication.",
"isModifier": false,
"short": "Formal definition of the medication",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition", "http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition", "http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition", "http://hl7.org/fhir/StructureDefinition/ManufacturedItemDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "Medication.definition",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/medication",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}