2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
Profile for medication
<Profile xmlns="http://hl7.org/fhir"> <id value="Medication"/> <meta> <lastUpdated value="2015-02-23T09:07:27.665+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/Profile/Medication"/> <name value="Medication"/> <publisher value="HL7 FHIR Project (Pharmacy)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/medication/index.cfm"/> </telecom> </contact> <description value="Base Profile for Medication Resource"/> <status value="draft"/> <date value="2015-02-23T09:07:27+11:00"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <type value="Medication"/> <snapshot> <element> <path value="Medication"/> <short value="Definition of a Medication"/> <definition value="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."/> <min value="1"/> <max value="1"/> <mapping> <identity value="rim"/> <map value="ManufacturedProduct[classCode=ADMM]"/> </mapping> </element> <element> <path value="Medication.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="Medication.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="Medication.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="Medication.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <isExtensible value="false"/> <conformance value="required"/> <description value="A human language"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="Medication.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="Medication.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/> <comments value="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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.name"/> <short value="Common / Commercial name"/> <definition value="The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> </element> <element> <path value="Medication.code"/> <short value="Codes that identify this medication"/> <definition value="A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes."/> <comments value="When defining a medication, the code is the "identifying" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="MedicationFormalRepresentation"/> <isExtensible value="true"/> <conformance value="example"/> <description value="A code that defines the type of a medication"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-codes"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Medication.isBrand"/> <short value="True if a brand"/> <definition value="Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="true if .player.scopingRole[typeCode=MANU] exists"/> </mapping> </element> <element> <path value="Medication.manufacturer"/> <short value="Manufacturer of the item"/> <definition value="Describes the details of the manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.scopingRole[typeCode=MANU].scoper"/> </mapping> </element> <element> <path value="Medication.kind"/> <short value="product | package"/> <definition value="Medications are either a single administrable product or a package that contains one or more products."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="MedicationKind"/> <isExtensible value="false"/> <conformance value="required"/> <description value="Whether the medication is a product or a package"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-kind"/> </referenceReference> </binding> <mapping> <identity value="rim"/> <map value=".player.classCode (CONT or not)"/> </mapping> </element> <element> <path value="Medication.product"/> <short value="Administrable medication details"/> <definition value="Information that only applies to products (not packages)."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player [classCode != CONT]"/> </mapping> </element> <element> <path value="Medication.product.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.product.form"/> <short value="powder | tablets | carton +"/> <definition value="Describes the form of the item. Powder; tables; carton."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="MedicationForm"/> <isExtensible value="true"/> <conformance value="example"/> <description value="The form of a medication"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-form-codes"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value=".formCode"/> </mapping> </element> <element> <path value="Medication.product.ingredient"/> <short value="Active or inactive ingredient"/> <definition value="Identifies a particular constituent of interest in the product."/> <comments value="The ingredients need not be a complete list; usually only active ingredients are listed."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=INGR]"/> </mapping> </element> <element> <path value="Medication.product.ingredient.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.ingredient.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.ingredient.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.product.ingredient.item"/> <short value="The product contained"/> <definition value="The actual ingredient - either a substance (simple ingredient) or another medication."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Substance"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Medication"/> </type> <mapping> <identity value="v2"/> <map value="if substance: 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"/> </mapping> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> <element> <path value="Medication.product.ingredient.amount"/> <short value="How much ingredient in product"/> <definition value="Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <mapping> <identity value="v2"/> <map value="if substance: 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"/> </mapping> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> <element> <path value="Medication.product.batch"/> <short value="Information about a group of medication produced or packaged from one production run."/> <definition value="Information about a group of medication produced or packaged from one production run."/> <min value="0"/> <max value="*"/> </element> <element> <path value="Medication.product.batch.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.batch.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.product.batch.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.product.batch.lotNumber"/> <short value="The assigned lot number of a batch of the specified product."/> <definition value="The assigned lot number of a batch of the specified product."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="Medication.product.batch.expirationDate"/> <short value="When this specific batch of product will expire."/> <definition value="When this specific batch of product will expire."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element> <path value="Medication.package"/> <short value="Details about packaged medications"/> <definition value="Information that only applies to packages (not products)."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player[classCode=CONT]"/> </mapping> </element> <element> <path value="Medication.package.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.package.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.package.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.package.container"/> <short value="E.g. box, vial, blister-pack"/> <definition value="The kind of container that this package comes as."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="MedicationContainer"/> <isExtensible value="true"/> <conformance value="example"/> <description value="Kind of container a medication package is packaged in"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-package-form-codes"/> </referenceReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Medication.package.content"/> <short value="What is in the package?"/> <definition value="A set of components that go to make up the described item."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=CONT]"/> </mapping> </element> <element> <path value="Medication.package.content.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.package.content.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Medication.package.content.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <synonym value="extensions"/> <synonym value="user content"/> <synonym value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Medication.package.content.item"/> <short value="A product in the package"/> <definition value="Identifies one of the items in the package."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Medication"/> </type> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> <element> <path value="Medication.package.content.amount"/> <short value="How many are in the package?"/> <definition value="The amount of the product that is in the package."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> </snapshot> <differential> <element> <path value="Medication"/> <short value="Definition of a Medication"/> <definition value="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."/> <min value="1"/> <max value="1"/> <mapping> <identity value="rim"/> <map value="ManufacturedProduct[classCode=ADMM]"/> </mapping> </element> <element> <path value="Medication.name"/> <short value="Common / Commercial name"/> <definition value="The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> </element> <element> <path value="Medication.code"/> <short value="Codes that identify this medication"/> <definition value="A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes."/> <comments value="When defining a medication, the code is the "identifying" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="MedicationFormalRepresentation"/> <isExtensible value="true"/> <conformance value="example"/> <description value="A code that defines the type of a medication"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-codes"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Medication.isBrand"/> <short value="True if a brand"/> <definition value="Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="true if .player.scopingRole[typeCode=MANU] exists"/> </mapping> </element> <element> <path value="Medication.manufacturer"/> <short value="Manufacturer of the item"/> <definition value="Describes the details of the manufacturer."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.scopingRole[typeCode=MANU].scoper"/> </mapping> </element> <element> <path value="Medication.kind"/> <short value="product | package"/> <definition value="Medications are either a single administrable product or a package that contains one or more products."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="MedicationKind"/> <isExtensible value="false"/> <conformance value="required"/> <description value="Whether the medication is a product or a package"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-kind"/> </referenceReference> </binding> <mapping> <identity value="rim"/> <map value=".player.classCode (CONT or not)"/> </mapping> </element> <element> <path value="Medication.product"/> <short value="Administrable medication details"/> <definition value="Information that only applies to products (not packages)."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player [classCode != CONT]"/> </mapping> </element> <element> <path value="Medication.product.form"/> <short value="powder | tablets | carton +"/> <definition value="Describes the form of the item. Powder; tables; carton."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="MedicationForm"/> <isExtensible value="true"/> <conformance value="example"/> <description value="The form of a medication"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-form-codes"/> </referenceReference> </binding> <mapping> <identity value="v2"/> <map value="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"/> </mapping> <mapping> <identity value="rim"/> <map value=".formCode"/> </mapping> </element> <element> <path value="Medication.product.ingredient"/> <short value="Active or inactive ingredient"/> <definition value="Identifies a particular constituent of interest in the product."/> <comments value="The ingredients need not be a complete list; usually only active ingredients are listed."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=INGR]"/> </mapping> </element> <element> <path value="Medication.product.ingredient.item"/> <short value="The product contained"/> <definition value="The actual ingredient - either a substance (simple ingredient) or another medication."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Substance"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Medication"/> </type> <mapping> <identity value="v2"/> <map value="if substance: 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"/> </mapping> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> <element> <path value="Medication.product.ingredient.amount"/> <short value="How much ingredient in product"/> <definition value="Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <mapping> <identity value="v2"/> <map value="if substance: 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"/> </mapping> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> <element> <path value="Medication.product.batch"/> <short value="Information about a group of medication produced or packaged from one production run."/> <definition value="Information about a group of medication produced or packaged from one production run."/> <min value="0"/> <max value="*"/> </element> <element> <path value="Medication.product.batch.lotNumber"/> <short value="The assigned lot number of a batch of the specified product."/> <definition value="The assigned lot number of a batch of the specified product."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="Medication.product.batch.expirationDate"/> <short value="When this specific batch of product will expire."/> <definition value="When this specific batch of product will expire."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element> <path value="Medication.package"/> <short value="Details about packaged medications"/> <definition value="Information that only applies to packages (not products)."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player[classCode=CONT]"/> </mapping> </element> <element> <path value="Medication.package.container"/> <short value="E.g. box, vial, blister-pack"/> <definition value="The kind of container that this package comes as."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="MedicationContainer"/> <isExtensible value="true"/> <conformance value="example"/> <description value="Kind of container a medication package is packaged in"/> <referenceReference> <reference value="http://hl7.org/fhir/vs/medication-package-form-codes"/> </referenceReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Medication.package.content"/> <short value="What is in the package?"/> <definition value="A set of components that go to make up the described item."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value=".scopesRole[typeCode=CONT]"/> </mapping> </element> <element> <path value="Medication.package.content.item"/> <short value="A product in the package"/> <definition value="Identifies one of the items in the package."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/Profile/Medication"/> </type> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> <element> <path value="Medication.package.content.amount"/> <short value="How many are in the package?"/> <definition value="The amount of the product that is in the package."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> </type> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> </differential> </Profile>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:21+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change